Symbian^3 Product Developer Library >

CFSMailMessageBase Class Reference

class CFSMailMessageBase : public CExtendableEmail

email handling base class

FSFWCommonLib

Inherits from

Public Member Functions
~CFSMailMessageBase()
IMPORT_C voidAppendBCCRecipient(CFSMailAddress *)
IMPORT_C voidAppendCCRecipient(CFSMailAddress *)
IMPORT_C voidAppendToRecipient(CFSMailAddress *)
IMPORT_C voidClearBccRecipients()
IMPORT_C voidClearCcRecipients()
IMPORT_C voidClearToRecipients()
IMPORT_C CEmailExtension *ExtensionL(const TUid &)
IMPORT_C RPointerArray< CFSMailAddress > &GetBCCRecipients()
IMPORT_C RPointerArray< CFSMailAddress > &GetCCRecipients()
IMPORT_C TTimeGetDate()
IMPORT_C TIntGetFlags()
IMPORT_C TFSMailMsgIdGetFolderId()
IMPORT_C TFSMailMsgIdGetMailBoxId()
IMPORT_C TFSMailMsgIdGetMessageId()
IMPORT_C const CFSMailAddress &GetReplyToAddress()
IMPORT_C CFSMailAddress *GetSender()
IMPORT_C TDesC &GetSubject()
IMPORT_C RPointerArray< CFSMailAddress > &GetToRecipients()
IMPORT_C TBoolIsFlagSet(const TInt)
IMPORT_C TFSMailMsgIdIsRelatedTo()
IMPORT_C CFSMailMessageBase *NewL(const TFSMailMsgId)
IMPORT_C CFSMailMessageBase *NewLC(const TFSMailMsgId)
IMPORT_C voidReleaseExtension(CEmailExtension *)
IMPORT_C CFSMailRequestHandler &RequestHandler()
IMPORT_C voidResetFlag(const TInt)
IMPORT_C voidSetDate(const TTime)
IMPORT_C voidSetFlag(const TInt)
IMPORT_C voidSetFolderId(const TFSMailMsgId)
IMPORT_C voidSetMailBoxId(const TFSMailMsgId)
IMPORT_C voidSetRelatedTo(const TFSMailMsgId)
IMPORT_C voidSetReplyToAddress(CFSMailAddress *)
IMPORT_C voidSetSender(CFSMailAddress *)
IMPORT_C voidSetSubject(const TDesC &)
Protected Member Functions
CFSMailMessageBase()
Private Member Functions
voidConstructL(const TFSMailMsgId)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Protected Attributes
TFSMailMsgId iMessageId
CFSMailRequestHandler *iRequestHandler
Private Attributes
RPointerArray< CFSMailAddress >iBccRecipients
RPointerArray< CFSMailAddress >iCcRecipients
TTime iDate
TInt iFlags
TFSMailMsgId iFolderId
TFSMailMsgId iMailBoxId
TFSMailMsgId iRelatedTo
CFSMailAddress *iReplyTo
CFSMailAddress *iSender
HBufC *iSubject
RPointerArray< CFSMailAddress >iToRecipients
Inherited Attributes
CExtendableEmail::iExtensions

Constructor & Destructor Documentation

CFSMailMessageBase()

CFSMailMessageBase()[protected]

C++ default constructor.

~CFSMailMessageBase()

IMPORT_C~CFSMailMessageBase()[virtual]

Destructor.

Member Functions Documentation

AppendBCCRecipient(CFSMailAddress *)

IMPORT_C voidAppendBCCRecipient(CFSMailAddress *aRecipient)

appends one recipient to email BCC field, ownership transferred from user

Parameters

CFSMailAddress * aRecipientnew recipient email address

AppendCCRecipient(CFSMailAddress *)

IMPORT_C voidAppendCCRecipient(CFSMailAddress *aRecipient)

appends one recipient to email CC-field, ownership transferred from user

Parameters

CFSMailAddress * aRecipientnew recipient email address

AppendToRecipient(CFSMailAddress *)

IMPORT_C voidAppendToRecipient(CFSMailAddress *aRecipient)

appends one recipient to email TO-field, ownership transferred from user

Parameters

CFSMailAddress * aRecipientnew recipient email address

ClearBccRecipients()

IMPORT_C voidClearBccRecipients()

clears email BCC-recipients list

ClearCcRecipients()

IMPORT_C voidClearCcRecipients()

clears email CC-recipients list

ClearToRecipients()

IMPORT_C voidClearToRecipients()

clears email TO-recipients list

ConstructL(const TFSMailMsgId)

voidConstructL(const TFSMailMsgIdaMessageId)[private]

ConstructL

Parameters

const TFSMailMsgId aMessageId

ExtensionL(const TUid &)

IMPORT_C CEmailExtension *ExtensionL(const TUid &aInterfaceUid)[virtual]

Returns extension by uid, leaves KErrNotSupported if extension is not available.

Parameters

const TUid & aInterfaceUidextension interface uid

GetBCCRecipients()

IMPORT_C RPointerArray< CFSMailAddress > &GetBCCRecipients()

returns BCC-recipients list of email

GetCCRecipients()

IMPORT_C RPointerArray< CFSMailAddress > &GetCCRecipients()

returns CC-recipients list of email

GetDate()

IMPORT_C TTimeGetDate()const

email date accessor

GetFlags()

