Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: IMAPSET.H

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:
EBusy, ECheckRemoteSubscription, EConnecting, EDeleting, EDisconnecting, EIdle, EProcessingPendingOps, ESyncFolderTree, ESyncInbox, ESyncOther, EUpdateRemoteSubscription, TImap4SyncProgressState, iErrorCode, iFoldersDone, iFoldersNotFound, iFoldersToDo, iHeadersFetched, iMessagePartsFetchedOK, iMessagePartsNotFound, iMessagesFetchedOK, iMsgsDone, iMsgsToDo, iNewFolders, iOrphanedFolders, iOrphanedMessages, iRemoteMessagesDeleteTagged, iState, iType


Member enumerations


Enum TImap4SyncProgressState

TImap4SyncProgressState

Description

Synchronisation state.

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.

[Top]


Member data


iType

TImap4ProgressType iType;

Description

Progress information type: always EImapSyncProgressType.


iState

TImap4SyncProgressState iState;

Description

Synchronisation state.


iFoldersToDo

TInt iFoldersToDo;

Description

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


iFoldersDone

TInt iFoldersDone;

Description

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


iMsgsToDo

TInt iMsgsToDo;

Description

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


iMsgsDone

TInt iMsgsDone;

Description

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


iHeadersFetched

TInt iHeadersFetched;

Description

Number of headers fetched during synchronisation.


iOrphanedFolders

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.


iNewFolders

TInt iNewFolders;

Description

Number of new folders during synchronisation.


iOrphanedMessages

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.


iRemoteMessagesDeleteTagged

TInt iRemoteMessagesDeleteTagged;

Description

Number of remote messages tagged for deletion.

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


iMessagesFetchedOK

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.


iMessagePartsFetchedOK

TInt iMessagePartsFetchedOK;

Description

Number of message parts fetched during synchronisation.

In the current implementation, this is always 0.


iMessagePartsNotFound

TInt iMessagePartsNotFound;

Description

Number of message parts not found during synchronisation.

In the current implementation, this is always 0.


iFoldersNotFound

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.


iErrorCode

TInt iErrorCode;

Description

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