Click or drag to resize
MimeKit

MimeEntityWriteToAsync(FormatOptions, Stream, CancellationToken) Method

Asynchronously write the MimeEntity to the specified output stream.

Namespace: MimeKit
Assembly: MimeKit (in MimeKit.dll) Version: 4.7.1
Syntax
C#
public Task WriteToAsync(
	FormatOptions options,
	Stream stream,
	CancellationToken cancellationToken = default
)

Parameters

options  FormatOptions
The formatting options.
stream  Stream
The output stream.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

Task
An awaitable task.

Implements

IMimeEntityWriteToAsync(FormatOptions, Stream, CancellationToken)
Exceptions
ExceptionCondition
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.

See Also