MimeEntityLoad(ParserOptions, Stream, CancellationToken) Method

Load a MimeEntity from the specified stream.

Definition

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

Parameters

options  ParserOptions
The parser options.
stream  Stream
The stream.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

MimeEntity
The parsed MIME entity.

Remarks

Loads a MimeEntity from the given stream, using the specified ParserOptions.

Exceptions

ArgumentNullException

options is .

-or-

stream is .

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