CImEmailOperation Class Reference

#include <mw/miutmsg.h>

class CImEmailOperation
Public Member Functions
~CImEmailOperation()
CImEmailOperation *CreateCopyL(TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid)
IMPORT_C CImEmailOperation *CreateForwardAsAttachmentL(TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid)
IMPORT_C CImEmailOperation *CreateForwardAsAttachmentL(TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt)
IMPORT_C CImEmailOperation *CreateForwardL(TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TDesC &, const TMsvEmailTypeList &, TUid)
IMPORT_C CImEmailOperation *CreateForwardL(TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid)
IMPORT_C CImEmailOperation *CreateForwardL(TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt)
IMPORT_C CImEmailOperation *CreateForwardL(TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt, TBool)
IMPORT_C CImEmailOperation *CreateNewL(TRequestStatus &, CMsvSession &, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid)
IMPORT_C CImEmailOperation *CreateNewL(TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt)
IMPORT_C CImEmailOperation *CreateNewL(TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt, TBool)
IMPORT_C CImEmailOperation *CreateReceiptL(TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TDesC &, const TMsvEmailTypeList &, TUid)
IMPORT_C CImEmailOperation *CreateReceiptL(TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid)
IMPORT_C CImEmailOperation *CreateReceiptL(TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt)
IMPORT_C CImEmailOperation *CreateReceiptL(TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt, TBool)
IMPORT_C CImEmailOperation *CreateReplyL(TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TDesC &, const TMsvEmailTypeList &, TUid)
IMPORT_C CImEmailOperation *CreateReplyL(TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid)
IMPORT_C CImEmailOperation *CreateReplyL(TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt)
IMPORT_C CImEmailOperation *CreateReplyL(TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt, TBool)
voidDoCancel()
IMPORT_C const TDesC8 &FinalProgress()
const TDesC8 &ProgressL()
voidRunL()

Detailed Description

Provides simple email messages creation functions, including creation of new messages, replies, forwarded messages, and receipts.

Both plain-text and HTML messages, with or without attachments, can be created.

Constructor & Destructor Documentation

~CImEmailOperation ( )

IMPORT_C~CImEmailOperation()

Destructor.

Member Function Documentation

CreateCopyL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid )

CImEmailOperation *CreateCopyL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaMessageId,
TMsvIdaDestination,
TMsvPartListaPartList,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType
)[static]

CreateForwardAsAttachmentL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid )

IMPORT_C CImEmailOperation *CreateForwardAsAttachmentL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaMessageId,
TMsvIdaDestination,
TMsvPartListaPartList,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType
)[static]

Creates a forwarded email message.

Parameters
aObserverRequestStatusAsynchronous status word to complete when the operation completes
aMsvSessionMessage server session to use
aMessageIdThe Id of the message to forward
aDestinationThe Id of the folder where the new message is to be created
aPartListThe body parts that are required in the new message. If a message with body text and attachments is required, then the KMsvMessagePartBody and KMsvMessagePartAttachments parts have to be set.
aMsvEmailTypeListCreation flags. This can be 0, or a bitmask of KMsvEmailTypeListMHTMLMessage, KMsvEmailTypeListInvisibleMessage, and KMsvEmailTypeListMessageInPreparation. If KMsvEmailTypeListMHTMLMessage is not set, a plain-text message is created.
aMsgTypeThe type of message to create e.g. KUidMsgTypeSMTP.
Return Value
Operation object by which to control the operation

CreateForwardAsAttachmentL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt )

IMPORT_C CImEmailOperation *CreateForwardAsAttachmentL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaMessageId,
TMsvIdaSmtpServiceId,
TMsvIdaDestination,
TMsvPartListaPartList,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType,
TIntaPriority = EPriorityStandard
)[static]

Creates a forwarded email message, specifying the message priority and SMTP service with which to send the message.

Parameters
aObserverRequestStatusAsynchronous status word to complete when the operation completes
aMsvSessionMessage server session to use
aMessageIdThe Id of the message to forward
aSmtpServiceIdThe Id of the SMTP service with which to send the new message
aDestinationThe Id of the folder where the new message is to be created
aPartListThe body parts that are required in the new message. If a message with body text and attachments is required, then the KMsvMessagePartBody and KMsvMessagePartAttachments parts have to be set.
aMsvEmailTypeListCreation flags. This can be 0, or a bitmask of KMsvEmailTypeListMHTMLMessage, KMsvEmailTypeListInvisibleMessage, and KMsvEmailTypeListMessageInPreparation. If KMsvEmailTypeListMHTMLMessage is not set, a plain-text message is created.
aMsgTypeThe type of message to create e.g. KUidMsgTypeSMTP.
aPriorityThe priority setting for the email
Return Value
Operation object by which to control the operation

