Click or drag to resize
MimeKit

MailSpoolGetStreams(IListInt32, Boolean, CancellationToken, ITransferProgress) Method

Get the message or header streams at the specified indexes.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.3.0
Syntax
C#
Copy
public abstract IList<Stream> GetStreams(
	IList<int> indexes,
	bool headersOnly = false,
	CancellationToken cancellationToken = default,
	ITransferProgress progress = null
)

Parameters

indexes  IListInt32
The indexes of the messages.
headersOnly  Boolean  (Optional)
true if only the headers should be retrieved; otherwise, false.
cancellationToken  CancellationToken  (Optional)
The cancellation token.
progress  ITransferProgress  (Optional)
The progress reporting mechanism.

Return Value

IListStream
The message or header streams.

Implements

IMailSpoolGetStreams(IListInt32, Boolean, CancellationToken, ITransferProgress)
Exceptions
ExceptionCondition
ArgumentNullExceptionindexes is null.
ArgumentException

One or more of the indexes are invalid.

-or-

No indexes were specified.

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

Get the message or header streams at the specified indexes.

If the mail server supports pipelining, this method will likely be more efficient than using GetStream(Int32, Boolean, CancellationToken, ITransferProgress) for each message because it will batch the commands to reduce latency.

See Also