CImEmailMessage Class Reference

Asynchronously retrieves the body text for a specified message. If the email's character set has been overridden by a prior call to SetCharacterSetL(), the body text is decoded with the new character set before it is inserted into the rich text object. A list containing the entry Ids for each body text part within the specified message is created during this call. The list can be retrieved after this call has completed by calling Selection().

Retrieves the body text for a specified message. If the email's character set has been overridden by a prior call to SetCharacterSetL(), the body text is decoded with the new character set before it is inserted into the rich text object. A list containing the entry Ids for each body text part within the specified message is created during this call. The list can be retrieved by calling Selection().

Returns the character set Id that the body text will be decoded in when it is returned in the call to GetBodyTextL(). It also indicates whether the original character set has been overridden by calling SetCharacterSetL().

Asynchronously populates a list of embedded message entries contained within the specified message. Note that any embedded messages within embedded messages are not included in the list. Call Selection() to get the results of the search after it has completed.

Gets the results from FindUniversalResourceIdentifierFileHandleL() or FindFirstHTMLPageFileHandleL() method calls when they have completed.

Used when retrieving specific parts of an MHTML message, such as inline images that are referenced as MHTML anchors within the HTML part of a message. Refer to RFC 2557 - "MIME Encapsulation of Aggregate Documents, such as HTML (MHTML)" for information about MHTML email messages.

Gets the results from FindUniversalResourceIdentifierL() or FindFirstHTMLPageL() method calls when they have completed.

Used when retrieving specific parts of an MHTML message, such as inline images that are referenced as MHTML anchors within the HTML part of a message. Refer to RFC 2557 - "MIME Encapsulation of Aggregate Documents, such as HTML (MHTML)" for information about MHTML email messages.

Allocates and creates a new CImEmailMessage object.

See also: CMsvEntry

Allocates and creates a new CImEmailMessage object, leaving the object on the cleanup stack.

See also: CMsvEntry

This returns a object of CImPlainBodyText.This needs to be called when bodytext needs to be restored in chunks for Read operation.

This returns a object of CImPlainBodyText.This needs to be called when bodytext needs to be created in chunks.

Returns a message entry Id as a type-safe package buffer (TPckg<TMsvId>). The meaning of the Id depends on the request as follows:

AddAttachmentL(), AddMessageAsAttachmentL(), and AddRelatedPartL(): While the attachment, message, or related part is being added, a null Id (KMsvNullIndexEntryId); Once the attachment, message, or related part has been added, the entry Id of the newly created attachment, message, or related part.

DeleteAttachmentL() and DeleteAttachedMessageL(): While the attachment or attached message is being removed, a null Id (KMsvNullIndexEntryId); Once the attachment or attached message has been removed, the Id of the message from which the attachment or attached message was removed.

StoreBodyTextL(): While the body text is being stored, a null Id (KMsvNullIndexEntryId); Once the text has been stored, the Id of the message for which the body text was stored.

// Example code demonstrating how to retrieve the progress.

// Create and initialise a temporary TPckg object that can hold a message Id.
TMsvId msgId;
TPckg<TMsvId> param(msgId);

// Copy the message Id returned from the ProgressL() call into the
// temporary TPckg object.
param.Copy(emailMsg->ProgressL());  // where emailMsg is of type CImEmailMessage.

// Check the value of the returned message Id in the TPckg object.
if (msgId != KMsvNullIndexEntryId)
	{
	// More code...
	}