CreateForwardL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TDesC &, const TMsvEmailTypeList &, TUid )

IMPORT_C CImEmailOperation *CreateForwardL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaMessageId,
TMsvIdaDestination,
TMsvPartListaPartList,
const TDesC &aFormatString,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType
)[static]

Creates a forwarded email message, overriding the default subject format string.

The aFormatString parameter allows you to override the default string used in the subject field of the new message (the default is the localised string STRING_forward_formatting_string1 defined in the source file imcm.rls).

Note that if you forward an HTML message that does not contain a text/plain alternative to the HTML, then the HTML part is copied as an attachment (still an HTML entry) into the new message even if aPartList does not specify KMsvMessagePartAttachments. This occurs because there is no other way of reading the original message unless the user switches between the editor/viewer and the application.

Parameters
aObserverRequestStatusAsynchronous status word to complete when the operation completes
aMsvSessionMessage server session to use
aMessageIdThe Id of the message to forward
aDestinationThe Id of the folder where the new message is to be created
aPartListThe body parts that are required in the new message. If a message with body text and attachments is required, then the KMsvMessagePartBody and KMsvMessagePartAttachments parts have to be set.
aFormatStringA string to be inserted into the subject field in the header before the subject, e.g. "Fwd: %S", sets the field to be "Fwd: " followed by the original subject text
aMsvEmailTypeListCreation flags. This can be 0, or a bitmask of KMsvEmailTypeListMHTMLMessage, KMsvEmailTypeListInvisibleMessage, and KMsvEmailTypeListMessageInPreparation. If KMsvEmailTypeListMHTMLMessage is not set, a plain-text message is created.
aMsgTypeThe type of message to create e.g. KUidMsgTypeSMTP.
Return Value
Operation object by which to control the operation

CreateForwardL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid )

IMPORT_C CImEmailOperation *CreateForwardL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaMessageId,
TMsvIdaDestination,
TMsvPartListaPartList,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType
)[static]

Creates a forwarded email message.

For details of how forwarding HTML messages is handled, see the description above for the first overload of this function.

Parameters
aObserverRequestStatusAsynchronous status word to complete when the operation completes
aMsvSessionMessage server session to use
aMessageIdThe Id of the message to forward
aDestinationThe Id of the folder where the new message is to be created
aPartListThe body parts that are required in the new message. If a message with body text and attachments is required, then the KMsvMessagePartBody and KMsvMessagePartAttachments parts have to be set.
aMsvEmailTypeListCreation flags. This can be 0, or a bitmask of KMsvEmailTypeListMHTMLMessage, KMsvEmailTypeListInvisibleMessage, and KMsvEmailTypeListMessageInPreparation. If KMsvEmailTypeListMHTMLMessage is not set, a plain-text message is created.
aMsgTypeThe type of message to create e.g. KUidMsgTypeSMTP.
Return Value
Operation object by which to control the operation

CreateForwardL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt )

IMPORT_C CImEmailOperation *CreateForwardL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaMessageId,
TMsvIdaDestination,
TMsvIdaSmtpServiceId,
TMsvPartListaPartList,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType,
TIntaPriority = EPriorityStandard
)[static]

Creates a forwarded email message, specifying the message priority and SMTP service with which to send the message.

For details of how forwarding HTML messages is handled, see the description above for the first overload of this function.

Parameters
aObserverRequestStatusAsynchronous status word to complete when the operation completes
aMsvSessionMessage server session to use
aMessageIdThe Id of the message to forward
aDestinationThe Id of the folder where the new message is to be created
aSmtpServiceIdThe Id of the SMTP service with which to send the new message
aPartListThe body parts that are required in the new message. If a message with body text and attachments is required, then the KMsvMessagePartBody and KMsvMessagePartAttachments parts have to be set.
aMsvEmailTypeListCreation flags. This can be 0, or a bitmask of KMsvEmailTypeListMHTMLMessage, KMsvEmailTypeListInvisibleMessage, and KMsvEmailTypeListMessageInPreparation. If KMsvEmailTypeListMHTMLMessage is not set, a plain-text message is created.
aMsgTypeThe type of message to create e.g. KUidMsgTypeSMTP.
aPriorityThe priority setting for the email
Return Value
Operation object by which to control the operation

