#include <mw/smtcmtm.h>
class CSmtpClientMtm |
Public Member Functions | |
---|---|
~CSmtpClientMtm() | |
void | AddAddresseeL(const TDesC &) |
void | AddAddresseeL(const TDesC &, const TDesC &) |
void | AddAddresseeL(TMsvRecipientType, const TDesC &) |
void | AddAddresseeL(TMsvRecipientType, const TDesC &, const TDesC &) |
virtual IMPORT_C void | AddAttachmentL(const TDesC &, const TDesC8 &, TUint, TRequestStatus &) |
virtual IMPORT_C void | AddAttachmentL(RFile &, const TDesC8 &, TUint, TRequestStatus &) |
virtual IMPORT_C void | AddEntryAsAttachmentL(TMsvId, TRequestStatus &) |
virtual IMPORT_C void | AddLinkedAttachmentL(const TDesC &, const TDesC8 &, TUint, TRequestStatus &) |
IMPORT_C void | CancelAttachmentOperation() |
virtual IMPORT_C void | ChangeDefaultServiceL(const TMsvId &) |
virtual IMPORT_C void | CreateAttachmentL(const TDesC &, RFile &, const TDesC8 &, TUint, TRequestStatus &) |
virtual IMPORT_C void | CreateMessageL(TMsvId) |
virtual IMPORT_C TMsvId | DefaultServiceL() |
TMsvPartList | Find(const TDesC &, TMsvPartList) |
CMsvOperation * | ForwardL(TMsvId, TMsvPartList, TRequestStatus &) |
CMsvOperation * | InvokeAsyncFunctionL(TInt, const CMsvEntrySelection &, TDes8 &, TRequestStatus &) |
void | InvokeSyncFunctionL(TInt, const CMsvEntrySelection &, TDes8 &) |
void | LoadMessageL() |
IMPORT_C CSmtpClientMtm * | NewL(CRegisteredMtmDll &, CMsvSession &) |
TInt | QueryCapability(TUid, TInt &) |
void | RemoveAddressee(TInt) |
virtual IMPORT_C void | RemoveDefaultServiceL() |
CMsvOperation * | ReplyL(TMsvId, TMsvPartList, TRequestStatus &) |
IMPORT_C void | RestoreSettingsL() |
void | SaveMessageL() |
IMPORT_C void | SetSettingsL(const CImSmtpSettings &) |
IMPORT_C void | SetSubjectL(const TDesC &) |
IMPORT_C const CImSmtpSettings & | Settings() |
IMPORT_C void | StoreSettingsL() |
IMPORT_C const TPtrC | SubjectL() |
TMsvPartList | ValidateMessage(TMsvPartList) |
Protected Member Functions | |
---|---|
CSmtpClientMtm(CRegisteredMtmDll &, CMsvSession &) | |
void | ConstructL() |
void | ContextEntrySwitched() |
SMTP client MTM interface.
Most of the functions in this class are implementations of the virtual functions defined by the base class CBaseMtm.
CSmtpClientMtm | ( | CRegisteredMtmDll & | aRegisteredMtmDll, |
CMsvSession & | aMsvSession | ||
) | [protected] |
void | AddAddresseeL | ( | const TDesC & | aRealAddress | ) |
Adds an addressee for the current context.
Parameters | |
---|---|
aRealAddress | String representing an address to be added to the list for the current message |
void | AddAddresseeL | ( | TMsvRecipientType | aType, |
const TDesC & | aRealAddress | |||
) |
IMPORT_C void | AddAttachmentL | ( | const TDesC & | aFilePath, |
const TDesC8 & | aMimeType, | |||
TUint | aCharset, | |||
TRequestStatus & | aStatus | |||
) | [virtual] |
IMPORT_C void | AddAttachmentL | ( | RFile & | aFile, |
const TDesC8 & | aMimeType, | |||
TUint | aCharset, | |||
TRequestStatus & | aStatus | |||
) | [virtual] |
IMPORT_C void | AddEntryAsAttachmentL | ( | TMsvId | aAttachmentId, |
TRequestStatus & | aStatus | |||
) | [virtual] |
IMPORT_C void | AddLinkedAttachmentL | ( | const TDesC & | aFilePath, |
const TDesC8 & | aMimeType, | |||
TUint | aCharset, | |||
TRequestStatus & | aStatus | |||
) | [virtual] |
IMPORT_C void | CancelAttachmentOperation | ( | ) |
Cancels the current attachment operation.
IMPORT_C void | ChangeDefaultServiceL | ( | const TMsvId & | aService | ) | [virtual] |
Sets the default SMTP service.
Parameters | |
---|---|
aService | The default service |
void | ConstructL | ( | ) | [protected] |
void | ContextEntrySwitched | ( | ) | [protected] |
IMPORT_C void | CreateAttachmentL | ( | const TDesC & | aFileName, |
RFile & | aAttachmentFile, | |||
const TDesC8 & | aMimeType, | |||
TUint | aCharset, | |||
TRequestStatus & | aStatus | |||
) | [virtual] |
IMPORT_C void | CreateMessageL | ( | TMsvId | aServiceId | ) | [virtual] |
Creates a new message entry as a child of the current context.
Parameters | |
---|---|
aServiceId | ID of the service to own the entry. |
IMPORT_C TMsvId | DefaultServiceL | ( | ) | const [virtual] |
Gets the default SMTP service.
Leave Codes | |
---|---|
TMsvPartList | Find | ( | const TDesC & | aTextToFind, |
TMsvPartList | aPartList | |||
) |
Searches the specified message part(s) for the plain-text version of the text to be found.
Parameters | |
---|---|
aTextToFind | The plain-text version of the text to be found. |
aPartList | Indicates the message parts which should be searched. |
CMsvOperation * | ForwardL | ( | TMsvId | aForwardEntryId, |
TMsvPartList | aPartList, | |||
TRequestStatus & | aCompletionStatus | |||
) |
Creates a forwarded message from the current message context.
Parameters | |
---|---|
aForwardEntryId | The entry to which to assign the forwarded message |
aPartList | Defines the parts that are to be copied from the original message into the forwarded message |
aCompletionStatus | The request status to be completed when the operation has finished |
CMsvOperation * | InvokeAsyncFunctionL | ( | TInt | aFunctionId, |
const CMsvEntrySelection & | aSelection, | |||
TDes8 & | aParameter, | |||
TRequestStatus & | aCompletionStatus | |||
) |
Parameters | |
---|---|
aFunctionId | Specifies which operation to perform e.g. connect, copy new mail etc. The specific operations are defined by the TSmtpCmds enumeration. |
aSelection | A selection of messages that need to be copied/moved to a local folder. The first entry in this selection MUST be the service. |
aParameter | Not used |
aCompletionStatus | The status when the operation completes. |
Leave Codes | |
---|---|
KErrNotFound | The selection of email to be moved or copied is empty |
KErrNotSupported | The specified operation is not recognised |
void | InvokeSyncFunctionL | ( | TInt | aFunctionId, |
const CMsvEntrySelection & | aSelection, | |||
TDes8 & | aParameter | |||
) |
Invokes a synchronous SMTP-specific operation.
Parameters | |
---|---|
aFunctionId | Specifies which operation to perform. The only valid ID is KSMTPMTMIsConnected. |
aSelection | A selection of messages for the operation. |
aParameter | Not used |
IMPORT_C CSmtpClientMtm * | NewL | ( | CRegisteredMtmDll & | aRegisteredMtmDll, |
CMsvSession & | aMsvSession | |||
) | [static] |
Queries if the MTM supports a particular capability, specified by a UID.
Parameters | |
---|---|
aCapability | UID of capability to be queried |
aResponse | Response value. The format of the response varies according to the capability. |
void | RemoveAddressee | ( | TInt | aIndex | ) |
Removes an address from the current address list.
Parameters | |
---|---|
aIndex | Index of address to be removed |
IMPORT_C void | RemoveDefaultServiceL | ( | ) | [virtual] |
Removes the default SMTP service.
CMsvOperation * | ReplyL | ( | TMsvId | aReplyEntryId, |
TMsvPartList | aPartlist, | |||
TRequestStatus & | aCompletionStatus | |||
) |
Creates a reply message to the current message context.
Parameters | |
---|---|
aReplyEntryId | The entry to which to assign the reply |
aPartlist | Defines the parts that are to be copied from the original message into the reply |
aCompletionStatus | The request status to be completed when the operation has finished |
IMPORT_C void | RestoreSettingsL | ( | ) |
Loads into the object's cache the service settings from the Central Repository for the current entry.
void | SaveMessageL | ( | ) |
Commits cached changes to the current message context to the storage controlled by the Message Server.
IMPORT_C void | SetSettingsL | ( | const CImSmtpSettings & | aSettings | ) |
Copies the specified service settings to the cached service settings.
Parameters | |
---|---|
aSettings | New service settings |
IMPORT_C void | SetSubjectL | ( | const TDesC & | aSubject | ) |
Sets the message context's subject text.
Parameters | |
---|---|
aSubject | Subject text |
IMPORT_C const CImSmtpSettings & | Settings | ( | ) | const |
Gets the current cached service settings.
IMPORT_C void | StoreSettingsL | ( | ) |
Stores the current service settings from the object's cache in to the Central Repository for the current entry.
The current entry must be a service.
IMPORT_C const TPtrC | SubjectL | ( | ) | const |
Gets the message context's subject text.
TMsvPartList | ValidateMessage | ( | TMsvPartList | aPartList | ) |
Validates the current message context.
The addresses for the message are checked to be well-formed email addresses.
Parameters | |
---|---|
aPartList | Indicates the message parts for which validation is requested |