Class CImImap4GetMail

class CImImap4GetMail : public CMsvOperation;

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(TInt,const CMsvEntrySelection &,TDes8 &,TRequestStatus &) with a suitable command.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CActive - The core class of the active object abstraction.

• CMsvOperation - Defines an interface for use by objects which control asynchronous commands in t...

• CImImap4GetMail - Encapsulates an operation to copy, move, and populate (i.e. download the full me...

Members

Defined in CImImap4GetMail:

• DoCancel()Implements cancellation of an outstanding request.
• FinalProgress()Gets information about a completed operation.
• GetMailL(TInt,CImap4ClientMtm &,const CMsvEntrySelection &,TDes8 &,TRequestStatus &)Creates and begins a new IMAP4 get mail operation.
• ProgressL()Gets information on the progress of the operation.
• RunL()Handles an active object's request completion event.

Inherited from CActive:

• CActive(TInt)Constructs the active object with the specified priority.
• Cancel()Cancels the wait for completion of an outstanding request.
• Deque()Removes the active object from the active scheduler's list of active objects.
• EPriorityHighA priority higher than EPriorityUserInput.
• EPriorityIdleA low priority, useful for active objects representing background processing.
• EPriorityLowA priority higher than EPriorityIdle but lower than EPriorityStandard.
• EPriorityStandardMost active objects will have this priority.
• EPriorityUserInputA priority higher than EPriorityStandard; useful for active objects handling use...
• IsActive()constDetermines whether the active object has a request outstanding.
• IsAdded()constDetermines whether the active object has been added to the active scheduler's li...
• Priority()constGets the priority of the active object.
• RunError(TInt)Handles a leave occurring in the request completion event handler CActive::RunL(...
• SetActive()Indicates that the active object has issued a request and that it is now outstan...
• SetPriority(TInt)Sets the priority of the active object.
• TPriorityDefines standard priorities for active objects.
• iStatusThe request status associated with an asynchronous request.

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

• CMsvOperation(CMsvSession &,TInt,TRequestStatus &)Constructor. This is called by MTM implementers from the derived class construct...
• Extension_(TUint,TAny *&,TAny *)The extension method provides a polymorphic behaviour to call the correct System...
• Id()constGets the operation ID.
• Mtm()constGets the UID of the MTM associated with the operation.
• Service()constGets the ID of the service that is associated with this operation.
• SystemProgress(TMsvSystemProgress &)This call leads to calling CMsvOperation::SystemProgress(TMsvSystemProgress &...
• iMsvSessionMessage Server session used by object. This is set by the constructor.
• iMtmThe UID of the MTM associated with the operation.
• iObserverRequestStatusRequest status of the operation observer.
• iServiceThe ID of the service that is associated with this operation.

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

Description

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(TInt,const CMsvEntrySelection &,TDes8 &,TRequestStatus &) directly. Any functionality accessible through this class can also be accessed through that function.

Copy commands:

• KIMAP4MTMConnectAndCopyNewMailAndStayOnline

• KIMAP4MTMConnectAndCopyNewMailAndDisconnect

• KIMAP4MTMConnectAndCopyAllMailAndStayOnline

• KIMAP4MTMConnectAndCopyAllMailAndDisconnect

• KIMAP4MTMConnectAndCopyMailSelectionAndStayOnline

• KIMAP4MTMConnectAndCopyMailSelectionAndDisconnect

Move commands:

• KIMAP4MTMConnectAndMoveNewMailAndStayOnline

• KIMAP4MTMConnectAndMoveNewMailAndDisconnect

• KIMAP4MTMConnectAndMoveAllMailAndStayOnline

• KIMAP4MTMConnectAndMoveAllMailAndDisconnect

• KIMAP4MTMConnectAndMoveMailSelectionAndStayOnline

• KIMAP4MTMConnectAndMoveMailSelectionAndDisconnect

Populate commands:

• KIMAP4MTMConnectAndPopulateNewMailAndStayOnline

• KIMAP4MTMConnectAndPopulateNewMailAndDisconnect

• KIMAP4MTMConnectAndPopulateAllMailAndStayOnline

• KIMAP4MTMConnectAndPopulateAllMailAndDisconnect

• KIMAP4MTMConnectAndPopulateMailSelectionAndStayOnline

• KIMAP4MTMConnectAndPopulateMailSelectionAndDisconnect

Parameters

TInt aFunctionId Type of operation to perform, a TImap4Cmds value. Permitted commands are: CImap4ClientMtm &aImap4ClientMtm A reference to the IMAP4 Client MTM that wants to perform the Get Mail operation. const CMsvEntrySelection &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. TDes8 &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. TRequestStatus &aObserverRequestStatus The status to be completed when the get mail operation has completed.

Return value

CMsvOperation * The new message operation object through which the get operation can be controlled.

See also:

• TImap4CmdsIMAP4-specific commands that can be issued through either CImap4ClientMtm::Invok...
• TImImap4GetMailInfoSpecifies options used when retrieving messages with IMAP.
• TImImap4GetPartialMailInfoSpecifies message criteria that are used as a filter when retrieving messages pa...

virtual void DoCancel();

Description

Implements cancellation of an outstanding request.

This function is called as part of the active object's CActive::Cancel().

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

CImImap4GetMail::DoCancel() must not wait for event completion; this is handled by CActive::Cancel().

See also:

• CActive::Cancel()Cancels the wait for completion of an outstanding request.

virtual void RunL();

Description

Handles an active object's request completion event.

A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.

The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.

Before calling this active object's CImImap4GetMail::RunL() function, the active scheduler has:

1. decided that this is the highest priority active object with a completed request

2. marked this active object's request as complete (i.e. the request is no longer outstanding)

CImImap4GetMail::RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls CActive::RunError(TInt) to handle the leave.

Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's CImImap4GetMail::RunL() or CActive::RunError(TInt) functions.

See also:

• CActiveScheduler::Start()Starts a new wait loop under the control of the current active scheduler.
• CActiveScheduler::Error(TInt)constHandles the result of a leave occurring in an active object’s RunL() function.
• CActiveScheduler::WaitForAnyRequest()Wait for an asynchronous request to complete.

virtual const TDesC8& ProgressL();

Description

Gets information on the progress of the operation.

Return value

const TDesC8 & Packaged TImap4GenericProgress holding progress information.

See also:

• TImap4GenericProgressProgress information for an IMAP4 get operation.

virtual const TDesC8& FinalProgress();

Description

Gets information about a completed operation.

Return value

const TDesC8 & Packaged TImap4GenericProgress holding progress information.

Panic codes

IMCM 30 Operation has not completed

See also:

• TImap4GenericProgressProgress information for an IMAP4 get operation.