CImPOP3GetMail Class Reference

#include <mw/popcmtm.h>

class CImPOP3GetMail

Detailed 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.

Member Enumeration Documentation

Enum TImPOP3GetMailType

Defines types of get mail operation.

EnumeratorValueDescription
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.

Constructor & Destructor Documentation

~CImPOP3GetMail ( )

IMPORT_C~CImPOP3GetMail()

Destructor.

Member Function Documentation

DoCancel ( )

voidDoCancel()

FinalProgress ( )

IMPORT_C const TDesC8 &FinalProgress()

Gets information about a completed operation.

See also: TPop3Progress

Return Value
Packaged TPop3Progress holding progress information.

GetMailL ( CPop3ClientMtm &, TRequestStatus &, const CMsvEntrySelection &, TDes8 &, TImPOP3GetMailType )

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

Creates and begins a new POP3 get mail operation.

Parameters
aPop3ClientMtmA reference to the POP3 Client MTM that wants to perform the Get Mail operation.
aObserverRequestStatusThe status to be completed when the get mail operation has completed.
aMsvEntrySelectionA selection of messages that need to be copied/moved to a local folder. The first entry in this selection MUST be the service.
aPop3GetMailInfoA packaged TImPop3GetMailInfo object, which sets the maximum message size and the destination folder ID.
aPOP3GetMailTypeType of operation to perform
Return Value
The new CImPOP3GetMail object through which the get operation can be controlled.

ProgressL ( )

const TDesC8 &ProgressL()

Gets information on the progress of the operation.

See also: TPop3Progress

Return Value
Packaged TPop3Progress holding progress information.

RunL ( )

voidRunL()