Class TImap4SyncProgress

class TImap4SyncProgress;

Description

IMAP4 synchronisation progress information.

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

Members

Defined in TImap4SyncProgress:

• EBusyBusy.
• ECheckRemoteSubscriptionChecking remote subscription.
• EConnectingConnecting.
• EDeletingDeleting.
• EDisconnectingDisconnecting.
• EIdleIdle.
• EProcessingPendingOpsProcessing pending operations.
• ESyncFolderTreeSynchronising folder tree.
• ESyncInboxSynchronising inbox.
• ESyncOtherSynchronising other information.
• EUpdateRemoteSubscriptionUpdating remote subscription.
• TImap4SyncProgressStateSynchronisation state.
• iErrorCodeAny error-code that the client needs to be informed of.
• iFoldersDone"Folders done" count for synchronisation. This is meaningful during th...
• iFoldersNotFoundNumber of folders not found during synchronisation.
• iFoldersToDo"Folders to do" count for synchronisation. This is meaningful during t...
• iHeadersFetchedNumber of headers fetched during synchronisation.
• iMessagePartsFetchedOKNumber of message parts fetched during synchronisation.
• iMessagePartsNotFoundNumber of message parts not found during synchronisation.
• iMessagesFetchedOKNumber of messages fetched during synchronisation.
• iMsgsDone"Message done" count for synchronisation. This is meaningful during th...
• iMsgsToDo"Message to do" count for synchronisation. This is meaningful during t...
• iNewFoldersNumber of new folders during synchronisation.
• iOrphanedFoldersNumber of folders orphaned during synchronisation.
• iOrphanedMessagesNumber of orphaned messages during synchronisation.
• iRemoteMessagesDeleteTaggedNumber of remote messages tagged for deletion.
• iStateSynchronisation state.
• iTypeProgress information type: always EImapSyncProgressType.

TImap4SyncProgressState

Description

Synchronisation state.

TImap4ProgressType iType;

Description

Progress information type: always EImapSyncProgressType.

TImap4SyncProgressState iState;

Description

Synchronisation state.

TInt iFoldersToDo;

Description

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

TInt iFoldersDone;

Description

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

TInt iMsgsToDo;

Description

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

TInt iMsgsDone;

Description

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

TInt iHeadersFetched;

Description

Number of headers fetched during synchronisation.

TInt iOrphanedFolders;

Description

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 iNewFolders;

Description

Number of new folders during synchronisation.

TInt iOrphanedMessages;

Description

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;

Description

Number of remote messages tagged for deletion.

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

TInt iMessagesFetchedOK;

Description

Number of messages fetched during synchronisation.

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

TInt iMessagePartsFetchedOK;

Description

Number of message parts fetched during synchronisation.

In the current implementation, this is always 0.

TInt iMessagePartsNotFound;

Description

Number of message parts not found during synchronisation.

In the current implementation, this is always 0.

TInt iFoldersNotFound;

Description

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 iErrorCode;

Description

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