Class CImPOP3GetMail

class CImPOP3GetMail : public CMsvOperation;

Description

Encapsulates an operation to copy/move POP3 emails from the remote inbox to any local folder.

Functionality is provided to:

1. copy/move any new emails

2. copy/move a selection of emails

3. copy/move all emails

4. in the Remote Inbox to a local folder.

There are three cases for copying/moving the emails from the Remote Inbox:

1. the user is connected to the account so just copy/move the emails

2. the user is not connected to the account so connect, copy/move the emails, and then disconnect

3. the user is not connected to the account so connect, copy/move the emails, and then stay online

Objects of this type are returned from CPop3ClientMtm::InvokeAsyncFunctionL() when a suitable get command is requested.

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 the messaging system

• CImPOP3GetMail - Encapsulates an operation to copy/move POP3 emails from the remote inbox to any local folder

Members

Defined in CImPOP3GetMail:
DoCancel(), EConnectAndCopyAllMailAndDisconnect, EConnectAndCopyAllMailAndStayOnline, EConnectAndCopyMailSelectionAndDisconnect, EConnectAndCopyMailSelectionAndStayOnline, EConnectAndCopyNewMailAndDisconnect, EConnectAndCopyNewMailAndStayOnline, EConnectAndMoveAllMailAndDisconnect, EConnectAndMoveAllMailAndStayOnline, EConnectAndMoveMailSelectionAndDisconnect, EConnectAndMoveMailSelectionAndStayOnline, EConnectAndMoveNewMailAndDisconnect, EConnectAndMoveNewMailAndStayOnline, FinalProgress(), GetMailL(), ProgressL(), RunL(), TImPOP3GetMailType, ~CImPOP3GetMail()

Inherited from CActive:
Cancel(), Deque(), EPriorityHigh, EPriorityIdle, EPriorityLow, EPriorityStandard, EPriorityUserInput, IsActive(), IsAdded(), Priority(), RunError(), SetActive(), SetPriority(), TPriority, iStatus

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

Inherited from CMsvOperation:
Extension_(), Id(), Mtm(), Service(), SystemProgress(), iMsvSession, iMtm, iObserverRequestStatus, iService

IMPORT_C ~CImPOP3GetMail();

Description

Destructor.

IMPORT_C CMsvOperation *GetMailL(CPop3ClientMtm &aPop3ClientMtm, TRequestStatus &aObserverRequestStatus, const CMsvEntrySelection &aMsvEntrySelection, TDes8 &aPop3GetMailInfo, TImPOP3GetMailType aPOP3GetMailType);

Description

Creates and begins a new POP3 get mail operation.

Parameters

CPop3ClientMtm &aPop3ClientMtm A reference to the POP3 Client MTM that wants to perform the Get Mail operation. TRequestStatus &aObserverRequestStatus The status to be completed when the get mail operation has completed. 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. TDes8 &aPop3GetMailInfo A packaged TImPop3GetMailInfo object, which sets the maximum message size and the destination folder ID. TImPOP3GetMailType aPOP3GetMailType Type of operation to perform

Return value

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

virtual IMPORT_C const TDesC8 &FinalProgress();

Description

Gets information about a completed operation.

Return value

const TDesC8 & Packaged TPop3Progress holding progress information.

See also:

• TPop3Progress

virtual void DoCancel();

Description

Implements cancellation of an outstanding request.

This function is called as part of the active object's 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.

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

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

RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls RunError() 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 RunL() or RunError() functions.

virtual const TDesC8 &ProgressL();

Description

Gets information on the progress of the operation.

Return value

const TDesC8 & Packaged TPop3Progress holding progress information.

See also:

• TPop3Progress

TImPOP3GetMailType

Description

Defines types of get mail operation.

EConnectAndCopyNewMailAndStayOnline Connect and copy new mail and stay online. EConnectAndCopyNewMailAndDisconnect Connect and copy new mail and disconnect. EConnectAndMoveNewMailAndStayOnline Connect and move new mail and stay online. EConnectAndMoveNewMailAndDisconnect Connect and move new mail and disconnect. EConnectAndCopyMailSelectionAndStayOnline Connect and copy mail selection and stay online. EConnectAndCopyMailSelectionAndDisconnect Connect and copy mail selection and disconnect. EConnectAndMoveMailSelectionAndStayOnline Connect and move mail selection and stay online. EConnectAndMoveMailSelectionAndDisconnect Connect and move mail selection and disconnect. EConnectAndCopyAllMailAndStayOnline Connect and copy all mail and stay online. EConnectAndCopyAllMailAndDisconnect Connect and copy all mail and disconnect. EConnectAndMoveAllMailAndStayOnline Connect and move all mail and stay online. EConnectAndMoveAllMailAndDisconnect Connect and move all mail and disconnect.