CreateForwardL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt, TBool )

IMPORT_C CImEmailOperation *CreateForwardL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaMessageId,
TMsvIdaDestination,
TMsvIdaSmtpServiceId,
TMsvPartListaPartList,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType,
TIntaPriority,
TBoolaUsePlainTextStorage
)[static]

Creates a forwarded email message, specifying the message priority and SMTP service with which to send the message.

For details of how forwarding HTML messages is handled, see the description above for the first overload of this function.

Parameters
aObserverRequestStatusAsynchronous status word to complete when the operation completes
aMsvSessionMessage server session to use
aMessageIdThe Id of the message to forward
aDestinationThe Id of the folder where the new message is to be created
aSmtpServiceIdThe Id of the SMTP service with which to send the new message
aPartListThe body parts that are required in the new message. If a message with body text and attachments is required, then the KMsvMessagePartBody and KMsvMessagePartAttachments parts have to be set.
aMsvEmailTypeListCreation flags. This can be 0, or a bitmask of KMsvEmailTypeListMHTMLMessage, KMsvEmailTypeListInvisibleMessage, and KMsvEmailTypeListMessageInPreparation. If KMsvEmailTypeListMHTMLMessage is not set, a plain-text message is created.
aMsgTypeThe type of message to create e.g. KUidMsgTypeSMTP.
aPriorityThe priority setting for the email
aUsePlainTextStorageTBool, if set to ETrue inidcates that the new message entry needs to be created as plain text if set to EFalse indicates that message will be created as richtext entry.
Return Value
Operation object by which to control the operation

CreateNewL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid )

IMPORT_C CImEmailOperation *CreateNewL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaDestination,
TMsvPartListaPartList,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType
)[static]

Creates a new email message.

Parameters
aObserverRequestStatusAsynchronous status word to complete when the operation completes
aMsvSessionMessage server session to use
aDestinationThe Id of the folder where the new message is to be created
aPartListThe body parts that are required in the new message. If a message with body text and attachments is required, then the KMsvMessagePartBody and KMsvMessagePartAttachments parts have to be set.
aMsvEmailTypeListCreation flags. This can be 0, or a bitmask of KMsvEmailTypeListMHTMLMessage, KMsvEmailTypeListInvisibleMessage, and KMsvEmailTypeListMessageInPreparation. If KMsvEmailTypeListMHTMLMessage is not set, a plain-text message is created.
aMsgTypeThe type of message to create e.g. KUidMsgTypeSMTP.
Return Value
Operation object by which to control the operation

CreateNewL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt )

IMPORT_C CImEmailOperation *CreateNewL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaDestination,
TMsvIdaSmtpServiceId,
TMsvPartListaPartList,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType,
TIntaPriority = EPriorityStandard
)[static]

Creates a new email message with a specified priority and SMTP service.

Parameters
aObserverRequestStatusAsynchronous status word to complete when the operation completes
aMsvSessionMessage server session to use
aDestinationThe Id of the folder where the new message is to be created
aSmtpServiceIdThe Id of the SMTP service entry to handle the email
aPartListThe body parts that are required in the new message. If a message with body text and attachments is required, then the KMsvMessagePartBody and KMsvMessagePartAttachments parts have to be set.
aMsvEmailTypeListCreation flags. This can be 0, or a bitmask of KMsvEmailTypeListMHTMLMessage, KMsvEmailTypeListInvisibleMessage, and KMsvEmailTypeListMessageInPreparation. If KMsvEmailTypeListMHTMLMessage is not set, a plain-text message is created.
aMsgTypeThe type of message to create e.g. KUidMsgTypeSMTP.
aPriorityThe priority setting for the email
Return Value
Operation object by which to control the operation

CreateNewL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt, TBool )

IMPORT_C CImEmailOperation *CreateNewL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaDestination,
TMsvIdaSmtpServiceId,
TMsvPartListaPartList,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType,
TIntaPriority,
TBoolaUsePlainTextStorage
)[static]

