CImImap4GetMail Class Reference

#include <mw/impcmtm.h>

class CImImap4GetMail

Public Member Functions
	~CImImap4GetMail()
void	DoCancel()
const TDesC8 &	FinalProgress()
IMPORT_C CMsvOperation *	GetMailL(TInt, CImap4ClientMtm &, const CMsvEntrySelection &, TDes8 &, TRequestStatus &)
const TDesC8 &	ProgressL()
void	RunL()

Detailed Description

Encapsulates an operation to copy, move, and populate (i.e. download the full message body) IMAP4 emails from the remote inbox to any local folder.

Note that the same operations are available by calling CImap4ClientMtm::InvokeAsyncFunctionL() with a suitable command.

Constructor & Destructor Documentation

~CImImap4GetMail ( )

~CImImap4GetMail

(

)

Destructor.

Member Function Documentation

DoCancel ( )

void

DoCancel

(

)

FinalProgress ( )

const TDesC8 &

FinalProgress

(

)

Gets information about a completed operation.

Panic Codes
IMCM	30 Operation has not completed

GetMailL ( TInt, CImap4ClientMtm &, const CMsvEntrySelection &, TDes8 &, TRequestStatus & )

IMPORT_C CMsvOperation *	GetMailL	(	TInt	aFunctionId,
			CImap4ClientMtm &	aImap4ClientMtm,
			const CMsvEntrySelection &	aMsvEntrySelection,
			TDes8 &	aImap4GetMailInfo,
			TRequestStatus &	aObserverRequestStatus
		)

Creates and begins a new IMAP4 get mail operation.

Note that the function should be, though is not, marked as static. The workaround is to call the function using a NULL CImImap4GetMail pointer:

CImImap4GetMail* gm = NULL;
CMsvOperation* gmOp = gm->GetMailL(id, mtm, sel, info, status);

Alternatively, instead of using this class, call CImap4ClientMtm::InvokeAsyncFunctionL() directly. Any functionality accessible through this class can also be accessed through that function.

Copy commands:

Move commands:

Populate commands:

Parameters
aFunctionId	Type of operation to perform, a TImap4Cmds value. Permitted commands are:
aImap4ClientMtm	A reference to the IMAP4 Client MTM that wants to perform the Get Mail operation.
aMsvEntrySelection	A selection of messages that need to be copied/moved to a local folder. The first entry in this selection MUST be the service. Other IDs can be appended to the selection depending on which operation is to be performed. For the 'copy new', 'copy all', 'move new', 'move all', 'populate new', 'populate all' situations, the folder from which the messages are to be copied, moved or populated should be appended after the service ID. For all the other situations (i.e. copying, moving or populating a selection of messages), the selection of messages should be appended after the service ID. Please note that the selection of messages MUST have the same parent i.e. MUST be in the same folder.
aImap4GetMailInfo	A packaged TImImap4GetMailInfo object storing the maximum message size, the destination folder ID, and what message parts are required. For populate commands, this can be a packaged TImImap4GetPartialMailInfo object, specifying separate size limits for body text and attachments.
aObserverRequestStatus	The status to be completed when the get mail operation has completed.

Return Value: The new message operation object through which the get operation can be controlled.

ProgressL ( )

const TDesC8 &

ProgressL

(

)

Gets information on the progress of the operation.

RunL ( )

void

RunL

(

)