CPop3ClientMtm Class Reference

#include <mw/popcmtm.h>

class CPop3ClientMtm
Public Member Enumerations
enumTImPopcNewEmailHeaderType { EForwardedEmail, EReplyToEmail, EReceiptToEmail }
Public Member Functions
~CPop3ClientMtm()
voidAddAddresseeL(const TDesC &)
voidAddAddresseeL(const TDesC &, const TDesC &)
virtual IMPORT_C voidAddAttachmentL(const TDesC &, const TDesC8 &, TUint, TRequestStatus &)
virtual IMPORT_C voidAddAttachmentL(RFile &, const TDesC8 &, TUint, TRequestStatus &)
virtual IMPORT_C voidAddEntryAsAttachmentL(TMsvId, TRequestStatus &)
virtual IMPORT_C voidAddLinkedAttachmentL(const TDesC &, const TDesC8 &, TUint, TRequestStatus &)
virtual IMPORT_C voidChangeDefaultServiceL(const TMsvId &)
virtual EXPORT_C voidCreateAttachmentL(const TDesC &, RFile &, const TDesC8 &, TUint, TRequestStatus &)
virtual IMPORT_C voidCreateMessageL(TMsvId)
virtual IMPORT_C TMsvIdDefaultServiceL()
TMsvPartListFind(const TDesC &, TMsvPartList)
CMsvOperation *ForwardL(TMsvId, TMsvPartList, TRequestStatus &)
CMsvOperation *InvokeAsyncFunctionL(TInt, const CMsvEntrySelection &, TDes8 &, TRequestStatus &)
voidInvokeSyncFunctionL(TInt, const CMsvEntrySelection &, TDes8 &)
voidLoadMessageL()
IMPORT_C CPop3ClientMtm *NewL(CRegisteredMtmDll &, CMsvSession &)
TInt QueryCapability(TUid, TInt &)
voidRemoveAddressee(TInt)
virtual IMPORT_C voidRemoveDefaultServiceL()
CMsvOperation *ReplyL(TMsvId, TMsvPartList, TRequestStatus &)
IMPORT_C voidRestoreSettingsL()
voidSaveMessageL()
IMPORT_C voidSetSettingsL(const CImPop3Settings &)
IMPORT_C const CImPop3Settings &Settings()
IMPORT_C voidStoreSettingsL()
TUint ValidateMessage(TMsvPartList)
Protected Member Functions
CPop3ClientMtm(CRegisteredMtmDll &, CMsvSession &)
voidConstructL()
voidContextEntrySwitched()

Detailed Description

POP3 client MTM interface.

Most of the functions in this class are implementations of the virtual functions defined by the base class CBaseMtm.

Member Enumeration Documentation

Enum TImPopcNewEmailHeaderType

Deprecated

EnumeratorValueDescription
EForwardedEmail
EReplyToEmail
EReceiptToEmail

Constructor & Destructor Documentation

CPop3ClientMtm ( CRegisteredMtmDll &, CMsvSession & )

CPop3ClientMtm(CRegisteredMtmDll &aRegisteredMtmDll,
CMsvSession &aMsvSession
)[protected]

~CPop3ClientMtm ( )

~CPop3ClientMtm()

Destructor.

Member Function Documentation

AddAddresseeL ( const TDesC & )

voidAddAddresseeL(const TDesC &aRealAddress)

Adds an addressee for the current context.

Parameters
aRealAddressString representing an address to be added to the list for the current message

AddAddresseeL ( const TDesC &, const TDesC & )

voidAddAddresseeL(const TDesC &aRealAddress,
const TDesC &aAlias
)

Adds an addressee with an alias for the current context.

Parameters
aRealAddressString representing an address to be added to the list for the current message
aAliasAlias information

AddAttachmentL ( const TDesC &, const TDesC8 &, TUint, TRequestStatus & )

IMPORT_C voidAddAttachmentL(const TDesC &aFilePath,
const TDesC8 &aMimeType,
TUintaCharset,
TRequestStatus &aStatus
)[virtual]

