Progress Event

Description

Fires when a method has completed, the server has sent a reply, or progress information is available.

Syntax

Visual Basic
Public Event Progress( _ ByVal Method As ImapMethodConstants, _ ByVal Status As ImapStatusConstants, _ ByVal Reply As String, _ ByVal MessageNumber As Long, _ ByVal Count As Long, _ ByVal Size As Long _ )

Visual Basic

Public Event Progress( _
   ByVal Method As ImapMethodConstants, _
   ByVal Status As ImapStatusConstants, _
   ByVal Reply As String, _
   ByVal MessageNumber As Long, _
   ByVal Count As Long, _
   ByVal Size As Long _
)

Parameters

Method

Value	Description
imapCommand	Command method.
imapCopy	Copy method.
imapDelete	Delete method.
imapGet	Get method.
imapIdle	Idle.
imapLogin	Login method.
imapLogout	Logout method.
imapMailboxAdd	Mailbox Add method.
imapMailboxesAdd	Mailboxes Add method.
imapMailboxesRefresh	Refresh method.
imapMailboxRefresh	Mailbox Refresh method.
imapPurge	Purge method.
imapPut	Put method.
imapRemove	Remove method.
imapRename	Rename.
imapSearch	Search method.
imapSubscribe	Subscribe method.
imapUndelete	Undelete method.
imapUnknown	Unknown command.
imapUnsubscribe	Unsubscribe method.

Indicates the method that the event pertains to.

Status

Value	Description
imapBad	Server has responded with a status indicating bad syntax.
imapBye	Server has indicated that it is about to close the connection.
imapContent	Indicates intermediate events during the receipt of a mail message. Useful for percentage indication on a status display.
imapInfo	Server has supplied information.
imapNo	Server has responded with a negative status.
imapOk	Method has completed with a positive status.

Indicates the status of the method.

Reply

Specifies the server reply related to the status.

MessageNumber

Specifies the server-side message the event pertains to. This value corresponds to the message's Attribute(msgNumber) property.

Count

Specifies the number of bytes that have been received (so far) for the transfer that is currently in progress. The value normally falls between 0 and Size. Only valid when Status is imapContent, and is 0 at other times.

Size

Specifies the total number of bytes in the message transfer currently in progress. This value is constant during any single transfer. Only valid when Status is imapContent, and is 0 at other times.

Remarks

Use the Trace method to gather protocol-level data if Reply is inadequate.

Example

Imap Object