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()constRetrieves the internet access point that is used when connecting to the IMAP4 se...
• ConnectionState()constRetrieves the stage of the connection process as defined in nifvar.h and csdprog...
• EAppendingAppending local messages to remote server.
• EBusySync already in progress.
• EConnectConnect operation.
• EConnectingConnecting.
• ECopyAllMail CImImap4GetMail copy all messages operation in progress.
• ECopyFromLocalCopy messages from local operation.
• ECopyMailSelection CImImap4GetMail copy selected messages operation in progress.
• ECopyNewMail CImImap4GetMail copy new mail operation in progress.
• ECopyToLocalCopy messages to local operation.
• ECopyWithinServiceCopy messages within remote server operation.
• ECopyingCopying local messages to local or within service.
• EDeleteDelete operation.
• EDeletingDeleting an item, including expunging a folder.
• EDisconnectDisconnect operation.
• EDisconnectedDisconnected.
• EDisconnectingDisconnecting.
• EFetchingFetching messages to mirror server.
• EIdleIdle.
• EMoveAllMail CImImap4GetMail move all messages operation in progress.
• EMoveFromLocalMove messages from local operation.
• EMoveMailSelection CImImap4GetMail move selected messages operation in progress.
• EMoveNewMail CImImap4GetMail move new mail operation in progress.
• EMoveToLocalMove messages to local operation.
• EMoveWithinServiceMove messages within remote server operation.
• EMoving CImImap4GetMail move operation in progress.
• EOffLineCopyFromLocalOffline copy messages from local operation.
• EOffLineCopyToLocalOffline delete operation.
• EOffLineCopyWithinServiceOffline copy messages within remote server operation.
• EOffLineDeleteOffline delete operation.
• EOffLineMoveFromLocalOffline move messages from local operation.
• EOffLineMoveToLocalOffline move messages to local operation.
• EOffLineMoveWithinServiceOffline move messages within remote server operation.
• EOffLinePopulateOffline message population operation.
• EOffLineUndeleteOffline undelete operation.
• EPopulateMessage population operation.
• EPopulateAllMail CImImap4GetMail populate all messages operation in progress.
• EPopulateMailSelection CImImap4GetMail populate selected messages operation in progress.
• EPopulateNewMail CImImap4GetMail populate new messages operation in progress.
• ESelectSelect operation.
• ESelectingSelecting the folder to use.
• ESyncSync operation.
• ESyncingSynchronising folder after an operation.
• TImap4GenericProgressOpOperation type.
• TImap4GenericProgressStateOperation state information.
• iBytesDoneNumber of bytes (for a multipart fetch) processed.
• iBytesToDoNumber of bytes (for a multipart fetch) still to be processed.
• iErrorCodeError code.
• iImap4SubStateProgressThe progress sub-state.
• iMsgsDoneIn the EConnecting state, this field holds the connection stage value, otherwise...
• iMsgsToDoIn the EConnecting state, this field holds the connection iap value, otherwise i...
• iOperationOperation type.
• iPartsDoneNumber of message parts processed.
• iPartsToDoNumber of message parts still to be processed.
• iReturnedMsvIdMessage ID returned from the operation.
• iStateThe progress state.
• iTotalSizeThe total size of messages to be downloaded (bytes).
• iTypeProgress information type: always EImap4GenericProgressType.

See also:

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

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

IMPORT_C TInt ConnectionIAP() const;

Description

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

Return value

TImap4GenericProgressOp

Description

Operation type.

TImap4GenericProgressState

Description

Operation state information.

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