MailKit Documentation

MimeParser Class

A MIME message and entity parser.

👁 Image
Inheritance Hierarchy

SystemObject
MimeKitMimeParser

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

public class MimeParser : IMimeParser, IEnumerable<MimeMessage>, 
	IEnumerable

The MimeParser type exposes the following members.

👁 Image
Constructors

	Name	Description
👁 Public method	MimeParser(Stream, Boolean)	Initialize a new instance of the MimeParser class.
👁 Public method	MimeParser(ParserOptions, Stream, Boolean)	Initialize a new instance of the MimeParser class.
👁 Public method 👁 Code example	MimeParser(Stream, MimeFormat, Boolean)	Initialize a new instance of the MimeParser class.
👁 Public method	MimeParser(ParserOptions, Stream, MimeFormat, Boolean)	Initialize a new instance of the MimeParser class.

Top

👁 Image
Properties

	Name	Description
👁 Public property 👁 Code example	IsEndOfStream	Get a value indicating whether the parser has reached the end of the input stream.
👁 Public property 👁 Code example	MboxMarker	Get the mbox marker for the most recently parsed message.
👁 Public property 👁 Code example	MboxMarkerOffset	Get the mbox marker stream offset for the most recently parsed message.
👁 Public property	Options	Get or set the parser options.
👁 Public property	Position	Get the current position of the parser within the stream.

Top

👁 Image
Methods

	Name	Description
👁 Public method	Equals	(Inherited from Object)
👁 Protected method	Finalize	(Inherited from Object)
👁 Public method	GetEnumerator	Enumerate the messages in the stream.
👁 Public method	GetHashCode	(Inherited from Object)
👁 Public method	GetType	(Inherited from Object)
👁 Protected method	MemberwiseClone	(Inherited from Object)
👁 Protected method	OnMimeEntityBegin	Invoked when the parser begins parsing a MimeEntity.
👁 Protected method	OnMimeEntityEnd	Invoked when the parser has completed parsing a MimeEntity.
👁 Protected method	OnMimeMessageBegin	Invoked when the parser begins parsing a MimeMessage.
👁 Protected method	OnMimeMessageEnd	Invoked when the parser has completed parsing a MimeMessage.
👁 Public method	ParseEntity	Parse an entity from the stream.
👁 Public method	ParseEntityAsync	Asynchronously parse an entity from the stream.
👁 Public method	ParseHeaders	Parse a list of headers from the stream.
👁 Public method	ParseHeadersAsync	Asynchronously parse a list of headers from the stream.
👁 Public method 👁 Code example	ParseMessage	Parse a message from the stream.
👁 Public method	ParseMessageAsync	Asynchronously parse a message from the stream.
👁 Public method	SetStream(Stream, MimeFormat)	Set the stream to parse.
👁 Public method	SetStream(Stream, Boolean)	Set the stream to parse.
👁 Public method	SetStream(ParserOptions, Stream, Boolean)	Set the stream to parse. Obsolete
👁 Public method	SetStream(Stream, MimeFormat, Boolean)	Set the stream to parse.
👁 Public method	SetStream(ParserOptions, Stream, MimeFormat, Boolean)	Set the stream to parse. Obsolete
👁 Public method	ToString	(Inherited from Object)

Top

👁 Image
Events

	Name	Description
👁 Public event 👁 Code example	MimeEntityBegin	An event signifying the beginning of a new MimeEntity has been encountered.
👁 Public event 👁 Code example	MimeEntityEnd	An event signifying the end of a MimeEntity has been encountered.
👁 Public event 👁 Code example	MimeMessageBegin	An event signifying the beginning of a new MimeMessage has been encountered.
👁 Public event 👁 Code example	MimeMessageEnd	An event signifying the end of a MimeMessage has been encountered.

Top

👁 Image
Remarks

A MIME parser is used to parse MimeMessage and MimeEntity objects from arbitrary streams.

👁 Image
See Also

Reference

MimeKit Namespace

Send comments on this topic to Jeffrey Stedfast

URL: https://mimekit.net/docs/html/T_MimeKit_MimeParser.htm

⇱ MimeParser Class

MimeParser Class

Reference