#include <POPCMTM.H>
Link against: imcm.lib

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

CPop3ClientMtm - POP3 client MTM interface.

Members

Defined in CPop3ClientMtm:

AddAddresseeL(const TDesC &)Adds an addressee for the current context.
AddAddresseeL(const TDesC &,const TDesC &)Adds an addressee with an alias for the current context.
AddAttachmentL(RFile &,const TDesC8 &,TUint,TRequestStatus &)Unsupported client MTM base class function.
AddAttachmentL(const TDesC &,const TDesC8 &,TUint,TRequestStatus &)Unsupported client MTM base class function.
AddEntryAsAttachmentL(TMsvId,TRequestStatus &)Unsupported client MTM base class function.
AddLinkedAttachmentL(const TDesC &,const TDesC8 &,TUint,TRequestStatus &)Unsupported client MTM base class function.
ChangeDefaultServiceL(const TMsvId &)Sets the default POP service.
ContextEntrySwitched()Called by the base class functions CBaseMtm::SwitchCurrentEntryL(TMsvId) and CBa...
CreateAttachmentL(const TDesC &,RFile &,const TDesC8 &,TUint,TRequestStatus &)Unsupported client MTM base class function.
CreateMessageL(TMsvId)Unsupported client MTM base class function.
DefaultServiceL()constGets the default POP service.
EForwardedEmail
EReceiptToEmail
EReplyToEmail
Find(const TDesC &,TMsvPartList)Searches the specified message part(s) for the plain-text version of the text to...
ForwardL(TMsvId,TMsvPartList,TRequestStatus &)Creates a forwarded message from the current message context.
InvokeAsyncFunctionL(TInt,const CMsvEntrySelection &,TDes8 &,TRequestStatus &)Invokes asynchronous POP3-specific operations.
InvokeSyncFunctionL(TInt,const CMsvEntrySelection &,TDes8 &)Invokes synchronous POP3-specific operations.
LoadMessageL()Loads the cache with the message data for the current context.
QueryCapability(TUid,TInt &)Queries if the MTM supports a particular capability, specified by a UID.
RemoveAddressee(TInt)Removes an address from the current address list.
RemoveDefaultServiceL()Removes the default POP service.
ReplyL(TMsvId,TMsvPartList,TRequestStatus &)Creates a reply message to the current message context.
RestoreSettingsL()Loads into the object's cache the service settings from the Central Repository f...
SaveMessageL()Client MTM base class function, with an empty implementation.
SetSettingsL(const CImPop3Settings &)Copies the specified service settings to the cached service settings.
Settings()constGets the current cached service settings.
StoreSettingsL()Stores the current service settings from the object's cache in to the Central Re...
TImPopcNewEmailHeaderType
ValidateMessage(TMsvPartList)Client MTM base class function, with an empty implementation.

Inherited from CBase:

Delete(CBase *)Deletes the specified object.
operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TAny *)Initialises the object to binary zeroes.
operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from CBaseMtm:

AddAddresseeL(TMsvRecipientType,const TDesC &)Adds addressee to list.
AddAddresseeL(TMsvRecipientType,const TDesC &,const TDesC &)Adds addressee to list.
AddresseeList()constGets the list of intended recipients for the current context, which must be a me...
BioTypeChangedL(TUid)Informs client-side MTM that the context's BIO field is being changed as a resul...
Body()Gets the body text of the context, that must be a message. For non-message conte...
Body()constGets the read-only body text of the context, that must be a message. For non-mes...
CBaseMtm(CRegisteredMtmDll &,CMsvSession &)Creates a CBaseMtm with member variables initialised from the passed arguments.
CancelAttachmentOperation()Cancels the current attachment operation.
Entry()constGets a CMsvEntry for the current context. The message client application can the...
Extension_(TUint,TAny *&,TAny *)The default Extension service. The default implementation of this function assum...
Filler1()
Filler2()
GetInterface(TUid)Returns a pointer to the interface with the specified Uid.
HandleEntryEventL(TMsvEntryEvent,TAny *,TAny *,TAny *)Indicates that an event has occurred.
HasContext()constTests if an MTM context has been set.
RestoreBodyL(CMsvStore &)Gets the current cached CRichText from the appropriate stream in the specified m...
Session()Gets a reference to the session object passed by the creator of the Client-side ...
SetCurrentEntryL(CMsvEntry *)Sets the entry on which later actions are performed to the specified CMsvEntry.
SetMessageCharacterSet(TUint)Sets the character encoding value. The character encoding value options are 7-bi...
SetSubjectL(const TDesC &)Sets the subject text of the context, which must be a message.
StoreBodyL(CMsvStore &)Stores and commits the current cached CRichText body text to the appropriate str...
SubjectL()constGets the subject text of the context, which must be a message.
SwitchCurrentEntryL(TMsvId)Changes the entry on which later actions are performed to the entry with the spe...
Type()constGets the Type UID of the message type associated with the Client-side MTM.
iAddresseeListThe address list for the current context.
iCharFormatLayerCharacter formatting applied to the CRichText object for the body text, as retur...
iMsvEntryThe current context.
iParaFormatLayerParagraph formatting applied to the CRichText object for the body text, as retur...

Inherited from MMsvEntryObserver:

EMsvChildrenChangedOne or more of the children have been changed. aArg1 points to a CMsvEntrySelect...
EMsvChildrenInvalidAn error has occurred such that the status of the children is unknown and probab...
EMsvChildrenMissingSome new children have been created, but CMsvEntry was unable to retrieve the da...
EMsvContextInvalidThe context has become invalid. The entry has been changed, but the CMsvEntry wa...
EMsvDeletedChildrenChildren have been deleted. aArg1 points to a CMsvEntrySelection contain the ID ...
EMsvEntryChangedThe entry has been changed, either as a result of a CMsvEntry::ChangeL(const TMs...
EMsvEntryDeletedThe entry has been deleted by another client. The context is now invalid.
EMsvEntryMovedThe current entry has been moved by another client. The CMsvEntry has already be...
EMsvNewChildrenNew children have been created. aArg1 points to a CMsvEntrySelection contain the...
TMsvEntryEventDefines entry event types.

Member functions

`SaveMessageL()`

virtual void SaveMessageL();

Description

Client MTM base class function, with an empty implementation.

`LoadMessageL()`

virtual void LoadMessageL();

Description

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

`StoreSettingsL()`

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.

`RestoreSettingsL()`

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.

`ReplyL(TMsvId,TMsvPartList,TRequestStatus &)`

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.

`ForwardL(TMsvId,TMsvPartList,TRequestStatus &)`

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.

`ValidateMessage(TMsvPartList)`

virtual TUint ValidateMessage(TMsvPartList aPartList);

Description

Client MTM base class function, with an empty implementation.

Parameters


                                 						TMsvPartList aPartList

Unused

Return value


                                 						TUint

Unused

`Find(const TDesC &,TMsvPartList)`

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 TDesC16 &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.

`AddAddresseeL(const TDesC &)`

virtual void AddAddresseeL(const TDesC &aRealAddress);

Description

Adds an addressee for the current context.

Parameters

const TDesC16 &aRealAddress

String representing an address to be added to the list for the current message

`AddAddresseeL(const TDesC &,const TDesC &)`

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

Description

Adds an addressee with an alias for the current context.

Parameters

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

`RemoveAddressee(TInt)`

virtual void RemoveAddressee(TInt aIndex);

Description

Removes an address from the current address list.

Parameters


                                 						TInt aIndex

Index of address to be removed

`SetSettingsL(const CImPop3Settings &)`

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

`Settings()const`

IMPORT_C const CImPop3Settings& Settings() const;

Description

Gets the current cached service settings.

Return value

const CImPop3Settings &

The current cached service settings

`QueryCapability(TUid,TInt &)`

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

`InvokeSyncFunctionL(TInt,const CMsvEntrySelection &,TDes8 &)`

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.

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

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

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

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