Unsupported client MTM base class function.

Parameters
aFilePathUnused
aMimeTypeUnused
aCharsetUnused
aStatusUnused

AddAttachmentL ( RFile &, const TDesC8 &, TUint, TRequestStatus & )

IMPORT_C voidAddAttachmentL(RFile &aFile,
const TDesC8 &aMimeType,
TUintaCharset,
TRequestStatus &aStatus
)[virtual]

Unsupported client MTM base class function.

Parameters
aFileUnused
aMimeTypeUnused
aCharsetUnused
aStatusUnused

AddEntryAsAttachmentL ( TMsvId, TRequestStatus & )

IMPORT_C voidAddEntryAsAttachmentL(TMsvIdaAttachmentId,
TRequestStatus &aStatus
)[virtual]

Unsupported client MTM base class function.

Parameters
aAttachmentIdUnused
aStatusUnused

AddLinkedAttachmentL ( const TDesC &, const TDesC8 &, TUint, TRequestStatus & )

IMPORT_C voidAddLinkedAttachmentL(const TDesC &aFilePath,
const TDesC8 &aMimeType,
TUintaCharset,
TRequestStatus &aStatus
)[virtual]

Unsupported client MTM base class function.

Parameters
aFilePathUnused
aMimeTypeUnused
aCharsetUnused
aStatusUnused

ChangeDefaultServiceL ( const TMsvId & )

IMPORT_C voidChangeDefaultServiceL(const TMsvId &aService)[virtual]

Sets the default POP service.

Parameters
aServiceThe default service

ConstructL ( )

voidConstructL()[protected]

ContextEntrySwitched ( )

voidContextEntrySwitched()[protected]

CreateAttachmentL ( const TDesC &, RFile &, const TDesC8 &, TUint, TRequestStatus & )

EXPORT_C voidCreateAttachmentL(const TDesC &aFileName,
RFile &aAttachmentFile,
const TDesC8 &aMimeType,
TUintaCharset,
TRequestStatus &aStatus
)[virtual]

Unsupported client MTM base class function.

Parameters
aFileNameUnused
aAttachmentFileUnused
aMimeTypeUnused
aCharsetUnused
aStatusUnused

CreateMessageL ( TMsvId )

IMPORT_C voidCreateMessageL(TMsvIdaServiceId)[virtual]

Unsupported client MTM base class function.

Parameters
aServiceIdUnused

DefaultServiceL ( )

IMPORT_C TMsvIdDefaultServiceL()const [virtual]

Gets the default POP service.

KErrNotFound If default service setting does not exist.
Return Value
The default service
Leave Codes

Find ( const TDesC &, TMsvPartList )

TMsvPartListFind(const TDesC &aTextToFind,
TMsvPartListaPartList
)

Searches the specified message part(s) for the plain-text version of the text to be found.

Parameters
aTextToFindThe plain-text version of the text to be found.
aPartListIndicates the message parts which should be searched.
Return Value
If the text was not found, or searching is unsupported, 0. If the text was found, a bitmask of the TMsvPartList IDs for each part in which the text was present.

ForwardL ( TMsvId, TMsvPartList, TRequestStatus & )

CMsvOperation *ForwardL(TMsvIdaId,
TMsvPartListaPartList,
TRequestStatus &aCompletionStatus
)

Creates a forwarded message from the current message context.

The forwarded message is an SMTP message.

Parameters
aIdThe entry to which to assign the forwarded message
aPartListDefines the parts that are to be copied from the original message into the forwarded message
aCompletionStatusThe request status to be completed when the operation has finished
Return Value
If successful, this is an asynchronously completing forward message operation. If failed, this is a completed operation, with status set to the relevant error code.

InvokeAsyncFunctionL ( TInt, const CMsvEntrySelection &, TDes8 &, TRequestStatus & )