IMPORT_C TIntGetFlags()const

email flags accessor

GetFolderId()

IMPORT_C TFSMailMsgIdGetFolderId()const

email parent folder id accessor

GetMailBoxId()

IMPORT_C TFSMailMsgIdGetMailBoxId()const

email mailbox id accessor

GetMessageId()

IMPORT_C TFSMailMsgIdGetMessageId()const

message id accessor

GetReplyToAddress()

IMPORT_C const CFSMailAddress &GetReplyToAddress()

Email reply-to address accessor ; defines optional email address that clients should use to send replies. Returns NULL pointer if address is not set, ownership not transferred to user.

GetSender()

IMPORT_C CFSMailAddress *GetSender()const

email sender address accessor

GetSubject()

IMPORT_C TDesC &GetSubject()const

email subject accessor

GetToRecipients()

IMPORT_C RPointerArray< CFSMailAddress > &GetToRecipients()

returns TO-recipients list of email

IsFlagSet(const TInt)

IMPORT_C TBoolIsFlagSet(const TIntaFlag)const

test email flag is set

email flag to be tested

Parameters

const TInt aFlag

IsRelatedTo()

IMPORT_C TFSMailMsgIdIsRelatedTo()const

if email is related to another email, for example due reply / forward, related email id is returned

NewL(const TFSMailMsgId)

IMPORT_C CFSMailMessageBase *NewL(const TFSMailMsgIdaMessageId)[static]

Two-phased constructor.

Parameters

const TFSMailMsgId aMessageIdid of the email to be created

NewLC(const TFSMailMsgId)

IMPORT_C CFSMailMessageBase *NewLC(const TFSMailMsgIdaMessageId)[static]

Two-phased constructor.

Parameters

const TFSMailMsgId aMessageIdid of the email to be created

ReleaseExtension(CEmailExtension *)

IMPORT_C voidReleaseExtension(CEmailExtension *aExtension)[virtual]

CExtendableEmail::ReleaseExtension

Parameters

CEmailExtension * aExtension

RequestHandler()

IMPORT_C CFSMailRequestHandler &RequestHandler()

plugin request handler accessor

ResetFlag(const TInt)

IMPORT_C voidResetFlag(const TIntaFlag)

email flag reset

email flag to be reset

Parameters

const TInt aFlag

SetDate(const TTime)

IMPORT_C voidSetDate(const TTimeaDate)

email date mutator

Parameters

const TTime aDatenew email date

SetFlag(const TInt)

IMPORT_C voidSetFlag(const TIntaFlag)

email flag set

email flag to be set

Parameters

const TInt aFlag

SetFolderId(const TFSMailMsgId)

IMPORT_C voidSetFolderId(const TFSMailMsgIdaFolderId)

email parent folder id mutator

Parameters

const TFSMailMsgId aFolderIdparent folder id

SetMailBoxId(const TFSMailMsgId)

IMPORT_C voidSetMailBoxId(const TFSMailMsgIdaMailBoxId)

email mailbox id mutator

Parameters

const TFSMailMsgId aMailBoxIdmailbox id

SetRelatedTo(const TFSMailMsgId)

IMPORT_C voidSetRelatedTo(const TFSMailMsgIdaMessageId)

set email related to another email, for example due reply / forward

Parameters

const TFSMailMsgId aMessageIdrelated email id

SetReplyToAddress(CFSMailAddress *)

IMPORT_C voidSetReplyToAddress(CFSMailAddress *aReplyToAddress)

email reply-to address mutator, ownership transferred from user

Parameters

CFSMailAddress * aReplyToAddressemail reply-to address

SetSender(CFSMailAddress *)

IMPORT_C voidSetSender(CFSMailAddress *aSender)

email sender address mutator

Parameters

CFSMailAddress * aSenderemail sender address, ownership transferred from user

SetSubject(const TDesC &)

IMPORT_C voidSetSubject(const TDesC &aSubject)

email subject mutator

Parameters

const TDesC & aSubjectnew email subject

Member Data Documentation

RPointerArray< CFSMailAddress > iBccRecipients

RPointerArray< CFSMailAddress >iBccRecipients[private]

RPointerArray< CFSMailAddress > iCcRecipients

RPointerArray< CFSMailAddress >iCcRecipients[private]

TTime iDate

TTime iDate[private]

email date

TInt iFlags

TInt iFlags[private]

email flags

TFSMailMsgId iFolderId

TFSMailMsgId iFolderId[private]

email parent folder id

TFSMailMsgId iMailBoxId

TFSMailMsgId iMailBoxId[private]

email mailbox id

TFSMailMsgId iMessageId

TFSMailMsgId iMessageId[protected]

email message id

TFSMailMsgId iRelatedTo

TFSMailMsgId iRelatedTo[private]

id of another email or part this object is related to due some reason, like in reply or forward email use cases

CFSMailAddress * iReplyTo

CFSMailAddress *iReplyTo[private]

email reply-to address

CFSMailRequestHandler * iRequestHandler

CFSMailRequestHandler *iRequestHandler[protected]

CFSMailAddress * iSender

CFSMailAddress *iSender[private]

email sender address

HBufC * iSubject

HBufC *iSubject[private]

email subject

RPointerArray< CFSMailAddress > iToRecipients

RPointerArray< CFSMailAddress >iToRecipients[private]

email recipients, to/cc/bcc

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.