Creates a new plain text email message with a specified priority and SMTP service.

Parameters
aObserverRequestStatusAsynchronous status word to complete when the operation completes
aMsvSessionMessage server session to use
aDestinationThe Id of the folder where the new message is to be created
aSmtpServiceIdThe Id of the SMTP service entry to handle the email
aPartListThe body parts that are required in the new message. If a message with body text and attachments is required, then the KMsvMessagePartBody and KMsvMessagePartAttachments parts have to be set.
aMsvEmailTypeListCreation flags. This can be 0, or a bitmask of KMsvEmailTypeListMHTMLMessage, KMsvEmailTypeListInvisibleMessage, and KMsvEmailTypeListMessageInPreparation. If KMsvEmailTypeListMHTMLMessage is not set, a plain-text message is created.
aMsgTypeThe type of message to create e.g. KUidMsgTypeSMTP.
aPriorityThe priority setting for the email- by default this must be EPriorityStandard.
aUsePlainTextStorageTBool, if set to ETrue inidcates that the new message entry needs to be created as plain text if set to EFalse indicates that message will be created as richtext entry.
Return Value
CImEmailOperation Operation object by which to control the operation

CreateReceiptL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TDesC &, const TMsvEmailTypeList &, TUid )

IMPORT_C CImEmailOperation *CreateReceiptL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaMessageId,
TMsvIdaDestination,
TMsvPartListaPartList,
const TDesC &aFormatString,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType
)[static]

Creates a email receipt message, overriding the default subject format string.

The aFormatString parameter allows you to override the default string used in the subject field of the new message (the default is the localised string STRING_receipt_formatting_string1 defined in the source file imcm.rls).

Parameters
aObserverRequestStatusAsynchronous status word to complete when the operation completes
aMsvSessionMessage server session to use
aMessageIdThe Id of the original message for which the receipt is required
aDestinationThe Id of the folder where the new message is to be created
aPartListThe body parts that are required in the new message. If a message with body text and attachments is required, then the KMsvMessagePartBody and KMsvMessagePartAttachments parts have to be set.
aFormatStringA string to be inserted into the subject field in the header before the subject, e.g. "Receipt of message: %S", sets the field to be "Receipt of message: " followed by the original subject text
aMsvEmailTypeListCreation flags. This can be 0, or a bitmask of KMsvEmailTypeListMHTMLMessage, KMsvEmailTypeListInvisibleMessage, and KMsvEmailTypeListMessageInPreparation. If KMsvEmailTypeListMHTMLMessage is not set, a plain-text message is created.
aMsgTypeThe type of message to create e.g. KUidMsgTypeSMTP.
Return Value
Operation object by which to control the operation

CreateReceiptL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid )

IMPORT_C CImEmailOperation *CreateReceiptL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaMessageId,
TMsvIdaDestination,
TMsvPartListaPartList,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType
)[static]

Creates a email receipt message.

Parameters
aObserverRequestStatusAsynchronous status word to complete when the operation completes
aMsvSessionMessage server session to use
aMessageIdThe Id of the original message for which the receipt is required
aDestinationThe Id of the folder where the new message is to be created
aPartListThe body parts that are required in the new message. If a message with body text and attachments is required, then the KMsvMessagePartBody and KMsvMessagePartAttachments parts have to be set.
aMsvEmailTypeListCreation flags. This can be 0, or a bitmask of KMsvEmailTypeListMHTMLMessage, KMsvEmailTypeListInvisibleMessage, and KMsvEmailTypeListMessageInPreparation. If KMsvEmailTypeListMHTMLMessage is not set, a plain-text message is created.
aMsgTypeThe type of message to create e.g. KUidMsgTypeSMTP.
Return Value
Operation object by which to control the operation

CreateReceiptL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt )

IMPORT_C CImEmailOperation *CreateReceiptL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaMessageId,
TMsvIdaDestination,
TMsvPartListaPartList,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType,
TIntaPriority
)[static]

Creates a email receipt message, specifying the message priority.

