MimeEntityLoadAsync(String, CancellationToken) Method

Asynchronously load a MimeEntity from the specified file.

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

Syntax

public static Task<MimeEntity> LoadAsync(
	string fileName,
	CancellationToken cancellationToken = default
)

TaskMimeEntity
The parsed entity.

Exceptions

Exception	Condition
ArgumentNullException	fileName is null.
ArgumentException	fileName is a zero-length string, contains only white space, or contains one or more invalid characters.
DirectoryNotFoundException	fileName is an invalid file path.
FileNotFoundException	The specified file path could not be found.
UnauthorizedAccessException	The user does not have access to read the specified file.
OperationCanceledException	The operation was canceled via the cancellation token.
FormatException	There was an error parsing the entity.
IOException	An I/O error occurred.

Remarks

Loads a MimeEntity from the file at the give file path, using the default ParserOptions.