Click or drag to resize
MimeKit

MailSpoolGetMessagesAsync(Int32, Int32, CancellationToken, ITransferProgress) Method

Asynchronously get the messages within the specified range.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.3.0
Syntax
C#
Copy
public abstract Task<IList<MimeMessage>> GetMessagesAsync(
	int startIndex,
	int count,
	CancellationToken cancellationToken = default,
	ITransferProgress progress = null
)

Parameters

startIndex  Int32
The index of the first message to get.
count  Int32
The number of messages to get.
cancellationToken  CancellationToken  (Optional)
The cancellation token.
progress  ITransferProgress  (Optional)
The progress reporting mechanism.

Return Value

TaskIListMimeMessage
The messages.

Implements

IMailSpoolGetMessagesAsync(Int32, Int32, CancellationToken, ITransferProgress)
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionstartIndex and count do not specify a valid range of messages.
ObjectDisposedException The MailSpool has been disposed.
ServiceNotConnectedException The MailSpool is not connected.
ServiceNotAuthenticatedException The MailSpool is not authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
IOException An I/O error occurred.
CommandException The command failed.
ProtocolException A protocol error occurred.
Remarks
Asynchronously gets the messages within the specified range.
See Also