MailSpoolGetStream Method

Get the message or header stream at the specified index.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public abstract Stream GetStream(
	int index,
	bool headersOnly = false,
	CancellationToken cancellationToken = default,
	ITransferProgress? progress = null
)

Parameters

index  Int32
The index of the message.
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

Stream
The message or header stream.

Implements

IMailSpoolGetStream(Int32, Boolean, CancellationToken, ITransferProgress)

Remarks

Gets the message or header stream at the specified index.

Exceptions

ArgumentOutOfRangeException index is not a valid message index.
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