Class TImap4GenericProgress

class TImap4GenericProgress;

Description

Progress information for an IMAP4 get operation.

For the 'get mail when already connected' operations, the progress state can be obtained from TImap4GenericProgress::iState. In the case of the 'connect and get mail and disconnect' and 'connect and get mail and stay online', the actual progress defined in TImap4GenericProgress::iState will be of the form of 'Copy New Mail', 'Populating Message Selection' etc. The sub-operation state can then be obtained in the form of 'Connecting', 'Fetching', 'Disconnecting' etc. from TImap4GenericProgress::iImap4SubStateProgress.

Members

Defined in TImap4GenericProgress:
ConnectionIAP(), ConnectionState(), EAppending, EBusy, EConnect, EConnecting, ECopyAllMail, ECopyFromLocal, ECopyMailSelection, ECopyNewMail, ECopyToLocal, ECopyWithinService, ECopying, EDelete, EDeleting, EDisconnect, EDisconnected, EDisconnecting, EFetching, EIdle, EMoveAllMail, EMoveFromLocal, EMoveMailSelection, EMoveNewMail, EMoveToLocal, EMoveWithinService, EMoving, EOffLineCopyFromLocal, EOffLineCopyToLocal, EOffLineCopyWithinService, EOffLineDelete, EOffLineMoveFromLocal, EOffLineMoveToLocal, EOffLineMoveWithinService, EOffLinePopulate, EOffLineUndelete, EPopulate, EPopulateAllMail, EPopulateMailSelection, EPopulateNewMail, ESelect, ESelecting, ESync, ESyncing, TImap4GenericProgressOp, TImap4GenericProgressState, iBytesDone, iBytesToDo, iErrorCode, iImap4SubStateProgress, iMsgsDone, iMsgsToDo, iOperation, iPartsDone, iPartsToDo, iReturnedMsvId, iState, iTotalSize, iType

See also:

• CImImap4GetMail

IMPORT_C TInt ConnectionState() const;

Description

Retrieves the stage of the connection process as defined in nifvar.h and csdprog.h while the service is connecting to the IMAP4 server.

Return value

TInt KLinkLayerOpen if the IMAP4 service has successfully connected, or KErrNotFound if the IMAP4 service is disconnected, or the current connection stage (declared in nifvar.h and csdprog.h) while establishing a connection.

IMPORT_C TInt ConnectionIAP() const;

Description

Retrieves the internet access point that is used when connecting to the IMAP4 service.

Return value

TInt KErrNotFound if the IMAP4 service is not connecting, otherwise the internet access point number.

TImap4GenericProgressOp

Description

Operation type.

EConnect Connect operation. EDisconnect Disconnect operation. ESync Sync operation. ESelect Select operation. ECopyToLocal Copy messages to local operation. ECopyWithinService Copy messages within remote server operation. ECopyFromLocal Copy messages from local operation. EMoveToLocal Move messages to local operation. EMoveWithinService Move messages within remote server operation. EMoveFromLocal Move messages from local operation. EPopulate Message population operation. EDelete Delete operation. EOffLineDelete Offline delete operation. EOffLineUndelete Offline undelete operation. EOffLineCopyToLocal Offline delete operation. EOffLineMoveToLocal Offline move messages to local operation. EOffLineCopyFromLocal Offline copy messages from local operation. EOffLineMoveFromLocal Offline move messages from local operation. EOffLineCopyWithinService Offline copy messages within remote server operation. EOffLineMoveWithinService Offline move messages within remote server operation. EOffLinePopulate Offline message population operation.

TImap4GenericProgressState

Description

Operation state information.

EDisconnected Disconnected. EConnecting Connecting. EIdle Idle. ESelecting Selecting the folder to use. EFetching Fetching messages to mirror server. EAppending Appending local messages to remote server. ECopying Copying local messages to local or within service. EDeleting Deleting an item, including expunging a folder. ESyncing Synchronising folder after an operation. EDisconnecting Disconnecting. EBusy Sync already in progress. EMoving CImImap4GetMail move operation in progress. ECopyNewMail CImImap4GetMail copy new mail operation in progress. EMoveNewMail CImImap4GetMail move new mail operation in progress. ECopyMailSelection CImImap4GetMail copy selected messages operation in progress. EMoveMailSelection CImImap4GetMail move selected messages operation in progress. ECopyAllMail CImImap4GetMail copy all messages operation in progress. EMoveAllMail CImImap4GetMail move all messages operation in progress. EPopulateNewMail CImImap4GetMail populate new messages operation in progress. EPopulateAllMail CImImap4GetMail populate all messages operation in progress. EPopulateMailSelection CImImap4GetMail populate selected messages operation in progress.

TImap4ProgressType iType;

Description

Progress information type: always EImap4GenericProgressType.

TImap4GenericProgressOp iOperation;

Description

Operation type.

TImap4GenericProgressState iState;

Description

The progress state.

For 'connect and get mail and disconnect' and 'connect and get mail and stay online' type operations, additional sub-operation state can be obtained from iImap4SubStateProgress.

TImap4GenericProgressState iImap4SubStateProgress;

Description

The progress sub-state.

This only applies to 'connect and get mail and disconnect' and 'connect and get mail and stay online' type operations.

TInt iMsgsToDo;

Description

In the EConnecting state, this field holds the connection iap value, otherwise it holds the number of messages still to be processed.

TInt iMsgsDone;

Description

In the EConnecting state, this field holds the connection stage value, otherwise it holds the number of messages processed.

TInt iPartsToDo;

Description

Number of message parts still to be processed.

TInt iPartsDone;

Description

Number of message parts processed.

TInt iBytesToDo;

Description

Number of bytes (for a multipart fetch) still to be processed.

TInt iBytesDone;

Description

Number of bytes (for a multipart fetch) processed.

TInt iErrorCode;

Description

Error code.

TMsvId iReturnedMsvId;

Description

Message ID returned from the operation.

TInt iTotalSize;

Description

The total size of messages to be downloaded (bytes).