IMimeMessageWriteToAsync(FormatOptions, Stream, Boolean, CancellationToken) Method

Asynchronously write the message to the specified output stream.

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

Syntax

Task WriteToAsync(
	FormatOptions options,
	Stream stream,
	bool headersOnly,
	CancellationToken cancellationToken = default
)

options FormatOptions: The formatting options.
stream Stream: The output stream.
headersOnly Boolean: true if only the headers should be written; otherwise, false.
cancellationToken CancellationToken (Optional): The cancellation token.

Task
An awaitable task.

Exceptions

Exception	Condition
ArgumentNullException	options is null. -or- stream is null.
OperationCanceledException	The operation was canceled via the cancellation token.
IOException	An I/O error occurred.

Exception

Condition

options is null.

-or-

stream is null.

The operation was canceled via the cancellation token.

An I/O error occurred.

Remarks

Asynchronously writes the message to the output stream using the provided formatting options.