MimeEntityLoad(String, CancellationToken) Method

Load a MimeEntity from the specified file.

Definition

Namespace: MimeKit
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
C#
public static MimeEntity Load(
	string fileName,
	CancellationToken cancellationToken = default
)

Parameters

fileName  String
The name of the file to load.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

MimeEntity
The parsed entity.

Remarks

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

Exceptions

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

See Also