Class CPop3ClientMtm

class CPop3ClientMtm : public CBaseMtm;

Description

POP3 client MTM interface.

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

Derivation

• MMsvEntryObserver - Provides the interface for notification of events associated with an entry
• CBase - Base class for all classes to be instantiated on the heap

• CBaseMtm - Provides a high-level interface for accessing and manipulating a Message Server entry

• CPop3ClientMtm - POP3 client MTM interface

Members

Defined in CPop3ClientMtm:
AddAddresseeL(), AddAddresseeL(), AddAttachmentL(), AddAttachmentL(), AddEntryAsAttachmentL(), AddLinkedAttachmentL(), ChangeDefaultServiceL(), ContextEntrySwitched(), CreateAttachmentL(), CreateMessageL(), DefaultServiceL(), EForwardedEmail, EReceiptToEmail, EReplyToEmail, Find(), ForwardL(), InvokeAsyncFunctionL(), InvokeSyncFunctionL(), LoadMessageL(), QueryCapability(), RemoveAddressee(), RemoveDefaultServiceL(), ReplyL(), RestoreSettingsL(), SaveMessageL(), SetSettingsL(), Settings(), StoreSettingsL(), TImPopcNewEmailHeaderType, ValidateMessage()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CBaseMtm:
AddresseeList(), BioTypeChangedL(), Body(), CancelAttachmentOperation(), Entry(), Filler1(), Filler2(), GetInterface(), HandleEntryEventL(), HasContext(), RestoreBodyL(), Session(), SetCurrentEntryL(), SetSubjectL(), StoreBodyL(), SubjectL(), SwitchCurrentEntryL(), Type(), iAddresseeList, iCharFormatLayer, iMsvEntry, iParaFormatLayer

Inherited from MMsvEntryObserver:
EMsvChildrenChanged, EMsvChildrenInvalid, EMsvChildrenMissing, EMsvContextInvalid, EMsvDeletedChildren, EMsvEntryChanged, EMsvEntryDeleted, EMsvEntryMoved, EMsvNewChildren, TMsvEntryEvent

virtual void SaveMessageL();

Description

Client MTM base class function, with an empty implementation.

virtual void LoadMessageL();

Description

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

IMPORT_C void StoreSettingsL();

Description

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 void RestoreSettingsL();

Description

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

The current entry must be a service.

virtual CMsvOperation *ReplyL(TMsvId aId, TMsvPartList aPartlist, TRequestStatus &aCompletionStatus);

Description

Creates a reply message to the current message context.

The reply is an SMTP message.

Parameters

TMsvId aId The entry to which to assign the reply TMsvPartList aPartlist Defines the parts that are to be copied from the original message into the reply TRequestStatus &aCompletionStatus The request status to be completed when the operation has finished

Return value

CMsvOperation * If successful, this is an asynchronously completing reply operation. If failed, this is a completed operation, with status set to the relevant error code.

virtual CMsvOperation *ForwardL(TMsvId aId, TMsvPartList aPartList, TRequestStatus &aCompletionStatus);

Description

Creates a forwarded message from the current message context.

The forwarded message is an SMTP message.

Parameters

TMsvId aId The entry to which to assign the forwarded message TMsvPartList aPartList Defines the parts that are to be copied from the original message into the forwarded message TRequestStatus &aCompletionStatus The request status to be completed when the operation has finished

Return value

CMsvOperation * 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.

virtual TUint ValidateMessage(TMsvPartList aPartList);

Description

Client MTM base class function, with an empty implementation.

Parameters

TMsvPartList aPartList Unused

Return value

TUint Unused

virtual TMsvPartList Find(const TDesC &aTextToFind, TMsvPartList aPartList);

Description

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

Parameters

const TDesC &aTextToFind The plain-text version of the text to be found. TMsvPartList aPartList Indicates the message parts which should be searched.

Return value

TMsvPartList 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.

virtual void AddAddresseeL(const TDesC &aRealAddress);

Description

Adds an addressee for the current context.

Parameters

const TDesC &aRealAddress String representing an address to be added to the list for the current message

virtual void AddAddresseeL(const TDesC &aRealAddress, const TDesC &aAlias);

Description

Adds an addressee with an alias for the current context.

Parameters

const TDesC &aRealAddress String representing an address to be added to the list for the current message const TDesC &aAlias Alias information

virtual void RemoveAddressee(TInt aIndex);

Description

Removes an address from the current address list.

Parameters

TInt aIndex Index of address to be removed

IMPORT_C void SetSettingsL(const CImPop3Settings &aSettings);

Description

Copies the specified service settings to the cached service settings.

Parameters

const CImPop3Settings &aSettings New service settings

IMPORT_C const CImPop3Settings &Settings() const;

