TImap4GenericProgress Class Reference

#include <mw/imapset.h>

Link against: imcm.lib

class TImap4GenericProgress

Public Attributes
TInt	iBytesDone
TInt	iBytesToDo
TInt	iErrorCode
TImap4GenericProgressState	iImap4SubStateProgress
TInt	iMsgsDone
TInt	iMsgsToDo
TImap4GenericProgressOp	iOperation
TInt	iPartsDone
TInt	iPartsToDo
TMsvId	iReturnedMsvId
TImap4GenericProgressState	iState
TInt	iTotalSize
TImap4ProgressType	iType

Public Member Enumerations
enum	TImap4GenericProgressOp { EConnect, EDisconnect, ESync, ESelect, ..., EOffLinePopulate }
enum	TImap4GenericProgressState { EDisconnected, EConnecting, EIdle, ESelecting, ..., EPopulateMailSelection }

Public Member Functions
IMPORT_C TInt	ConnectionIAP()
IMPORT_C TInt	ConnectionState()

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

Member Attribute Documentation

iBytesDone

TInt	iBytesDone

Number of bytes (for a multipart fetch) processed.

iBytesToDo

TInt	iBytesToDo

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

iErrorCode

TInt	iErrorCode

Error code.

iImap4SubStateProgress

TImap4GenericProgressState

iImap4SubStateProgress

The progress sub-state.

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

iMsgsDone

TInt

iMsgsDone

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

iMsgsToDo

TInt

iMsgsToDo

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

iOperation

TImap4GenericProgressOp

iOperation

Operation type.

iPartsDone

TInt	iPartsDone

Number of message parts processed.

iPartsToDo

TInt	iPartsToDo

Number of message parts still to be processed.

iReturnedMsvId

TMsvId

iReturnedMsvId

Message ID returned from the operation.

iState

TImap4GenericProgressState

iState

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.

iTotalSize

TInt	iTotalSize

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

iType

TImap4ProgressType

iType

Progress information type: always EImap4GenericProgressType.

Member Enumeration Documentation

Enum TImap4GenericProgressOp

Operation type.

Enumerator	Value	Description
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.

Enum TImap4GenericProgressState

Operation state information.

Enumerator	Value	Description
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.

Member Function Documentation

ConnectionIAP ( )

IMPORT_C TInt

ConnectionIAP

(

)

const

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

Return Value: KErrNotFound if the IMAP4 service is not connecting, otherwise the internet access point number.

ConnectionState ( )

IMPORT_C TInt

ConnectionState

(

)

const

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