TPop3Progress Class Reference

#include <mw/pop3set.h>

Link against: imcm.lib

class TPop3Progress

Detailed Description

Progress information for a POP3 operation.

Member Attribute Documentation

iBytesDone

TInt iBytesDone

Number of bytes processed by the operation.

iErrorCode

TInt iErrorCode

Operation error code.

iMsgsToProcess

TInt iMsgsToProcess

Remaining number of messages to process.

iPop3Progress

TPop3ProgressType iPop3Progress

Type of operation for which progress is being reported.

iPop3SubStateProgress

TPop3ProgressType iPop3SubStateProgress

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

iServiceId

TMsvId iServiceId

Service performing the operation.

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.

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.

iTotalSize

TInt iTotalSize

The total size of messages to be downloaded.

Member Enumeration Documentation

Enum TPop3ProgressType

Defines types of POP3 operations.

EnumeratorValueDescription
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

EPopMaxProgressValueEPopTopPopulating

Defines the maximum value for this enumeration.

Member Function Documentation

ConnectionIAP ( )

IMPORT_C TIntConnectionIAP()const

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

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

ConnectionState ( )

IMPORT_C TIntConnectionState()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.

Return Value
KLinkLayerOpen if the POP3 service has successfully connected, or KErrNotFound if the POP3 service is disconnected, or the current connection stage (declared in nifvar.h and csdprog.h) while establishing a connection.