CPop3ClientMtm Class Reference

class CPop3ClientMtm : public CBaseMtm

POP3 client MTM interface.

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

Inherits from

CPop3ClientMtm
- CBaseMtm
  - CBase

Public Member Functions
	~CPop3ClientMtm()
void	AddAddresseeL(const TDesC &)
void	AddAddresseeL(const TDesC &, const TDesC &)
IMPORT_C void	AddAttachmentL(const TDesC &, const TDesC8 &, TUint, TRequestStatus &)
IMPORT_C void	AddAttachmentL(RFile &, const TDesC8 &, TUint, TRequestStatus &)
IMPORT_C void	AddEntryAsAttachmentL(TMsvId, TRequestStatus &)
IMPORT_C void	AddLinkedAttachmentL(const TDesC &, const TDesC8 &, TUint, TRequestStatus &)
IMPORT_C void	ChangeDefaultServiceL(const TMsvId &)
EXPORT_C void	CreateAttachmentL(const TDesC &, RFile &, const TDesC8 &, TUint, TRequestStatus &)
IMPORT_C void	CreateMessageL(TMsvId)
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)
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()

Private Member Functions
TMsvPartList	DoFindL(const TDesC &, TMsvPartList)
CMsvEntrySelection *	FilteredChildrenLC(TBool, TInt)
CMsvEntrySelection *	FilteredSelectionLC(TInt, const CMsvEntrySelection &)
void	SendOnNextConnectionL()
TBool	ValidateAddress(const TPtrC &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CBaseMtm::AddAddresseeL(TMsvRecipientType,const TDesC &)
	CBaseMtm::AddAddresseeL(TMsvRecipientType,const TDesC &,const TDesC &)
	CBaseMtm::AddresseeList()const
	CBaseMtm::BioTypeChangedL(TUid)
	CBaseMtm::Body()
	CBaseMtm::Body()const
	CBaseMtm::CBaseMtm(CRegisteredMtmDll &,CMsvSession &)
	CBaseMtm::CancelAttachmentOperation()
	CBaseMtm::Entry()const
	CBaseMtm::Extension_(TUint,TAny &,TAny )
	CBaseMtm::Filler1()
	CBaseMtm::Filler2()
	CBaseMtm::GetExtensionData()
	CBaseMtm::GetInterface(TUid)
	CBaseMtm::HandleEntryEventL(TMsvEntryEvent,TAny ,TAny ,TAny *)
	CBaseMtm::HasContext()const
	CBaseMtm::RestoreBodyL(CMsvStore &)
	CBaseMtm::Session()
	CBaseMtm::SetCurrentEntryL(CMsvEntry *)
	CBaseMtm::SetExtensionData(TAny *)
	CBaseMtm::SetMessageCharacterSet(TUint)
	CBaseMtm::SetSubjectL(const TDesC &)
	CBaseMtm::StoreBodyL(CMsvStore &)
	CBaseMtm::SubjectL()const
	CBaseMtm::SwitchCurrentEntryL(TMsvId)
	CBaseMtm::Type()const
	CBaseMtm::~CBaseMtm()

Public Member Enumerations
enum	TImPopcNewEmailHeaderType { EForwardedEmail, EReplyToEmail, EReceiptToEmail }

Private Attributes
HBufC *	iEmailAddressFormatString
CImHeader *	iHeader
CImEmailOperation *	iImEmailOperation
CImPOP3GetMail *	iImPOP3GetMail
CImPop3Settings *	iImPop3Settings
TImMessageField	iTImMessageField

Inherited Attributes
	CBaseMtm::iAddresseeList
	CBaseMtm::iCharFormatLayer
	CBaseMtm::iMsvEntry
	CBaseMtm::iParaFormatLayer

Constructor & Destructor Documentation

CPop3ClientMtm(CRegisteredMtmDll &, CMsvSession &)

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

Parameters

CRegisteredMtmDll & aRegisteredMtmDll
CMsvSession & aMsvSession

~CPop3ClientMtm()

~CPop3ClientMtm

(

)

Member Functions Documentation

AddAddresseeL(const TDesC &)

void

AddAddresseeL

(

const TDesC &

aRealAddress

)

[virtual]

Adds an addressee for the current context.

Addresses are not validated by checking their format by this function. Usually that is performed by calling ValidateMessage().

Requirements:

Implementations should append the address to the object's address cache in the protected iAddresseeList data member. Some implementations may also wish to store addresses in an internal data structure appropriate for the protocol, for example, a class holding message header information.

leave

KErrNotSupported The message already has the maximum number of addressees

leave

Other leave codes Dependent on implementation

Parameters

const TDesC & aRealAddress

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

AddAddresseeL(const TDesC &, const TDesC &)

void	AddAddresseeL	(	const TDesC &	aRealAddress,
			const TDesC &	aAlias
		)	[virtual]

Adds an addressee for the current context, and enables the client to specify an alias, which may be useful for some protocols. For example, for fax, if the address is the fax number, the alias could supply the recipient's name.

Addresses are not validated by checking their format by this function. Usually that is performed by calling ValidateMessage().

Requirements:

leave

KErrNotSupported The message already has the maximum number of addressees

leave

Other leave codes Dependent on implementation

Parameters

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

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

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

Parameters

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

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

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

Parameters

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

AddEntryAsAttachmentL(TMsvId, TRequestStatus &)

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

Parameters

TMsvId aAttachmentId
TRequestStatus & aStatus

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

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

Parameters

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

ChangeDefaultServiceL(const TMsvId &)

IMPORT_C void

ChangeDefaultServiceL

(

const TMsvId &

aService

)

[virtual]

Parameters

const TMsvId & aService

ConstructL()

void

ConstructL

(

)

[protected]

ContextEntrySwitched()

void

ContextEntrySwitched

(

)

[protected, virtual]

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.

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

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

Parameters

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

CreateMessageL(TMsvId)

IMPORT_C void

CreateMessageL

(

TMsvId

aServiceId

)

[virtual]

Parameters

TMsvId aServiceId

DefaultServiceL()

IMPORT_C TMsvId

DefaultServiceL

(

)

const [virtual]

DoFindL(const TDesC &, TMsvPartList)

TMsvPartList	DoFindL	(	const TDesC &	aTextToFind,
			TMsvPartList	aPartList
		)	[private]

Parameters

const TDesC & aTextToFind
TMsvPartList aPartList

FilteredChildrenLC(TBool, TInt)

CMsvEntrySelection *	FilteredChildrenLC	(	TBool	aNewOnly,
			TInt	aMaxEmailSize
		)	[private]

Parameters

TBool aNewOnly
TInt aMaxEmailSize

FilteredSelectionLC(TInt, const CMsvEntrySelection &)

CMsvEntrySelection *	FilteredSelectionLC	(	TInt	aMaxEmailSize,
			const CMsvEntrySelection &	aSelection
		)	[private]

Parameters

TInt aMaxEmailSize
const CMsvEntrySelection & aSelection

Find(const TDesC &, TMsvPartList)

TMsvPartList	Find	(	const TDesC &	aTextToFind,
			TMsvPartList	aPartList
		)	[virtual]

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

If the specified part list indicates a part that is not supported, or is not present in the current message, the function behaves as if the specified part exists but does not contain the required text.

Requirements:

The parts of the entry for which searching is allowed is implementation specific. If no searching is supported, always return 0.

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.

Parameters

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

ForwardL(TMsvId, TMsvPartList, TRequestStatus &)

CMsvOperation *	ForwardL	(	TMsvId	aDestination,
			TMsvPartList	aPartList,
			TRequestStatus &	aCompletionStatus
		)	[virtual]

Creates a forwarded message from the current message context.

Some MTMs may support inclusion of elements, specified by aPartlist, from the original message in the forwarded message. The parent for the new entry is specified in aDestination. The returned CMsvOperation object completes when editing the forwarded message is complete. On completion, the context is set to the forwarded message.

Requirements:

A typical implementation for this function would include the following steps:

1. create a new message in the specified destination by calling CMsvEntry::CreateL()

2. set the entry index values as appropriate

3. set message content as required. The normal minimum is to include the text of the original message. An implementation may also follow the options specified in aPartlist to include other properties of the original message.

4. set the context to the reply

5. return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation

If forwarded messages are not supported, implementations should leave with KErrNotSupported.

The implementation of this function may be similar to that of ReplyL(), allowing opportunities for code sharing.

leave

KErrNotSupported The Client-side MTM does not support creation of forwarded messages

leave

Other leave codes Dependent on implementation

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.

Parameters

TMsvId aDestination	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

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

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

Invokes asynchronous protocol-specific operations. For synchronous operations, a similar function, InvokeSyncFunctionL(), is available.

aSelection and aParameter allow data to be passed to the operation. The TRequestStatus and CMsvOperation objects are used as normal to control and monitor the operation.

Requirements:

For functionality that requires message transport access, such as making a connection, the implementation should pass the request onto the corresponding Server-side MTM. This is done through calling CMsvSession::TransferCommandL(). Implementations may also provide protocol-specific functions themselves if this is useful.

InvokeAsyncFunctionL() should return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation. If CMsvSession::TransferCommandL() is called, this should be the CMsvOperation object returned by that function.

leave

KErrNotSupported aFunctionId is not a recognised operation ID

leave

Other leave codes Dependent on implementation

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

Parameters

TInt aFunctionId	ID of the requested operation
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.
TRequestStatus & aCompletionStatus	The request status to be completed when the operation has finished

InvokeSyncFunctionL(TInt, const CMsvEntrySelection &, TDes8 &)

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

Invokes synchronous protocol-specific operations. For asynchronous operations, a similar function, InvokeAsyncFunctionL(), is available.

aSelection and aParameter allow data to be passed to the operation.

Requirements:

leave

KErrNotSupported aFunctionId is not a recognised operation ID

leave

Other leave codes Dependent on implementation

Parameters

TInt aFunctionId	ID of the requested operation
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.

LoadMessageL()

void

LoadMessageL

(

)

[virtual]

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

It can only be called on message contexts.

It is typically used after the context has been set with SetCurrentEntryL() or SwitchCurrentEntryL(). CBaseMtm functions to manipulate the entry can only be called after this function has been called.

Requirements:

An implementation must restore the store and index entry relating to the message context. Typically, the message store should be opened for reading with CMsvEntry::ReadStoreL(). It should be then be read to set the following:

1. body text: call RestoreBodyL() to update the cached body text

2. address list: read the appropriate MTM-specific area of the store to update iAddresseeList

3. subject: if supported, read the appropriate MTM-specific area of the store and update the cache with SetSubjectL()

The function should panic for non-message contexts.

NewL(CRegisteredMtmDll &, CMsvSession &)

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

Parameters

CRegisteredMtmDll & aRegisteredMtmDll
CMsvSession & aMsvSession

QueryCapability(TUid, TInt &)

TInt	QueryCapability	(	TUid	aCapability,
			TInt &	aResponse
		)	[virtual]

Parameters

TUid aCapability
TInt & aResponse

RemoveAddressee(TInt)

void

RemoveAddressee

(

TInt

aIndex

)

[virtual]

Removes an address from the current address list. The address is specified by a zero-based index into the address list. If the index is not known, applications can use AddresseeList() to retrieve the entire list to find the item.

Requirements:

Implementations should call iAddresseeList->Delete(aIndex) to remove the address from in the address list protected data member.

Parameters

TInt aIndex

Index of address to be removed

RemoveDefaultServiceL()

IMPORT_C void

RemoveDefaultServiceL

(

)

[virtual]

ReplyL(TMsvId, TMsvPartList, TRequestStatus &)

CMsvOperation *	ReplyL	(	TMsvId	aDestination,
			TMsvPartList	aPartlist,
			TRequestStatus &	aCompletionStatus
		)	[virtual]

Creates a reply message to the current message context.

Some MTMs may support inclusion of elements, specified by aPartlist, from the original message in the reply. The parent for the new entry is specified in aDestination.

The returned CMsvOperation object completes when creating the reply is complete. On completion, the context is set to the reply message.

Requirements:

A typical implementation for this function would include the following steps:

1. create a new message in the specified destination by calling CMsvEntry::CreateL()

2. set the entry index values as appropriate

3. set the properties of the message as required. The normal minimum is to set the address to the sender of the original message. An implementation may also follow the options specified in aPartlist to set other properties, for example, to include the original message text.

4. set the context to the reply

5. return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation

If message replies are not supported, implementations should leave with KErrNotSupported.

The implementation of this function may be similar to that of ForwardL(), allowing opportunities for code sharing.

leave

KErrNotSupported The Client-side MTM does not support reply operations

leave

Other leave codes Dependent on implementation

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

Parameters

TMsvId aDestination	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

RestoreSettingsL()

IMPORT_C void

RestoreSettingsL

(

)

SaveMessageL()

void

SaveMessageL

(

)

[virtual]

Commits cached changes to the storage controlled by the Message Server.

It can only be called on message contexts. It should be called in the following circumstances:

1. to preserve changes when the context is changed, or when the Client-side MTM object is deleted

2. to enable other parts of the Messaging to access the updated entry, as required, for example, before sending a message

Requirements:

An implementation must update the store and index entry relating to the message context. Typically, the message store should be opened for editing with CMsvEntry::EditStoreL(). It should be updated as follows:

1. body text: call StoreBodyL() to update the store's body text stream

2. address list: update the appropriate MTM-specific area of the store from the data in iAddresseeList

3. subject: if supported, update the appropriate MTM-specific area of the store from the private cache set by SetSubjectL()

Changes can then be committed to the store with CMsvStore::CommitL().

The index entry should also be updated to reflect changes. Possible fields that may need updating include: Description (for subject changes); Details and Multiple Recipients (for recipient changes); and Size. Index entry changes are committed using CMsvEntry::ChangeL().

The function should panic for non-message contexts.

SendOnNextConnectionL()

void

SendOnNextConnectionL

(

)

[private]

SetSettingsL(const CImPop3Settings &)

IMPORT_C void

SetSettingsL

(

const CImPop3Settings &

aSettings

)

Parameters

const CImPop3Settings & aSettings

Settings()

IMPORT_C const CImPop3Settings &

Settings

(

)

const

StoreSettingsL()

IMPORT_C void

StoreSettingsL

(

)

ValidateAddress(const TPtrC &)

TBool

ValidateAddress

(

const TPtrC &

anAddress

)

[private]

Parameters

const TPtrC & anAddress

ValidateMessage(TMsvPartList)

TUint

ValidateMessage

(

TMsvPartList

aPartList

)

[virtual]

Validates the current message context.

The precise validation performed is specific to the MTM, but, typically, checks that the specified message parts are well-formed.

Requirements:

Implementation of this function is highly protocol-specific. A minimum step is to check that the current context is a message.

If valid, KErrNone If invalid, identifies the invalid part(s). The error value is the bitmask of the TMsvPartList IDs for each invalid part

Parameters

TMsvPartList aPartList

Indicates the message parts for which validation is requested

Member Enumerations Documentation

Enum TImPopcNewEmailHeaderType

Enumerators

EForwardedEmail
EReplyToEmail
EReceiptToEmail

Member Data Documentation

HBufC * iEmailAddressFormatString

HBufC *

iEmailAddressFormatString

[private]

CImHeader * iHeader

CImHeader *

iHeader

[private]

CImEmailOperation * iImEmailOperation

CImEmailOperation *

iImEmailOperation

[private]

CImPOP3GetMail * iImPOP3GetMail

CImPOP3GetMail *

iImPOP3GetMail

[private]

CImPop3Settings * iImPop3Settings

CImPop3Settings *

iImPop3Settings

[private]

TImMessageField iTImMessageField

TImMessageField

iTImMessageField

[private]