MimeEntityWriteToAsync(FormatOptions, Stream, Boolean, CancellationToken) Method

Asynchronously write the MimeEntity to the specified output stream.

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

Syntax

public virtual Task WriteToAsync(
	FormatOptions options,
	Stream stream,
	bool contentOnly,
	CancellationToken cancellationToken = default
)

options FormatOptions: The formatting options.
stream Stream: The output stream.
contentOnly Boolean: true if only the content 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.
ObjectDisposedException	The MimeEntity has been disposed.
OperationCanceledException	The operation was canceled via the cancellation token.
IOException	An I/O error occurred.

Remarks

Asynchronously writes the headers to the output stream, followed by a blank line.

Subclasses should override this method to write the content of the entity.