Description

Gets the current cached service settings.

Return value

const CImPop3Settings & The current cached service settings

virtual TInt QueryCapability(TUid aCapability, TInt &aResponse);

Description

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

Parameters

TUid aCapability UID of capability to be queried TInt &aResponse Response value. The format of the response varies according to the capability.

Return value

TInt KErrNone: aCapability is a recognised value and a response is returned KErrNotSupported: aCapability is not a recognised value

virtual void InvokeSyncFunctionL(TInt aFunctionId, const CMsvEntrySelection &aSelection, TDes8 &aParameter);

Description

Invokes synchronous POP3-specific operations.

Parameters

TInt aFunctionId ID of the requested operation. The only supported operation is KPOP3MTMIsConnected. const CMsvEntrySelection &aSelection Selection of message entries. This is used if the operation requires message entries to work on. TDes8 &aParameter Buffer containing input and output parameters. The format of this is specific to the operation.

virtual CMsvOperation *InvokeAsyncFunctionL(TInt aFunctionId, const CMsvEntrySelection &aSelection, TDes8 &aParameter, TRequestStatus &aCompletionStatus);

Description

Invokes asynchronous POP3-specific operations.

Parameters

TInt aFunctionId Specifies which operation to perform e.g. connect, copy new mail etc. The specific operations are defined by the TPop3Cmds enumeration. const CMsvEntrySelection &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. TDes8 &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. TRequestStatus &aCompletionStatus The status when the operation completes.

Return value

CMsvOperation * 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

KErrNotFound The selection of email to be moved or copied is empty KErrNotSupported The specified operation is not recognised

See also:

• TImPop3GetMailInfo
• TPop3Cmds

virtual IMPORT_C void AddAttachmentL(const TDesC &aFilePath, const TDesC8 &aMimeType, TUint aCharset, TRequestStatus &aStatus);

Description

Unsupported client MTM base class function.

Parameters

const TDesC &aFilePath Unused const TDesC8 &aMimeType Unused TUint aCharset Unused TRequestStatus &aStatus Unused

virtual IMPORT_C void AddAttachmentL(RFile &aFile, const TDesC8 &aMimeType, TUint aCharset, TRequestStatus &aStatus);

Description

Unsupported client MTM base class function.

Parameters

RFile &aFile Unused const TDesC8 &aMimeType Unused TUint aCharset Unused TRequestStatus &aStatus Unused

virtual IMPORT_C void AddLinkedAttachmentL(const TDesC &aFilePath, const TDesC8 &aMimeType, TUint aCharset, TRequestStatus &aStatus);

Description

Unsupported client MTM base class function.

Parameters

const TDesC &aFilePath Unused const TDesC8 &aMimeType Unused TUint aCharset Unused TRequestStatus &aStatus Unused

virtual IMPORT_C void AddEntryAsAttachmentL(TMsvId aAttachmentId, TRequestStatus &aStatus);

Description

Unsupported client MTM base class function.

Parameters

TMsvId aAttachmentId Unused TRequestStatus &aStatus Unused

virtual EXPORT_C void CreateAttachmentL(const TDesC &aFileName, RFile &aAttachmentFile, const TDesC8 &aMimeType, TUint aCharset, TRequestStatus &aStatus);

Description

Unsupported client MTM base class function.

Parameters

const TDesC &aFileName Unused RFile &aAttachmentFile Unused const TDesC8 &aMimeType Unused TUint aCharset Unused TRequestStatus &aStatus Unused

virtual IMPORT_C void CreateMessageL(TMsvId aServiceId);

Description

Unsupported client MTM base class function.

Parameters

TMsvId aServiceId Unused

virtual IMPORT_C TMsvId DefaultServiceL() const;

Description

Gets the default POP service.

KErrNotFound If default service setting does not exist.

Return value

TMsvId The default service

Leave codes

virtual IMPORT_C void RemoveDefaultServiceL();

Description

Removes the default POP service.

virtual IMPORT_C void ChangeDefaultServiceL(const TMsvId &aService);

Description

Sets the default POP service.

Parameters

const TMsvId &aService The default service

protected: virtual void ContextEntrySwitched();

Description

Called by the base class functions SwitchCurrentEntryL() and SetCurrentEntryL() when the context is changed to another entry.

Client applications do not use this function. It is relevant only to implementers of derived classes.

Requirements:

An implementation should clear:

1. address data stored in iAddresseeList

2. any caches of MTM-specific entry data relating to a previous context. For example, if the implementation has a private buffer storing a message subject, for access through Subject(), this buffer should be cleared.

TImPopcNewEmailHeaderType

Description

EForwardedEmail EReplyToEmail EReceiptToEmail