epoc32/include/app/memailmessagedata.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2009 - 2009 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:  Helper classes for interface.
    15 *
    16 */
    17 
    18 #ifndef MEMAILMESSAGEDATA_H
    19 #define MEMAILMESSAGEDATA_H
    20 
    21 // System includes
    22 #include <e32std.h>
    23 
    24 namespace EmailInterface {
    25 
    26 /** Email message priority flag */
    27 enum TEmailPriority
    28     {
    29     ENormal,
    30     ELow,
    31     EHigh
    32     };
    33 
    34 /**
    35  * Container interface for message related info
    36  * Plugin implementor make implementation for this
    37  */
    38 class MMessageData
    39     {
    40 public:
    41     /**
    42      * Accessor for message sender information
    43      * @return sender as descriptor
    44      */
    45     virtual const TDesC& Sender() const = 0;
    46 
    47     /**
    48      * Accessor for message subject information
    49      * @return message subject
    50      */
    51     virtual const TDesC& Subject() const = 0;
    52 
    53     /**
    54      * Accessor for message timestamp information
    55      * @return timestamp
    56      */
    57     virtual TTime TimeStamp() const = 0;
    58 
    59     /**
    60      * Accessor for message read/unread status
    61      * @return boolean
    62      */
    63     virtual TBool Unread() const = 0;
    64 
    65     /**
    66      * Accessor for message priority status
    67      * @return one of message priority values
    68      */
    69     virtual TEmailPriority Priority() const = 0;
    70 
    71     /**
    72      * Accessor for message's attachment status
    73      * @return boolean depending whether message has any attachmants or not
    74      */
    75     virtual TBool Attachments() const = 0;
    76 
    77     /**
    78      * Accessor for info whether this is a calendar message or not
    79      * @return boolean
    80      */
    81     virtual TBool CalendarMsg() const = 0;
    82 
    83     /**
    84      * Accessor for info whether this message has been replied or not
    85      * @return boolean
    86      */
    87     virtual TBool Replied() const = 0;
    88 
    89     /**
    90      * Accessor for info whether this message has been forwarded or not
    91      * @return boolean
    92      */
    93     virtual TBool Forwarded() const = 0;
    94     };
    95 
    96 } // namespace
    97 
    98 #endif // MEMAILMESSAGEDATA_H