IStoreRequestOnProgress Method

Called when the server reports the progress of a command.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
void OnProgress(
	IMailFolder folder,
	long? processed,
	long? total
)

Parameters

folder  IMailFolder
The folder that the messages belong to.
processed  NullableInt64
The number of items processed so far, or if unknown.
total  NullableInt64
The total number of items to process, or if unknown.

Remarks

Called when the server reports the progress of the command that is updating the subset of messages most recently passed to OnStarted. Progress is reported per command, so if the operation is split into multiple commands, the progress will start over for each subset of messages.

The values are reported as-is from the server. The processed value may decrease or the total may change if the server discovers additional work. If the server is unable to count items, then it may report progress as a percentage, in which case total will be 100. If both values are , then the server has only indicated that the command is still in progress.

  Note

Progress is only reported by IMAP servers that support the INPROGRESS extension.

See Also