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