email_plat/email_client_api/inc/memailaddress.h
author hgs
Thu, 30 Sep 2010 11:43:07 +0300
changeset 74 6c59112cfd31
parent 47 email_plat/email_client_api/memailaddress.h@f83bd4ae1fe3
permissions -rw-r--r--
201039
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
47
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description: Email address in Email Client API
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef MEMAILADDRESS_H
hgs
parents:
diff changeset
    19
#define MEMAILADDRESS_H
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
#include <emailapidefs.h>
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
namespace EmailInterface {
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
/**
hgs
parents:
diff changeset
    26
 * Email address that is used as recipient or sender in MEmailMessage and
hgs
parents:
diff changeset
    27
 * mailbox address in MEmailMailbox.
hgs
parents:
diff changeset
    28
 * @since S60 v5.0
hgs
parents:
diff changeset
    29
 */
hgs
parents:
diff changeset
    30
class MEmailAddress : public MEmailInterface
hgs
parents:
diff changeset
    31
{ 
hgs
parents:
diff changeset
    32
public:
hgs
parents:
diff changeset
    33
    /**
hgs
parents:
diff changeset
    34
     * Association role of the address in message/mailbox.
hgs
parents:
diff changeset
    35
     */
hgs
parents:
diff changeset
    36
    enum TRole { 
hgs
parents:
diff changeset
    37
        // role is undefined
hgs
parents:
diff changeset
    38
        EUndefined, 
hgs
parents:
diff changeset
    39
        // reply-to address in a message
hgs
parents:
diff changeset
    40
        EReplyTo, 
hgs
parents:
diff changeset
    41
        // sender of a message
hgs
parents:
diff changeset
    42
        ESender, 
hgs
parents:
diff changeset
    43
        // to-recipient of a message
hgs
parents:
diff changeset
    44
        ETo, 
hgs
parents:
diff changeset
    45
        // cc-recipient of a message
hgs
parents:
diff changeset
    46
        ECc, 
hgs
parents:
diff changeset
    47
        // bcc-recipient of a message
hgs
parents:
diff changeset
    48
        EBcc };
hgs
parents:
diff changeset
    49
    
hgs
parents:
diff changeset
    50
    /**
hgs
parents:
diff changeset
    51
     * Sets email address
hgs
parents:
diff changeset
    52
     * @param email address 
hgs
parents:
diff changeset
    53
     */
hgs
parents:
diff changeset
    54
    virtual void SetAddressL( const TDesC& aAddress ) = 0;
hgs
parents:
diff changeset
    55
    
hgs
parents:
diff changeset
    56
    /**
hgs
parents:
diff changeset
    57
     * Returns email address
hgs
parents:
diff changeset
    58
     * @return email address
hgs
parents:
diff changeset
    59
     */
hgs
parents:
diff changeset
    60
    virtual TPtrC Address() const = 0;
hgs
parents:
diff changeset
    61
    
hgs
parents:
diff changeset
    62
    /**
hgs
parents:
diff changeset
    63
     * Sets display name for the address
hgs
parents:
diff changeset
    64
     * @param display name
hgs
parents:
diff changeset
    65
     */
hgs
parents:
diff changeset
    66
    virtual void SetDisplayNameL( const TDesC& aDisplayName ) = 0;
hgs
parents:
diff changeset
    67
    
hgs
parents:
diff changeset
    68
    /**
hgs
parents:
diff changeset
    69
     * Returns display name for the address
hgs
parents:
diff changeset
    70
     * @return display name
hgs
parents:
diff changeset
    71
     */
hgs
parents:
diff changeset
    72
    virtual TPtrC DisplayName() const = 0;
hgs
parents:
diff changeset
    73
    
hgs
parents:
diff changeset
    74
    /**
hgs
parents:
diff changeset
    75
     * Returns role associated with the address
hgs
parents:
diff changeset
    76
     * @return role
hgs
parents:
diff changeset
    77
     */
hgs
parents:
diff changeset
    78
    virtual TRole Role() const = 0;
hgs
parents:
diff changeset
    79
    
hgs
parents:
diff changeset
    80
    /**
hgs
parents:
diff changeset
    81
     * Sets role
hgs
parents:
diff changeset
    82
     * @param role
hgs
parents:
diff changeset
    83
     */
hgs
parents:
diff changeset
    84
    virtual void SetRole( const TRole aRole ) = 0;
hgs
parents:
diff changeset
    85
};
hgs
parents:
diff changeset
    86
hgs
parents:
diff changeset
    87
typedef RPointerArray<MEmailAddress>    REmailAddressArray;
hgs
parents:
diff changeset
    88
hgs
parents:
diff changeset
    89
} // namespace EmailInterface {
hgs
parents:
diff changeset
    90
hgs
parents:
diff changeset
    91
#endif // MEMAILADDRESS_H