MimeParserOnMboxMarkerBeginAsync Method

Called when an Mbox marker is encountered in the stream.

Definition

Namespace: MimeKit
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
C#
protected virtual Task OnMboxMarkerBeginAsync(
	long beginOffset,
	int lineNumber,
	CancellationToken cancellationToken
)

Parameters

beginOffset  Int64
The offset into the stream where the mbox marker begins.
lineNumber  Int32
The line number where the mbox marker exists within the stream.
cancellationToken  CancellationToken
The cancellation token.

Return Value

Task
An asynchronous task context.

Remarks

When the stream is specified to be in Mbox format, this method will be called whenever the parser encounters an Mbox marker.

It is not necessary to override this method unless it is desirable to track the offsets of mbox markers within a stream or to extract the mbox marker itself.

See Also