Collapse all Symbian^3 Application Developer Library

CFSMailMessage Class Reference

class CFSMailMessage : public CFSMailMessagePart

email data handling

FSFWCommonLib

Since: S60 v3.1

Inherits from

CFSMailMessage
- CFSMailMessagePart
  - CFSMailMessageBase
    - CExtendableEmail
      - CBase

Public Member Functions
	~CFSMailMessage ()
IMPORT_C CFSMailMessagePart *	AddNewAttachmentL (const TDesC &, const TFSMailMsgId )
IMPORT_C CFSMailMessagePart *	AddNewAttachmentL ( RFile &, const TDesC8 &)
IMPORT_C void	AttachmentListL ( RPointerArray < CFSMailMessagePart > &)
void	DoAttachmentListL ( RPointerArray < CFSMailMessagePart > &)
IMPORT_C CFSMailMessagePart *	HtmlBodyPartL ()
IMPORT_C TBool	IsMessageL ()
IMPORT_C CFSMailMessage *	NewL ( TFSMailMsgId )
IMPORT_C CFSMailMessage *	NewLC ( TFSMailMsgId )
IMPORT_C CFSMailMessagePart *	PlainTextBodyPartL ()
IMPORT_C void	SaveMessageL ()

Private Member Functions
	CFSMailMessage ()
void	ConstructL ( TFSMailMsgId )
CDesCArray &	ContentTypeParameters ()

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()
	CFSMailMessageBase::AppendBCCRecipient(CFSMailAddress *)
	CFSMailMessageBase::AppendCCRecipient(CFSMailAddress *)
	CFSMailMessageBase::AppendToRecipient(CFSMailAddress *)
	CFSMailMessageBase::CFSMailMessageBase()
	CFSMailMessageBase::ClearBccRecipients()
	CFSMailMessageBase::ClearCcRecipients()
	CFSMailMessageBase::ClearToRecipients()
	CFSMailMessageBase::ExtensionL(const TUid &)
	CFSMailMessageBase::GetBCCRecipients()
	CFSMailMessageBase::GetCCRecipients()
	CFSMailMessageBase::GetDate()const
	CFSMailMessageBase::GetFlags()const
	CFSMailMessageBase::GetFolderId()const
	CFSMailMessageBase::GetMailBoxId()const
	CFSMailMessageBase::GetMessageId()const
	CFSMailMessageBase::GetReplyToAddress()
	CFSMailMessageBase::GetSender()const
	CFSMailMessageBase::GetSubject()const
	CFSMailMessageBase::GetToRecipients()
	CFSMailMessageBase::IsFlagSet(const TInt)const
	CFSMailMessageBase::IsRelatedTo()const
	CFSMailMessageBase::ReleaseExtension(CEmailExtension *)
	CFSMailMessageBase::RequestHandler()
	CFSMailMessageBase::ResetFlag(const TInt)
	CFSMailMessageBase::SetDate(const TTime)
	CFSMailMessageBase::SetFlag(const TInt)
	CFSMailMessageBase::SetFolderId(const TFSMailMsgId)
	CFSMailMessageBase::SetMailBoxId(const TFSMailMsgId)
	CFSMailMessageBase::SetRelatedTo(const TFSMailMsgId)
	CFSMailMessageBase::SetReplyToAddress(CFSMailAddress *)
	CFSMailMessageBase::SetSender(CFSMailAddress *)
	CFSMailMessageBase::SetSubject(const TDesC &)
	CFSMailMessageBase::~CFSMailMessageBase()
	CFSMailMessagePart::AddNewAttachmentL(const TDesC &,const TFSMailMsgId,const TDesC &)
	CFSMailMessagePart::AppendAttachmentsL(RPointerArray< CFSMailMessagePart > &)
	CFSMailMessagePart::AttachmentNameL()
	CFSMailMessagePart::CFSMailMessagePart()
	CFSMailMessagePart::ChildPartL(const TFSMailMsgId)
	CFSMailMessagePart::ChildPartsL(RPointerArray< CFSMailMessagePart > &)
	CFSMailMessagePart::ClearPartsArray(TBool)
	CFSMailMessagePart::ContentDescription()
	CFSMailMessagePart::ContentDisposition()
	CFSMailMessagePart::ContentDispositionParameters()
	CFSMailMessagePart::ContentID()
	CFSMailMessagePart::ContentSize()const
	CFSMailMessagePart::ContentTypeMatches(const TDesC &)
	CFSMailMessagePart::CopyContentFileL(const TDesC &)
	CFSMailMessagePart::CopyMessageAsChildPartL(TFSMailMsgId,CFSMailMessage *)
	CFSMailMessagePart::FetchLoadState()const
	CFSMailMessagePart::FetchMessagePartL(const TFSMailMsgId,MFSMailRequestObserver &,const TUint)
	CFSMailMessagePart::FetchMessagesPartsL(const RArray< TFSMailMsgId > &,MFSMailRequestObserver &,const TUint)
	CFSMailMessagePart::FetchedContentSize()const
	CFSMailMessagePart::FindBodyPartIdL(const TDesC &)
	CFSMailMessagePart::FindBodyPartL(const TDesC &)
	CFSMailMessagePart::GetContentClass()
	CFSMailMessagePart::GetContentFileL()
	CFSMailMessagePart::GetContentToBufferL(TDes16 &,TUint)
	CFSMailMessagePart::GetContentType()
	CFSMailMessagePart::GetMRInfo()
	CFSMailMessagePart::GetPartId()const
	CFSMailMessagePart::IsMRInfoSet()
	CFSMailMessagePart::ListMessagePartsL(RPointerArray< CFSMailMessagePart > &)
	CFSMailMessagePart::NewChildPartL(const TFSMailMsgId,const TDesC &)
	CFSMailMessagePart::NewL(TFSMailMsgId,TFSMailMsgId)
	CFSMailMessagePart::NewLC(TFSMailMsgId,TFSMailMsgId)
	CFSMailMessagePart::ReadOnlyPartSize()const
	CFSMailMessagePart::RemoveChildPartL(TFSMailMsgId)
	CFSMailMessagePart::RemoveContentL()
	CFSMailMessagePart::RemoveDownLoadedAttachmentsL()
	CFSMailMessagePart::SaveL()
	CFSMailMessagePart::SetAttachmentNameL(const TDesC &)
	CFSMailMessagePart::SetContent(TDes16 &)
	CFSMailMessagePart::SetContentClass(const TDesC &)
	CFSMailMessagePart::SetContentDescription(const TDesC &)
	CFSMailMessagePart::SetContentDisposition(const TDesC &)
	CFSMailMessagePart::SetContentFromFileL(const TDesC &)
	CFSMailMessagePart::SetContentIDL(const TDesC &)
	CFSMailMessagePart::SetContentSize(const TUint)
	CFSMailMessagePart::SetContentType(const TDesC &)
	CFSMailMessagePart::SetFetchedContentSize(TUint)
	CFSMailMessagePart::SetMRInfo(MMRInfoObject *)
	CFSMailMessagePart::SetMessagePartsStatus(TFSPartFetchState)
	CFSMailMessagePart::SetReadOnlyPartSize(const TUint)
	CFSMailMessagePart::~CFSMailMessagePart()

