class RSendAsMessage : public RSubSessionBase |
Encapsulates creating and sending a message. This class requires a connected RSendAs session.
A client application can have several RSendAsMessage objects created simultaneously. Each RSendAsMessage object corresponds to a single message.
With the RSendAsMessage class, a client application can perform the following operations:
-Creating and managing a message
-Modifying a message created using SendAs
-Sending a message
-Launching a message editor
Client applications do not require any capabilities in order to use the RSendAs and RSendAsMessage APIs. However, if an application does not have the necessary security capabilities to send a message, the SendAs server ensures that a message is only sent after the user's authorization.
A message created using RSendAsMessage can be saved, sent, or passed to the appropriate message editor. There are two types of send operation:
-A confirmed send is forwarded to the UI MTM for the message type. Typically this results in the user being asked to confirm that the message should be sent.
-An unconfirmed send fails if the client application does not have the required capabilities to use the server MTM for the message type.
There are asynchronous and synchronous forms of these sending methods. Progress information for sending is available when the asynchronous forms are used. The synchronous forms, and the methods for saving the message and for launching it in a message editor, all close the handle to the RSendAsMessage, so the message cannot be further accessed through the API.
Public Member Enumerations | |
---|---|
enum | TSendAsRecipientType { ESendAsRecipientTo = EMsvRecipientTo, ESendAsRecipientCc, ESendAsRecipientBcc } |
Private Attributes | |
---|---|
TAny * | iAny |
IMPORT_C void | AddAttachment | ( | const TDesC & | aFilePath, |
const TDesC8 & | aMimeType, | |||
TUint | aCharset, | |||
TRequestStatus & | aStatus | |||
) |
const TDesC & aFilePath | |
const TDesC8 & aMimeType | |
TUint aCharset | |
TRequestStatus & aStatus |
IMPORT_C void | AddAttachment | ( | const TDesC & | aFilePath, |
const TDesC8 & | aMimeType, | |||
TRequestStatus & | aStatus | |||
) |
const TDesC & aFilePath | |
const TDesC8 & aMimeType | |
TRequestStatus & aStatus |
IMPORT_C void | AddAttachment | ( | const TDesC & | aFilePath, |
TRequestStatus & | aStatus | |||
) |
const TDesC & aFilePath | |
TRequestStatus & aStatus |
IMPORT_C void | AddAttachment | ( | RFile & | aFile, |
const TDesC8 & | aMimeType, | |||
TUint | aCharset, | |||
TRequestStatus & | aStatus | |||
) |
RFile & aFile | |
const TDesC8 & aMimeType | |
TUint aCharset | |
TRequestStatus & aStatus |
IMPORT_C void | AddAttachment | ( | RFile & | aFile, |
const TDesC8 & | aMimeType, | |||
TRequestStatus & | aStatus | |||
) |
RFile & aFile | |
const TDesC8 & aMimeType | |
TRequestStatus & aStatus |
IMPORT_C void | AddAttachment | ( | RFile & | aFile, |
TRequestStatus & | aStatus | |||
) |
RFile & aFile | |
TRequestStatus & aStatus |
IMPORT_C void | AddLinkedAttachment | ( | const TDesC & | aFilePath, |
const TDesC8 & | aMimeType, | |||
TUint | aCharset, | |||
TRequestStatus & | aStatus | |||
) |
const TDesC & aFilePath | |
const TDesC8 & aMimeType | |
TUint aCharset | |
TRequestStatus & aStatus |
IMPORT_C void | AddLinkedAttachment | ( | const TDesC & | aFilePath, |
const TDesC8 & | aMimeType, | |||
TRequestStatus & | aStatus | |||
) |
const TDesC & aFilePath | |
const TDesC8 & aMimeType | |
TRequestStatus & aStatus |
IMPORT_C void | AddLinkedAttachment | ( | const TDesC & | aFilePath, |
TRequestStatus & | aStatus | |||
) |
const TDesC & aFilePath | |
TRequestStatus & aStatus |
IMPORT_C void | AddRecipientL | ( | const TDesC & | aAddress, |
TSendAsRecipientType | aRecipientType | |||
) |
const TDesC & aAddress | |
TSendAsRecipientType aRecipientType |
IMPORT_C void | AddRecipientL | ( | const TDesC & | aAddress, |
const TDesC & | aAlias, | |||
TSendAsRecipientType | aRecipientType | |||
) |
const TDesC & aAddress | |
const TDesC & aAlias | |
TSendAsRecipientType aRecipientType |
IMPORT_C void | CreateAttachmentL | ( | const TDesC & | aFileName, |
RFile & | aAttachmentFile | |||
) |
IMPORT_C void | CreateAttachmentL | ( | const TDesC & | aFileName, |
RFile & | aAttachmentFile, | |||
const TDesC8 & | aMimeType | |||
) |
IMPORT_C void | CreateAttachmentL | ( | const TDesC & | aFileName, |
RFile & | aAttachmentFile, | |||
const TDesC8 & | aMimeType, | |||
TUint | aCharset | |||
) |
IMPORT_C void | CreateL | ( | RSendAs & | aSendAs, |
TSendAsAccount | aAccount | |||
) |
RSendAs & aSendAs | |
TSendAsAccount aAccount |
IMPORT_C void | ProgressL | ( | TSendAsProgress & | aProgress | ) |
TSendAsProgress & aProgress |
IMPORT_C void | SendMessage | ( | TRequestStatus & | aStatus | ) |
TRequestStatus & aStatus |
IMPORT_C void | SendMessageConfirmed | ( | TRequestStatus & | aStatus | ) |
TRequestStatus & aStatus |
IMPORT_C void | SetBodyTextL | ( | const CRichText & | aBody | ) |
const CRichText & aBody |
IMPORT_C void | SetBodyTextL | ( | const TDesC & | aBody | ) |
const TDesC & aBody |
IMPORT_C void | SetCharacterSetL | ( | const TUint | aCharset | ) |
Sets the character encoding value. The character encoding value options are 7-bit, 8-bit and 16-Bit Unicode. By default the character set encoding is 7 bit encoding.
const TUint aCharset |
IMPORT_C void | SetSubjectL | ( | const TDesC & | aSubject | ) |
const TDesC & aSubject |
Defines the recipient types available when adding a recipient to a message
ESendAsRecipientTo = EMsvRecipientTo |
Designates a 'To' recipient. |
ESendAsRecipientCc |
Designates a 'Cc' recipient. |
ESendAsRecipientBcc |
Designates a 'Bcc' recipient. |