#include <mw/popcmtm.h>
class CPop3ClientMtm |
Public Member Enumerations | |
---|---|
enum | TImPopcNewEmailHeaderType { EForwardedEmail, EReplyToEmail, EReceiptToEmail } |
Public Member Functions | |
---|---|
~CPop3ClientMtm() | |
void | AddAddresseeL(const TDesC &) |
void | AddAddresseeL(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 &) |
virtual IMPORT_C void | ChangeDefaultServiceL(const TMsvId &) |
virtual EXPORT_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 CPop3ClientMtm * | 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 CImPop3Settings &) |
IMPORT_C const CImPop3Settings & | Settings() |
IMPORT_C void | StoreSettingsL() |
TUint | ValidateMessage(TMsvPartList) |
Protected Member Functions | |
---|---|
CPop3ClientMtm(CRegisteredMtmDll &, CMsvSession &) | |
void | ConstructL() |
void | ContextEntrySwitched() |
POP3 client MTM interface.
Most of the functions in this class are implementations of the virtual functions defined by the base class CBaseMtm.
Deprecated
Enumerator | Value | Description |
---|---|---|
EForwardedEmail | ||
EReplyToEmail | ||
EReceiptToEmail |
CPop3ClientMtm | ( | 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 |
IMPORT_C void | AddAttachmentL | ( | const TDesC & | aFilePath, |
const TDesC8 & | aMimeType, | |||
TUint | aCharset, | |||
TRequestStatus & | aStatus | |||
) | [virtual] |
Unsupported client MTM base class function.
Parameters | |
---|---|
aFilePath | Unused |
aMimeType | Unused |
aCharset | Unused |
aStatus | Unused |
IMPORT_C void | AddAttachmentL | ( | RFile & | aFile, |
const TDesC8 & | aMimeType, | |||
TUint | aCharset, | |||
TRequestStatus & | aStatus | |||
) | [virtual] |
Unsupported client MTM base class function.
Parameters | |
---|---|
aFile | Unused |
aMimeType | Unused |
aCharset | Unused |
aStatus | Unused |
IMPORT_C void | AddEntryAsAttachmentL | ( | TMsvId | aAttachmentId, |
TRequestStatus & | aStatus | |||
) | [virtual] |
Unsupported client MTM base class function.
Parameters | |
---|---|
aAttachmentId | Unused |
aStatus | Unused |
IMPORT_C void | AddLinkedAttachmentL | ( | const TDesC & | aFilePath, |
const TDesC8 & | aMimeType, | |||
TUint | aCharset, | |||
TRequestStatus & | aStatus | |||
) | [virtual] |
Unsupported client MTM base class function.
Parameters | |
---|---|
aFilePath | Unused |
aMimeType | Unused |
aCharset | Unused |
aStatus | Unused |
IMPORT_C void | ChangeDefaultServiceL | ( | const TMsvId & | aService | ) | [virtual] |
Sets the default POP service.
Parameters | |
---|---|
aService | The default service |
void | ConstructL | ( | ) | [protected] |
void | ContextEntrySwitched | ( | ) | [protected] |
EXPORT_C void | CreateAttachmentL | ( | const TDesC & | aFileName, |
RFile & | aAttachmentFile, | |||
const TDesC8 & | aMimeType, | |||
TUint | aCharset, | |||
TRequestStatus & | aStatus | |||
) | [virtual] |
Unsupported client MTM base class function.
Parameters | |
---|---|
aFileName | Unused |
aAttachmentFile | Unused |
aMimeType | Unused |
aCharset | Unused |
aStatus | Unused |
IMPORT_C void | CreateMessageL | ( | TMsvId | aServiceId | ) | [virtual] |
Unsupported client MTM base class function.
Parameters | |
---|---|
aServiceId | Unused |
IMPORT_C TMsvId | DefaultServiceL | ( | ) | const [virtual] |
Gets the default POP 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 | aId, |
TMsvPartList | aPartList, | |||
TRequestStatus & | aCompletionStatus | |||
) |
Creates a forwarded message from the current message context.
The forwarded message is an SMTP message.
Parameters | |
---|---|
aId | 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 TPop3Cmds 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 | Contains information such as the destination folder ID for Get Mail operations. For get mail type functionality, this information must be packaged as a TImPop3GetMailInfo package buffer. |
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 synchronous POP3-specific operations.
Parameters | |
---|---|
aFunctionId | ID of the requested operation. The only supported operation is KPOP3MTMIsConnected. |
aSelection | Selection of message entries. This is used if the operation requires message entries to work on. |
aParameter | Buffer containing input and output parameters. The format of this is specific to the operation. |
IMPORT_C CPop3ClientMtm * | 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 POP service.
CMsvOperation * | ReplyL | ( | TMsvId | aId, |
TMsvPartList | aPartlist, | |||
TRequestStatus & | aCompletionStatus | |||
) |
Creates a reply message to the current message context.
The reply is an SMTP message.
Parameters | |
---|---|
aId | 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.
The current entry must be a service.
IMPORT_C void | SetSettingsL | ( | const CImPop3Settings & | aSettings | ) |
Copies the specified service settings to the cached service settings.
Parameters | |
---|---|
aSettings | New service settings |
IMPORT_C const CImPop3Settings & | 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.
TUint | ValidateMessage | ( | TMsvPartList | aPartList | ) |
Client MTM base class function, with an empty implementation.
Parameters | |
---|---|
aPartList | Unused |