Inherited Attributes
	CExtendableEmail::iExtensions
	CFSMailMessageBase::iMessageId
	CFSMailMessageBase::iRequestHandler
	CFSMailMessagePart::iContentType
	CFSMailMessagePart::iMessageParts
	CFSMailMessagePart::iMessagePartsStatus
	CFSMailMessagePart::iReadMessageParts

Constructor & Destructor Documentation

CFSMailMessage()

CFSMailMessage

(

)

[private]

C++ default constructor.

~CFSMailMessage()

IMPORT_C

~CFSMailMessage

(

)

destructor

Member Functions Documentation

AddNewAttachmentL(const TDesC &, const TFSMailMsgId)

IMPORT_C CFSMailMessagePart *	AddNewAttachmentL	(	const TDesC &	aFilePath,
			const TFSMailMsgId	aInsertBefore
		)

Adds new attachment to this email.

Parameters

const TDesC & aFilePath	contains full path to new attachment file.
const TFSMailMsgId aInsertBefore	specifies position where new attachment is created. If NullId then new attachment is created as last.

AddNewAttachmentL(RFile &, const TDesC8 &)

IMPORT_C CFSMailMessagePart *	AddNewAttachmentL	(	RFile &	aFile,
			const TDesC8 &	aMimeType
		)

Adds new attachment to this email.

Parameters

RFile & aFile	contains access to new attachment file.
const TDesC8 & aMimeType	user can give content type of the new part, otherwise content type is tried to recognized by method

AttachmentListL(RPointerArray< CFSMailMessagePart > &)

IMPORT_C void

AttachmentListL

(

RPointerArray < CFSMailMessagePart > &

aParts

)

Returns a flat list of message parts that can be handled as attachments. Excludes message parts that are multipart and parts that are considered plain text or html body.

Parameters

RPointerArray < CFSMailMessagePart > & aParts

contains flat list of attachments

ConstructL(TFSMailMsgId)

void

ConstructL

(

TFSMailMsgId

aMessageId

)

[private]

Two-phased constructor

Parameters

TFSMailMsgId aMessageId

ContentTypeParameters()

CDesCArray &

ContentTypeParameters

(

)

[private]

Returns content-type parameters and their associated values. This function is made private to prevent usage from CFSMailMessage

DoAttachmentListL(RPointerArray< CFSMailMessagePart > &)

void

DoAttachmentListL

(

RPointerArray < CFSMailMessagePart > &

aParts

)

[virtual]

Returns a flat list of message parts that can be handled as attachments. Excludes message parts that are multipart and parts that are considered plain text or html body.

Parameters

RPointerArray < CFSMailMessagePart > & aParts

contains flat list of attachments

HtmlBodyPartL()

IMPORT_C CFSMailMessagePart *

HtmlBodyPartL

(

)

Returns html body part for this message or NULL if not found.

IsMessageL()

IMPORT_C TBool

IsMessageL

(

)

const [virtual]

Returns ETrue if this part is actually a message. In that case it shoud safe to cast this part to CFSMailMessage

NewL(TFSMailMsgId)

IMPORT_C CFSMailMessage *

NewL

(

TFSMailMsgId

aMessageId

)

[static]

Two-phased constructor.

Parameters

TFSMailMsgId aMessageId

message id in plugin containing email

NewLC(TFSMailMsgId)

IMPORT_C CFSMailMessage *

NewLC

(

TFSMailMsgId

aMessageId

)

[static]

Two-phased constructor.

Parameters

TFSMailMsgId aMessageId

message id in plugin containing email

PlainTextBodyPartL()

IMPORT_C CFSMailMessagePart *

PlainTextBodyPartL

(

)

Returns plain text body part for this email or NULL if not found.

SaveMessageL()

IMPORT_C void

SaveMessageL

(

)

saves this message