Parameters
aObserverRequestStatusAsynchronous status word to complete when the operation completes
aMsvSessionMessage server session to use
aMessageIdThe Id of the original message for which the receipt is required
aDestinationThe Id of the folder where the new message is to be created
aPartListThe body parts that are required in the new message. If a message with body text and attachments is required, then the KMsvMessagePartBody and KMsvMessagePartAttachments parts have to be set.
aMsvEmailTypeListCreation flags. This can be 0, or a bitmask of KMsvEmailTypeListMHTMLMessage, KMsvEmailTypeListInvisibleMessage, and KMsvEmailTypeListMessageInPreparation. If KMsvEmailTypeListMHTMLMessage is not set, a plain-text message is created.
aMsgTypeThe type of message to create e.g. KUidMsgTypeSMTP.
aPriorityThe priority setting for the email
Return Value
Operation object by which to control the operation

CreateReceiptL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt, TBool )

IMPORT_C CImEmailOperation *CreateReceiptL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaMessageId,
TMsvIdaDestination,
TMsvPartListaPartList,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType,
TIntaPriority,
TBoolaUsePlainTextStorage
)[static]

Creates a email receipt message, specifying the message priority.

Parameters
aObserverRequestStatusAsynchronous status word to complete when the operation completes
aMsvSessionMessage server session to use
aMessageIdThe Id of the original message for which the receipt is required
aDestinationThe Id of the folder where the new message is to be created
aPartListThe body parts that are required in the new message. If a message with body text and attachments is required, then the KMsvMessagePartBody and KMsvMessagePartAttachments parts have to be set.
aMsvEmailTypeListCreation flags. This can be 0, or a bitmask of KMsvEmailTypeListMHTMLMessage, KMsvEmailTypeListInvisibleMessage, and KMsvEmailTypeListMessageInPreparation. If KMsvEmailTypeListMHTMLMessage is not set, a plain-text message is created.
aMsgTypeThe type of message to create e.g. KUidMsgTypeSMTP.
aPriorityThe priority setting for the email
aUsePlainTextStorageTBool, if set to ETrue inidcates that the new message entry needs to be created as plain text if set to EFalse indicates that message will be created as richtext entry.
Return Value
Operation object by which to control the operation

CreateReplyL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TDesC &, const TMsvEmailTypeList &, TUid )

IMPORT_C CImEmailOperation *CreateReplyL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaMessageId,
TMsvIdaDestination,
TMsvPartListaPartList,
const TDesC &aFormatString,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType
)[static]

Creates a reply email message, overriding the default subject format string.

The aFormatString parameter allows you to override the default string used in the subject field of the new message (the default is the localised string STRING_reply_formatting_string1 defined in the source file imcm.rls).

Note that if you reply to an HTML message that does not contain a text/plain alternative to the HTML, then the HTML part is copied as an attachment (still an HTML entry) into the new message even if aPartList does not specify KMsvMessagePartAttachments. This occurs because there is no other way of reading the original message unless the user switches between the editor/viewer and the application.

Parameters
aObserverRequestStatusAsynchronous status word to complete when the operation completes
aMsvSessionMessage server session to use
aMessageIdThe Id of the message to reply to
aDestinationThe Id of the folder where the new message is to be created
aPartListThe body parts that are required in the new message. If a message with body text is required, then set KMsvMessagePartBody; if attachments are required too, also set KMsvMessagePartAttachments. To reply to the originator only, set KMsvMessagePartOriginator, otherwise a reply will be sent to all recipients of the original message. If the subject field is not required, then do not set KMsvMessagePartDescription.
aFormatStringA string to be inserted into the subject field in the header before the subject, e.g. "Re: %S", sets the field to be "Re: " followed by the original subject text
aMsvEmailTypeListCreation flags. This can be 0, or a bitmask of KMsvEmailTypeListMHTMLMessage, KMsvEmailTypeListInvisibleMessage, and KMsvEmailTypeListMessageInPreparation. If KMsvEmailTypeListMHTMLMessage is not set, a plain-text message is created.
aMsgTypeThe type of message to create e.g. KUidMsgTypeSMTP.
Return Value
Operation object by which to control the operation

CreateReplyL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid )

IMPORT_C CImEmailOperation *CreateReplyL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaMessageId,
TMsvIdaDestination,
TMsvPartListaPartList,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType
)[static]

Creates a reply email message.

For details of how replies to HTML messages are handled, see the description above for the first overload of this function.

