Symbian
Symbian OS Library

SYMBIAN OS V9.3

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



Location: POP3SET.H
Link against: imcm.lib

Class TPop3Progress

class TPop3Progress;

Description

Progress information for a POP3 operation.

Members

Defined in TPop3Progress:
ConnectionIAP(), ConnectionState(), EPopCancellingOfflineOps, EPopConnectedAndIdle, EPopConnecting, EPopCopyAllMail, EPopCopyMailSelection, EPopCopyNewMail, EPopCopying, EPopDeleting, EPopDisconnected, EPopDisconnecting, EPopMaxProgressValue, EPopMoveAllMail, EPopMoveMailSelection, EPopMoveNewMail, EPopMoving, EPopPopulating, EPopRefreshing, EPopTidying, EPopTopPopulating, TPop3ProgressType, iBytesDone, iErrorCode, iMsgsToProcess, iPop3Progress, iPop3SubStateProgress, iServiceId, iTotalBytes, iTotalMsgs, iTotalSize


Member functions


ConnectionState()

IMPORT_C TInt ConnectionState() const;

Description

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

TInt

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.


ConnectionIAP()

IMPORT_C TInt ConnectionIAP() const;

Description

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

Return value

TInt

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

[Top]


Member enumerations


Enum TPop3ProgressType

TPop3ProgressType

Description

Defines types of POP3 operations.

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

Defines the maximum value for this enumeration.

[Top]


Member data


iPop3Progress

TPop3ProgressType iPop3Progress;

Description

Type of operation for which progress is being reported.


iTotalMsgs

TInt iTotalMsgs;

Description

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


iMsgsToProcess

TInt iMsgsToProcess;

Description

Remaining number of messages to process.


iBytesDone

TInt iBytesDone;

Description

Number of bytes processed by the operation.


iTotalBytes

TInt iTotalBytes;

Description

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.


iErrorCode

TInt iErrorCode;

Description

Operation error code.


iPop3SubStateProgress

TPop3ProgressType iPop3SubStateProgress;

Description

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


iServiceId

TMsvId iServiceId;

Description

Service performing the operation.


iTotalSize

TInt iTotalSize;

Description

The total size of messages to be downloaded.