MailSpoolGetStreamsAsync(Int32, Int32, Boolean, CancellationToken, ITransferProgress) Method

Asynchronously get the message or header streams within the specified range.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public abstract Task<IList<Stream>> GetStreamsAsync(
	int startIndex,
	int count,
	bool headersOnly = false,
	CancellationToken cancellationToken = default,
	ITransferProgress? progress = null
)

Parameters

startIndex  Int32
The index of the first stream to get.
count  Int32
The number of streams to get.
headersOnly  Boolean  (Optional)
if only the headers should be retrieved; otherwise, .
cancellationToken  CancellationToken  (Optional)
The cancellation token.
progress  ITransferProgress  (Optional)
The progress reporting mechanism.

Return Value

TaskIListStream
The messages.

Implements

IMailSpoolGetStreamsAsync(Int32, Int32, Boolean, CancellationToken, ITransferProgress)

Remarks

Asynchronously gets the message or header streams within the specified range.

Exceptions

ArgumentOutOfRangeException startIndex 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.

See Also