class CFSMailMessagePart : public CFSMailMessageBase |
email parts handling class
Protected Member Functions | |
---|---|
CFSMailMessagePart () | |
void | ClearPartsArray ( TBool ) |
void | DoAttachmentListL ( RPointerArray < CFSMailMessagePart > &) |
TFSMailMsgId | FindBodyPartIdL (const TDesC &) |
void | ListMessagePartsL ( RPointerArray < CFSMailMessagePart > &) |
Private Member Functions | |
---|---|
void | ConstructL ( TFSMailMsgId , TFSMailMsgId ) |
Protected Attributes | |
---|---|
HBufC * | iContentType |
RPointerArray < CFSMailMessagePart > | iMessageParts |
TFSPartFetchState | iMessagePartsStatus |
TBool | iReadMessageParts |
Inherited Attributes | |
---|---|
CExtendableEmail::iExtensions | |
CFSMailMessageBase::iMessageId | |
CFSMailMessageBase::iRequestHandler |
IMPORT_C CFSMailMessagePart * | AddNewAttachmentL | ( | const TDesC & | aFilePath, |
const TFSMailMsgId | aInsertBefore, | |||
const TDesC & | aContentType | |||
) |
Adds new attachment to this email (part).
const TDesC & aFilePath | full path of new attachment. |
const TFSMailMsgId aInsertBefore | defines position of new attachment, if NullId then new attachment is created as last part. |
const TDesC & aContentType | attachment content type |
IMPORT_C void | AppendAttachmentsL | ( | RPointerArray < CFSMailMessagePart > & | aParts | ) |
creates a list containing all email / email part subparts
RPointerArray < CFSMailMessagePart > & aParts | email part list given/owned by user |
IMPORT_C CFSMailMessagePart * | ChildPartL | ( | const TFSMailMsgId | aPartId | ) |
Returns child part of this part identified by part id.
const TFSMailMsgId aPartId | defines parent part id |
IMPORT_C void | ChildPartsL | ( | RPointerArray < CFSMailMessagePart > & | aParts | ) |
lists all direct child parts of this email part
RPointerArray < CFSMailMessagePart > & aParts | table containing list of child parts owned by user |
void | ClearPartsArray | ( | TBool | aClearAll | ) | [protected] |
clears internal part array
TBool aClearAll |
void | ConstructL | ( | TFSMailMsgId | aMessageId, |
TFSMailMsgId | aMessagePartId | |||
) | [private] |
Two-phased constructor
TFSMailMsgId aMessageId | |
TFSMailMsgId aMessagePartId |
IMPORT_C const TDesC & | ContentDescription | ( | ) |
Returns email Content-Description value, includes also parameters, if any.
IMPORT_C const TDesC & | ContentDisposition | ( | ) |
Returns email Content-Disposition value, includes also parameters, if any.
IMPORT_C CDesCArray & | ContentDispositionParameters | ( | ) |
Returns email Content-Disposition Parameters and their associated values. Updating/setting values should be done by first getting the array and then modifying it's contents.
IMPORT_C TBool | ContentTypeMatches | ( | const TDesC & | aContentType | ) |
Checks that content type matches given.
const TDesC & aContentType | body part content type to be checked |
IMPORT_C CDesCArray & | ContentTypeParameters | ( | ) |
Returns content-type parameters and their associated values. Updating/setting values should be done by first getting the array and then modifying it's contents.
IMPORT_C void | CopyContentFileL | ( | const TDesC & | aContentLocation | ) |
copies contents of this message part to given file
const TDesC & aContentLocation | defines file location as a) directory, when plugin finds out corresponding file name related to this part id, in this case last character should be '/' b) directory & filename, when both directory and file name are given by user |
IMPORT_C CFSMailMessagePart * | CopyMessageAsChildPartL | ( | TFSMailMsgId | aInsertBefore, |
CFSMailMessage * | aMessage | |||
) |
Copies given email object as new child part of this email part or email.
TFSMailMsgId aInsertBefore | defines place of where new child part is created, if aInsertBefore is NULL id then new part is added as last. |
CFSMailMessage * aMessage | message to be copied as child part |
void | DoAttachmentListL | ( | RPointerArray < CFSMailMessagePart > & | aParts | ) | [protected, 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.
RPointerArray < CFSMailMessagePart > & aParts | contains flat list of attachments |
IMPORT_C TFSPartFetchState | FetchLoadState | ( | ) | const |
returns email part content current fetch state Intended as utility function for UI. If (0 == FetchedContentSize() ) return EFSNone; else if ( FetchedContentSize() < ContentSize() ) then return EFSPartial else return EFSFull
IMPORT_C TInt | FetchMessagePartL | ( | const TFSMailMsgId | aMessagePartId, |
MFSMailRequestObserver & | aOperationObserver, | |||
const TUint | aPreferredByteCount | |||
) |
starts email part fetching from email server
const TFSMailMsgId aMessagePartId | message part id of email part to be fetched |
MFSMailRequestObserver & aOperationObserver | observer to forward fetching progress events to user |
const TUint aPreferredByteCount | indicates how much more content for part(s) user wants to fetch. Default value zero indicates that all content should be fetched. Actual amount of data fetched may differ from requested (possibly all fetched in any case). |
IMPORT_C TInt | FetchMessagesPartsL | ( | const RArray < TFSMailMsgId > & | aMessagePartIds, |
MFSMailRequestObserver & | aOperationObserver, | |||
const TUint | aPreferredByteCount | |||
) |
starts email parts fetching from email server
const RArray < TFSMailMsgId > & aMessagePartIds | message part ids of email parts to be fetched |
MFSMailRequestObserver & aOperationObserver | observer to forward fetching progress events to user |
const TUint aPreferredByteCount | indicates how much more content for part(s) user wants to fetch. Default value zero indicates that all content should be fetched. Actual amount of data fetched may differ from requested (possibly all fetched in any case). |
IMPORT_C TUint | FetchedContentSize | ( | ) | const |
returns email part currently fetched (local) content size (in bytes).
TFSMailMsgId | FindBodyPartIdL | ( | const TDesC & | aContentType | ) | [protected] |
finds id of body part
const TDesC & aContentType |
IMPORT_C CFSMailMessagePart * | FindBodyPartL | ( | const TDesC & | aContentType | ) |
finds email body part based on given content type (plain text or html body part of email message)
const TDesC & aContentType | body part content type to be searched |
IMPORT_C RFile | GetContentFileL | ( | ) |
Retrieves a read-only file handle for the content file of this message part. The caller must close the file handle.
IMPORT_C void | GetContentToBufferL | ( | TDes16 & | aBuffer, |
TUint | aStartOffset | |||
) |
copies email part contents to buffer given by user
IMPORT_C const TDesC & | GetContentType | ( | ) |
email part content-type accessor (e.g. "text/plain")
IMPORT_C MMRInfoObject & | GetMRInfo | ( | ) |
meeting request accessor if email part is a meeting request
IMPORT_C TBool | IsMessageL | ( | ) | const [virtual] |
Returns ETrue if this email part is actually an email, so it's safe to cast this part to CFSMailMessage
void | ListMessagePartsL | ( | RPointerArray < CFSMailMessagePart > & | aParts | ) | [protected] |
lists subparts
RPointerArray < CFSMailMessagePart > & aParts |
IMPORT_C CFSMailMessagePart * | NewChildPartL | ( | const TFSMailMsgId | aInsertBefore, |
const TDesC & | aContentType | |||
) |
Creates and adds a new child part to this email part
const TFSMailMsgId aInsertBefore | defines place where new child part is created, if aInsertBefore is NULL id then new part is added as last. |
const TDesC & aContentType | content type of the new child part |
IMPORT_C CFSMailMessagePart * | NewL | ( | TFSMailMsgId | aMessageId, |
TFSMailMsgId | aMessagePartId | |||
) | [static] |
Two-phased constructor.
TFSMailMsgId aMessageId | message id in plugin containing email |
TFSMailMsgId aMessagePartId | message part id in plugin containing email |
IMPORT_C CFSMailMessagePart * | NewLC | ( | TFSMailMsgId | aMessageId, |
TFSMailMsgId | aMessagePartId | |||
) | [static] |
Two-phased constructor.
TFSMailMsgId aMessageId | message id in plugin containing email |
TFSMailMsgId aMessagePartId | message part id in plugin containing email |
IMPORT_C TUint | ReadOnlyPartSize | ( | ) | const |
read only part size accessor (character or byte count)
IMPORT_C void | RemoveChildPartL | ( | TFSMailMsgId | aPartId | ) |
Removes child part (and it's children, if any) from this email part
TFSMailMsgId aPartId | part id of the email part to be removed |
IMPORT_C void | RemoveContentL | ( | ) |
Removes from message store fetched contents of this part and possible child parts
IMPORT_C void | RemoveDownLoadedAttachmentsL | ( | ) |
removes attachment downloaded contents from local/terminal memory
IMPORT_C void | SetAttachmentNameL | ( | const TDesC & | aFilePath | ) |
Sets attachment name for email part. Full path can be given as input even though only filename is saved.
const TDesC & aFilePath | attachment name |
IMPORT_C void | SetContent | ( | TDes16 & | aBuffer | ) |
copies email part contents from buffer given by user
TDes16 & aBuffer | buffer given by user |
IMPORT_C void | SetContentClass | ( | const TDesC & | aContentClass | ) |
email Content-Class mutator
const TDesC & aContentClass | new email Content-Class value |
IMPORT_C void | SetContentDescription | ( | const TDesC & | aContentDesctiption | ) |
Stores email Content-Description value, parameters can be included, if any.
const TDesC & aContentDesctiption |
IMPORT_C void | SetContentDisposition | ( | const TDesC & | aContentDesctiption | ) |
Stores email Content-Disposition value, parameters can be included, if any.
const TDesC & aContentDesctiption |
IMPORT_C void | SetContentFromFileL | ( | const TDesC & | aFilePath | ) |
Sets email part contents from given file, possible old contents are replaced.
const TDesC & aFilePath | defines the target file |
IMPORT_C void | SetContentIDL | ( | const TDesC & | aContentID | ) |
email Content-Id mutator
const TDesC & aContentID | new email Content-Id value |
IMPORT_C void | SetContentSize | ( | const TUint | aContentSize | ) |
Sets email part full content size (in bytes)
const TUint aContentSize | content size to be set |
IMPORT_C void | SetContentType | ( | const TDesC & | aContentType | ) |
email part content-type mutator
const TDesC & aContentType | new content type value |
IMPORT_C void | SetFetchedContentSize | ( | TUint | aContentSize | ) |
Sets email part currently fetched (local) content size (in bytes).
TUint aContentSize | content size to be set |
IMPORT_C void | SetMRInfo | ( | MMRInfoObject * | aMeetingRequest | ) |
stores given meeting request object as email part
MMRInfoObject * aMeetingRequest | meeting request object |
IMPORT_C void | SetMessagePartsStatus | ( | TFSPartFetchState | aMessagePartStatus | ) |
sets email part fetch status
TFSPartFetchState aMessagePartStatus | (EFSMessagePartsKnown) |
IMPORT_C void | SetReadOnlyPartSize | ( | const TUint | aReadOnlyPartSize | ) |
read only part size mutator
const TUint aReadOnlyPartSize | read only size to be set (character or byte count) |
CDesCArray * | iContentDispositionParams | [private] |
content disposition parameters
RPointerArray < CFSMailMessagePart > | iMessageParts | [protected] |
message parts array
TFSPartFetchState | iMessagePartsStatus | [protected] |
email fetch from email server status
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.