TImap4SyncProgress Class Reference

class TImap4SyncProgress

IMAP4 synchronisation progress information.

The client may then use an object of this type created by the server MTM to track synchronisation progress.

Member Enumerations Documentation

Enum TImap4SyncProgressState

Synchronisation state.

Enumerators

EIdle

Idle.

EBusy

Busy.

EConnecting

Connecting.

EDisconnecting

Disconnecting.

ESyncInbox

Synchronising inbox.

ESyncFolderTree

Synchronising folder tree.

ECheckRemoteSubscription

Checking remote subscription.

EUpdateRemoteSubscription

Updating remote subscription.

ESyncOther

Synchronising other information.

EDeleting

Deleting.

EProcessingPendingOps

Processing pending operations.

Member Data Documentation

TInt iErrorCode

TInt iErrorCode

Any error-code that the client needs to be informed of.

TInt iFoldersDone

TInt iFoldersDone

"Folders done" count for synchronisation. This is meaningful during the ESyncOther and EDeleting synchronisation stages.

TInt iFoldersNotFound

TInt iFoldersNotFound

Number of folders not found during synchronisation.

This can occur if the remote server returns an error when a client attempts to select a folder during synchronisation.

TInt iFoldersToDo

TInt iFoldersToDo

"Folders to do" count for synchronisation. This is meaningful during the ESyncOther and EDeleting synchronisation stages.

TInt iHeadersFetched

TInt iHeadersFetched

Number of headers fetched during synchronisation.

TInt iMessagePartsFetchedOK

TInt iMessagePartsFetchedOK

Number of message parts fetched during synchronisation.

In the current implementation, this is always 0.

TInt iMessagePartsNotFound

TInt iMessagePartsNotFound

Number of message parts not found during synchronisation.

In the current implementation, this is always 0.

TInt iMessagesFetchedOK

TInt iMessagesFetchedOK

Number of messages fetched during synchronisation.

In the current implementation, this is always 0. Use iHeadersFetched to get the number of headers fetched.

TInt iMsgsDone

TInt iMsgsDone

"Message done" count for synchronisation. This is meaningful during the ESyncInbox , ESyncOther and EProcessingPendingOps synchronisation stages.

TInt iMsgsToDo

TInt iMsgsToDo

"Message to do" count for synchronisation. This is meaningful during the ESyncInbox , ESyncOther and EProcessingPendingOps synchronisation stages.

TInt iNewFolders

TInt iNewFolders

Number of new folders during synchronisation.

TInt iOrphanedFolders

TInt iOrphanedFolders

Number of folders orphaned during synchronisation.

An orphaned folder is a local folder which existed under the service, but which did not exist on the remote server when synchronisation was done.

TInt iOrphanedMessages

TInt iOrphanedMessages

Number of orphaned messages during synchronisation.

An orphaned message is one which existed locally under the service, but which did not exist on the remote server when synchronisation was done.

TInt iRemoteMessagesDeleteTagged

TInt iRemoteMessagesDeleteTagged

Number of remote messages tagged for deletion.

In IMAP, messages can be flagged as deleted, before they are later permanently removed.

TImap4SyncProgressState iState

TImap4SyncProgressState iState

Synchronisation state.

TImap4ProgressType iType

TImap4ProgressType iType

Progress information type: always EImapSyncProgressType.