IMailSpoolGetStreamAsync Method

Asynchronously get the message or header stream at the specified index.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.7.1

Syntax

Task<Stream> GetStreamAsync(
	int index,
	bool headersOnly = false,
	CancellationToken cancellationToken = default,
	ITransferProgress progress = null
)

Parameters

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

TaskStream
The message or header stream.

Remarks

Asynchronously gets the message or header stream at the specified index.

Reference

IMailSpool Interface

MailKit Namespace