CMsvOperation *InvokeAsyncFunctionL(TIntaFunctionId,
const CMsvEntrySelection &aSelection,
TDes8 &aParameter,
TRequestStatus &aCompletionStatus
)

Invokes asynchronous POP3-specific operations.

See also: TImPop3GetMailInfo TPop3Cmds

Parameters
aFunctionIdSpecifies which operation to perform e.g. connect, copy new mail etc. The specific operations are defined by the TPop3Cmds enumeration.
aSelectionA selection of messages that need to be copied/moved to a local folder. The first entry in this selection MUST be the service.
aParameterContains 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.
aCompletionStatusThe status when the operation completes.
Return Value
If successful, this is an asynchronously completing operation. If failed, this is a completed operation, with status set to the relevant error code.
Leave Codes
KErrNotFoundThe selection of email to be moved or copied is empty
KErrNotSupportedThe specified operation is not recognised

InvokeSyncFunctionL ( TInt, const CMsvEntrySelection &, TDes8 & )

voidInvokeSyncFunctionL(TIntaFunctionId,
const CMsvEntrySelection &aSelection,
TDes8 &aParameter
)

Invokes synchronous POP3-specific operations.

Parameters
aFunctionIdID of the requested operation. The only supported operation is KPOP3MTMIsConnected.
aSelectionSelection of message entries. This is used if the operation requires message entries to work on.
aParameterBuffer containing input and output parameters. The format of this is specific to the operation.

LoadMessageL ( )

voidLoadMessageL()

Loads the cache with the message data for the current context.

NewL ( CRegisteredMtmDll &, CMsvSession & )

IMPORT_C CPop3ClientMtm *NewL(CRegisteredMtmDll &aRegisteredMtmDll,
CMsvSession &aMsvSession
)[static]

QueryCapability ( TUid, TInt & )

TInt QueryCapability(TUidaCapability,
TInt &aResponse
)

Queries if the MTM supports a particular capability, specified by a UID.

Parameters
aCapabilityUID of capability to be queried
aResponseResponse value. The format of the response varies according to the capability.
Return Value
KErrNone: aCapability is a recognised value and a response is returned KErrNotSupported: aCapability is not a recognised value

RemoveAddressee ( TInt )

voidRemoveAddressee(TIntaIndex)

Removes an address from the current address list.

Parameters
aIndexIndex of address to be removed

RemoveDefaultServiceL ( )

IMPORT_C voidRemoveDefaultServiceL()[virtual]

Removes the default POP service.

ReplyL ( TMsvId, TMsvPartList, TRequestStatus & )

CMsvOperation *ReplyL(TMsvIdaId,
TMsvPartListaPartlist,
TRequestStatus &aCompletionStatus
)

Creates a reply message to the current message context.

The reply is an SMTP message.

Parameters
aIdThe entry to which to assign the reply
aPartlistDefines the parts that are to be copied from the original message into the reply
aCompletionStatusThe request status to be completed when the operation has finished
Return Value
If successful, this is an asynchronously completing reply operation. If failed, this is a completed operation, with status set to the relevant error code.

RestoreSettingsL ( )

IMPORT_C voidRestoreSettingsL()

Loads into the object's cache the service settings from the Central Repository for the current entry.

The current entry must be a service.

SaveMessageL ( )

voidSaveMessageL()

Client MTM base class function, with an empty implementation.

SetSettingsL ( const CImPop3Settings & )

IMPORT_C voidSetSettingsL(const CImPop3Settings &aSettings)

Copies the specified service settings to the cached service settings.

Parameters
aSettingsNew service settings

Settings ( )

IMPORT_C const CImPop3Settings &Settings()const

Gets the current cached service settings.

Return Value
The current cached service settings

StoreSettingsL ( )

IMPORT_C voidStoreSettingsL()

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.

ValidateMessage ( TMsvPartList )

TUint ValidateMessage(TMsvPartListaPartList)

Client MTM base class function, with an empty implementation.

Parameters
aPartListUnused
Return Value
Unused