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(TInt,const CMsvEntrySelection &,TDes8 &,TRequestStatus &) 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 t...

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

Members

Defined in CImPOP3GetMail:

• DoCancel()Implements cancellation of an outstanding request.
• EConnectAndCopyAllMailAndDisconnectConnect and copy all mail and disconnect.
• EConnectAndCopyAllMailAndStayOnlineConnect and copy all mail and stay online.
• EConnectAndCopyMailSelectionAndDisconnectConnect and copy mail selection and disconnect.
• EConnectAndCopyMailSelectionAndStayOnlineConnect and copy mail selection and stay online.
• EConnectAndCopyNewMailAndDisconnectConnect and copy new mail and disconnect.
• EConnectAndCopyNewMailAndStayOnlineConnect and copy new mail and stay online.
• EConnectAndMoveAllMailAndDisconnectConnect and move all mail and disconnect.
• EConnectAndMoveAllMailAndStayOnlineConnect and move all mail and stay online.
• EConnectAndMoveMailSelectionAndDisconnectConnect and move mail selection and disconnect.
• EConnectAndMoveMailSelectionAndStayOnlineConnect and move mail selection and stay online.
• EConnectAndMoveNewMailAndDisconnectConnect and move new mail and disconnect.
• EConnectAndMoveNewMailAndStayOnlineConnect and move new mail and stay online.
• FinalProgress()Gets information about a completed operation.
• GetMailL(CPop3ClientMtm &,TRequestStatus &,const CMsvEntrySelection &,TDes8 &,TImPOP3GetMailType)Creates and begins a new POP3 get mail operation.
• ProgressL()Gets information on the progress of the operation.
• RunL()Handles an active object's request completion event.
• TImPOP3GetMailTypeDefines types of get mail operation.
• ~CImPOP3GetMail()Destructor.

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 ~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. CImPOP3GetMail::TImPOP3GetMailType aPOP3GetMailType Type of operation to perform

Return value

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

IMPORT_C virtual const TDesC8& FinalProgress();

Description

Gets information about a completed operation.

Return value

const TDesC8 & Packaged TPop3Progress holding progress information.

See also:

• TPop3ProgressProgress information for a POP3 operation.

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.

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

CImPOP3GetMail::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 CImPOP3GetMail::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 TPop3Progress holding progress information.

See also:

• TPop3ProgressProgress information for a POP3 operation.

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.