Click or drag to resize
MimeKit

MimeReaderOnMboxMarkerReadAsync Method

Called when an Mbox marker is encountered in the stream.

Namespace:  MimeKit
Assembly:  MimeKit (in MimeKit.dll) Version: 3.0.0
Syntax
C#
protected virtual Task OnMboxMarkerReadAsync(
	byte[] buffer,
	int startIndex,
	int count,
	long beginOffset,
	int lineNumber,
	CancellationToken cancellationToken
)

Parameters

buffer
Type: SystemByte
The buffer containing the mbox marker.
startIndex
Type: SystemInt32
The index denoting the starting position of the mbox marker within the buffer.
count
Type: SystemInt32
The length of the mbox marker within the buffer, in bytes.
beginOffset
Type: SystemInt64
The offset into the stream where the mbox marker begins.
lineNumber
Type: SystemInt32
The line number where the mbox marker exists within the stream.
cancellationToken
Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: 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