Parameters
aObserverRequestStatusAsynchronous status word to complete when the operation completes
aMsvSessionMessage server session to use
aMessageIdThe Id of the message to reply to
aDestinationThe Id of the folder where the new message is to be created
aPartListThe body parts that are required in the new message. If a message with body text and attachments is required, then the KMsvMessagePartBody and KMsvMessagePartAttachments parts have to be set.
aMsvEmailTypeListCreation flags. This can be 0, or a bitmask of KMsvEmailTypeListMHTMLMessage, KMsvEmailTypeListInvisibleMessage, and KMsvEmailTypeListMessageInPreparation. If KMsvEmailTypeListMHTMLMessage is not set, a plain-text message is created.
aMsgTypeThe type of message to create e.g. KUidMsgTypeSMTP.
Return Value
Operation object by which to control the operation

CreateReplyL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt )

IMPORT_C CImEmailOperation *CreateReplyL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaMessageId,
TMsvIdaDestination,
TMsvPartListaPartList,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType,
TIntaPriority
)[static]

Creates a reply email message, specifying a message priority.

For details of how replies to HTML messages are handled, see the description above for the first overload of this function.

Parameters
aObserverRequestStatusAsynchronous status word to complete when the operation completes
aMsvSessionMessage server session to use
aMessageIdThe Id of the message to reply to
aDestinationThe Id of the folder where the new message is to be created
aPartListThe body parts that are required in the new message. If a message with body text and attachments is required, then the KMsvMessagePartBody and KMsvMessagePartAttachments parts have to be set.
aMsvEmailTypeListCreation flags. This can be 0, or a bitmask of KMsvEmailTypeListMHTMLMessage, KMsvEmailTypeListInvisibleMessage, and KMsvEmailTypeListMessageInPreparation. If KMsvEmailTypeListMHTMLMessage is not set, a plain-text message is created.
aMsgTypeThe type of message to create e.g. KUidMsgTypeSMTP.
aPriorityThe priority setting for the email
Return Value
Operation object by which to control the operation

CreateReplyL ( TRequestStatus &, CMsvSession &, TMsvId, TMsvId, TMsvPartList, const TMsvEmailTypeList &, TUid, TInt, TBool )

IMPORT_C CImEmailOperation *CreateReplyL(TRequestStatus &aObserverRequestStatus,
CMsvSession &aMsvSession,
TMsvIdaMessageId,
TMsvIdaDestination,
TMsvPartListaPartList,
const TMsvEmailTypeList &aMsvEmailTypeList,
TUidaMsgType,
TIntaPriority,
TBoolaUsePlainTextStorage
)[static]

Creates a reply email message, specifying a message priority.

For details of how replies to HTML messages are handled, see the description above for the first overload of this function.

Parameters
aObserverRequestStatusAsynchronous status word to complete when the operation completes
aMsvSessionMessage server session to use
aMessageIdThe Id of the message to reply to
aDestinationThe Id of the folder where the new message is to be created
aPartListThe body parts that are required in the new message. If a message with body text and attachments is required, then the KMsvMessagePartBody and KMsvMessagePartAttachments parts have to be set.
aMsvEmailTypeListCreation flags. This can be 0, or a bitmask of KMsvEmailTypeListMHTMLMessage, KMsvEmailTypeListInvisibleMessage, and KMsvEmailTypeListMessageInPreparation. If KMsvEmailTypeListMHTMLMessage is not set, a plain-text message is created.
aMsgTypeThe type of message to create e.g. KUidMsgTypeSMTP.
aPriorityThe priority setting for the email
aUsePlainTextStorageTBool, if set to ETrue inidcates that the new message entry needs to be created as plain text if set to EFalse indicates that message will be created as richtext entry.
Return Value
Operation object by which to control the operation

DoCancel ( )

voidDoCancel()

FinalProgress ( )

IMPORT_C const TDesC8 &FinalProgress()

Gets progress information for a completed operation.

The function returns (in packaged form):

for a successfully completed operation, the Id of the new message

if there was an error/problem while creating the message, a null Id (KMsvNullIndexEntryId). The new message will also be deleted.

Return Value
A message Id as a TPckg<TMsvId>

ProgressL ( )

const TDesC8 &ProgressL()

Gets progress information.

While the operation is in progress, a null Id (KMsvNullIndexEntryId) is returned. For a completed operation, values are as described for FinalProgress().

Return Value
A message Id as a TPckg<TMsvId>

RunL ( )

voidRunL()