MimeMessageLoad(ParserOptions, String, CancellationToken) Method

Load a MimeMessage from the specified file.

Definition

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

Parameters

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

Return Value

MimeMessage
The parsed message.

Remarks

Loads a MimeMessage from the file at the given path, using the specified ParserOptions.

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