Collapse all Symbian^3 Application Developer Library

TPop3Progress Class Reference

class TPop3Progress

Progress information for a POP3 operation.

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

Public Member Enumerations
enum	TPop3ProgressType { EPopRefreshing , EPopCopying , EPopDeleting , EPopConnecting , EPopTidying , EPopConnectedAndIdle , EPopDisconnecting , EPopDisconnected , EPopMoving , EPopCopyNewMail , EPopMoveNewMail , EPopCopyMailSelection , EPopMoveMailSelection , EPopCopyAllMail , EPopMoveAllMail , EPopPopulating , EPopCancellingOfflineOps , EPopTopPopulating , EPopMaxProgressValue = EPopTopPopulating }

Public Attributes
TInt	iBytesDone
TInt	iErrorCode
TInt	iMsgsToProcess
TPop3ProgressType	iPop3Progress
TPop3ProgressType	iPop3SubStateProgress
TMsvId	iServiceId
TInt	iTotalBytes
TInt	iTotalMsgs
TInt	iTotalSize

Member Functions Documentation

ConnectionIAP()

IMPORT_C TInt

ConnectionIAP

(

)

const

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 POP3 server.

Member Enumerations Documentation

Enum TPop3ProgressType

Defines types of POP3 operations.

Enumerators

EPopRefreshing	Refreshing view of remote mail box.
EPopCopying	Copying messages.
EPopDeleting	Deleting messages.
EPopConnecting	Connecting to remote mail box.
EPopTidying	Internal reorganisation.
EPopConnectedAndIdle	Connected to remote mail box and no current operations.
EPopDisconnecting	Disconnecting from remote mail box.
EPopDisconnected	Disconnected from remote mail box.
EPopMoving	Moving messages.
EPopCopyNewMail	Copying new messages.
EPopMoveNewMail	Moving new messages.
EPopCopyMailSelection	Copying a selection of messages.
EPopMoveMailSelection	Moving a selection of messages.
EPopCopyAllMail	Copying all messages.
EPopMoveAllMail	Moving all messages.
EPopPopulating	Populating view of remote mail box.
EPopCancellingOfflineOps	Cancelling all off-line operations.
EPopTopPopulating	Populating mailbox with top command
EPopMaxProgressValue = EPopTopPopulating	Defines the maximum value for this enumeration.

Member Data Documentation

TInt iBytesDone

TInt	iBytesDone

Number of bytes processed by the operation.

TInt iErrorCode

TInt	iErrorCode

Operation error code.

TInt iMsgsToProcess

TInt	iMsgsToProcess

Remaining number of messages to process.

TPop3ProgressType iPop3Progress

TPop3ProgressType

iPop3Progress

Type of operation for which progress is being reported.

TPop3ProgressType iPop3SubStateProgress

TPop3ProgressType

iPop3SubStateProgress

Type of the sub-operation, where a nested operations is occurring.

TMsvId iServiceId

TMsvId

iServiceId

Service performing the operation.

TInt iTotalBytes

TInt	iTotalBytes

When in the EPopConnecting state, this member holds the connection iap value. Otherwise it holds the total number of bytes to progress for the operation.

TInt iTotalMsgs

TInt	iTotalMsgs

When in the EPopConnecting state, this member holds the connection stage. Otherwise it holds the total number of messages for the operation.

TInt iTotalSize

TInt	iTotalSize

The total size of messages to be downloaded.