 | MimeParser Class |
A MIME message and entity parser.
Inheritance HierarchyNamespace: MimeKit
Assembly: MimeKit (in MimeKit.dll) Version: 3.0.0
SyntaxC#
public class MimeParser : IEnumerable<MimeMessage>, IEnumerable
The MimeParser type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MimeParser(Stream, Boolean) |
Initialize a new instance of the MimeParser class.
|
| MimeParser(ParserOptions, Stream, Boolean) |
Initialize a new instance of the MimeParser class.
|
| MimeParser(Stream, MimeFormat, Boolean) |
Initialize a new instance of the MimeParser class.
|
| MimeParser(ParserOptions, Stream, MimeFormat, Boolean) |
Initialize a new instance of the MimeParser class.
|
Properties| Name | Description | |
|---|---|---|
 | IsEndOfStream |
Get a value indicating whether the parser has reached the end of the input stream.
|
| MboxMarker |
Get the most recent mbox marker.
|
| MboxMarkerOffset |
Get the most recent mbox marker offset.
|
| Options |
Get or set the parser options.
|
| Position |
Get the current position of the parser within the stream.
|
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.) |
| GetEnumerator |
Enumerate the messages in the stream.
|
| 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.) |
| OnMimeEntityBegin |
Invoked when the parser begins parsing a MimeEntity.
|
| OnMimeEntityEnd |
Invoked when the parser has completed parsing a MimeEntity.
|
| OnMimeMessageBegin |
Invoked when the parser begins parsing a MimeMessage.
|
| OnMimeMessageEnd |
Invoked when the parser has completed parsing a MimeMessage.
|
| ParseEntity |
Parse an entity from the stream.
|
| ParseEntityAsync |
Asynchronously parse an entity from the stream.
|
| ParseHeaders |
Parse a list of headers from the stream.
|
| ParseHeadersAsync |
Asynchronously parse a list of headers from the stream.
|
| ParseMessage |
Parse a message from the stream.
|
| ParseMessageAsync |
Asynchronously parse a message from the stream.
|
| SetStream(Stream, MimeFormat) |
Set the stream to parse.
|
| SetStream(Stream, Boolean) |
Set the stream to parse.
|
| SetStream(ParserOptions, Stream, Boolean) | Obsolete.
Set the stream to parse.
|
| SetStream(Stream, MimeFormat, Boolean) |
Set the stream to parse.
|
| SetStream(ParserOptions, Stream, MimeFormat, Boolean) | Obsolete.
Set the stream to parse.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | MimeEntityBegin |
An event signifying the beginning of a new MimeEntity has been encountered.
|
| MimeEntityEnd |
An event signifying the end of a MimeEntity has been encountered.
|
| MimeMessageBegin |
An event signifying the beginning of a new MimeMessage has been encountered.
|
| MimeMessageEnd |
An event signifying the end of a MimeMessage has been encountered.
|
Remarks
A MIME parser is used to parse MimeMessage and
MimeEntity objects from arbitrary streams.
See Also