MimeReader Class

A MIME message and entity reader.

Inheritance Hierarchy

SystemObject
MimeKitMimeReader
MimeKitExperimentalMimeParser

Namespace: MimeKit
Assembly: MimeKit (in MimeKit.dll) Version: 3.0.0

Syntax

Copy

public class MimeReader

The MimeReader type exposes the following members.

Constructors

	Name	Description
	MimeReader(Stream, MimeFormat)	Initialize a new instance of the MimeReader class.
	MimeReader(ParserOptions, Stream, MimeFormat)	Initialize a new instance of the MimeReader class.

Top

Properties

	Name	Description
	IsEndOfStream	Get a value indicating whether the parser has reached the end of the input stream.
	Options	Get the parser options.
	Position	Get the current position of the parser within the stream.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnHeaderRead	Called when a message or MIME part header is read from the stream.
	OnHeaderReadAsync	Called when a message or MIME part header is read from the stream.
	OnHeadersBegin	Called when the beginning of a list of headers is encountered in the stream.
	OnHeadersBeginAsync	Called when the beginning of a list of headers is encountered in the stream.
	OnHeadersEnd	Called when the end of a list of headers is encountered in the stream.
	OnHeadersEndAsync	Called when the end of a list of headers is encountered in the stream.
	OnMboxMarkerRead	Called when an Mbox marker is encountered in the stream.
	OnMboxMarkerReadAsync	Called when an Mbox marker is encountered in the stream.
	OnMessagePartBegin	Called when the beginning of a message part is encountered in the stream.
	OnMessagePartBeginAsync	Called when the beginning of a message part is encountered in the stream.
	OnMessagePartEnd	Called when the end of a message part is encountered in the stream.
	OnMessagePartEndAsync	Called when the end of a message part is encountered in the stream.
	OnMimeMessageBegin	Called when the beginning of a message is encountered in the stream.
	OnMimeMessageBeginAsync	Called when the beginning of a message is encountered in the stream.
	OnMimeMessageEnd	Called when the end of a message is encountered in the stream.
	OnMimeMessageEndAsync	Called when the end of a message is encountered in the stream.
	OnMimePartBegin	Called when the beginning of a MIME part is encountered in the stream.
	OnMimePartBeginAsync	Called when the beginning of a MIME part is encountered in the stream.
	OnMimePartContentBegin	Called when the beginning of a MIME part's content is encountered in the stream.
	OnMimePartContentBeginAsync	Called when the beginning of a MIME part's content is encountered in the stream.
	OnMimePartContentEnd	Called when the end of a MIME part's content is encountered in the stream.
	OnMimePartContentEndAsync	Called when the end of a MIME part's content is encountered in the stream.
	OnMimePartContentRead	Called when MIME part content is read from the stream.
	OnMimePartContentReadAsync	Called when MIME part content is read from the stream.
	OnMimePartEnd	Called when the end of a MIME part is encountered in the stream.
	OnMimePartEndAsync	Called when the end of a MIME part is encountered in the stream.
	OnMultipartBegin	Called when the beginning of a multipart is encountered in the stream.
	OnMultipartBeginAsync	Called when the beginning of a multipart is encountered in the stream.
	OnMultipartBoundary	Called when a multipart boundary is encountered in the stream.
	OnMultipartBoundaryAsync	Called when a multipart boundary is encountered in the stream.
	OnMultipartEnd	Called when the end of a multipart is encountered in the stream.
	OnMultipartEndAsync	Called when the end of a multipart is encountered in the stream.
	OnMultipartEndBoundary	Called when a multipart end boundary is encountered in the stream.
	OnMultipartEndBoundaryAsync	Called when a multipart end boundary is encountered in the stream.
	OnMultipartEpilogueBegin	Called when the beginning of the epilogue of a multipart is encountered in the stream.
	OnMultipartEpilogueBeginAsync	Called when the beginning of the epilogue of a multipart is encountered in the stream.
	OnMultipartEpilogueEnd	Called when the end of the epilogue of a multipart is encountered in the stream.
	OnMultipartEpilogueEndAsync	Called when the end of the epilogue of a multipart is encountered in the stream.
	OnMultipartEpilogueRead	Called when multipart epilogue text is read from the stream.
	OnMultipartEpilogueReadAsync	Called when multipart epilogue text is read from the stream.
	OnMultipartPreambleBegin	Called when the beginning of the preamble of a multipart is encountered in the stream.
	OnMultipartPreambleBeginAsync	Called when the beginning of the preamble of a multipart is encountered in the stream.
	OnMultipartPreambleEnd	Called when the end of the preamble of a multipart is encountered in the stream.
	OnMultipartPreambleEndAsync	Called when the end of the preamble of a multipart is encountered in the stream.
	OnMultipartPreambleRead	Called when multipart preamble text is read from the stream.
	OnMultipartPreambleReadAsync	Called when multipart preamble text is read from the stream.
	ReadEntity	Read an entity from the stream.
	ReadEntityAsync	Asynchronously read an entity from the stream.
	ReadHeaders	Read a block of headers from the stream.
	ReadHeadersAsync	Asynchronously read a block of headers from the stream.
	ReadMessage	Read a message from the stream.
	ReadMessageAsync	Asynchronously read a message from the stream.
	SetStream	Set the stream to parse.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

MimeReader provides forward-only, read-only access to MIME data in a stream.

Reference

MimeKit Namespace