IMimeEntityWriteTo(FormatOptions, String, CancellationToken) Method

Write the IMimeEntity to the specified file.

Definition

Namespace: MimeKit
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
C#
void WriteTo(
	FormatOptions options,
	string fileName,
	CancellationToken cancellationToken = default
)

Parameters

options  FormatOptions
The formatting options.
fileName  String
The file.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Remarks

Writes the entity to the specified file using the provided formatting options.

Exceptions

ArgumentNullException

options is .

-or-

fileName is .
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.

See Also