IMimeEntityWriteToAsync(FormatOptions, String, Boolean, CancellationToken) Method

Asynchronously write the IMimeEntity to the specified file.

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

Syntax

Task WriteToAsync(
	FormatOptions options,
	string fileName,
	bool contentOnly,
	CancellationToken cancellationToken = default
)

options FormatOptions: The formatting options.
fileName String: The file.
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- fileName is null.
ArgumentException	fileName is a zero-length string, contains only white space, or contains one or more invalid characters.
ObjectDisposedException	The IMimeEntity has been disposed.
OperationCanceledException	The operation was canceled via the cancellation token.
DirectoryNotFoundException	fileName is an invalid file path.
FileNotFoundException	The specified file path could not be found.
UnauthorizedAccessException	The user does not have access to write to the specified file.
IOException	An I/O error occurred.

Remarks

Asynchronously writes the entity to the specified file using the provided formatting options.