Click or drag to resize
MimeKit

MimeReader Class

A MIME message and entity reader.
Inheritance Hierarchy
SystemObject
  MimeKitMimeReader
    MimeKitExperimentalMimeParser

Namespace: MimeKit
Assembly: MimeKit (in MimeKit.dll) Version: 4.12.0
Syntax
C#
Copy
public class MimeReader

The MimeReader type exposes the following members.

Constructors
 NameDescription
Public methodMimeReader(Stream, MimeFormat) Initialize a new instance of the MimeReader class.
Public methodMimeReader(ParserOptions, Stream, MimeFormat) Initialize a new instance of the MimeReader class.
Top
Properties
 NameDescription
Public propertyIsEndOfStream Get a value indicating whether the parser has reached the end of the input stream.
Public propertyOptions Get or set the parser options.
Public propertyPosition Get the current position of the parser within the stream.
Top
Methods
 NameDescription
Public methodEquals
(Inherited from Object)
Protected methodFinalize
(Inherited from Object)
Public methodGetHashCode
(Inherited from Object)
Public methodGetType
(Inherited from Object)
Protected methodMemberwiseClone
(Inherited from Object)
Protected methodOnBodySeparator Called when the body separator is encountered in the stream.
Protected methodOnBodySeparatorAsync Called when the body separator is encountered in the stream.
Protected methodOnHeaderRead Called when a message or MIME part header is read from the stream.
Protected methodOnHeaderReadAsync Called when a message or MIME part header is read from the stream.
Protected methodOnHeadersBegin Called when the beginning of a list of headers is encountered in the stream.
Protected methodOnHeadersBeginAsync Called when the beginning of a list of headers is encountered in the stream.
Protected methodOnHeadersEnd Called when the end of a list of headers is encountered in the stream.
Protected methodOnHeadersEndAsync Called when the end of a list of headers is encountered in the stream.
Protected methodOnMboxMarkerBegin Called when an Mbox marker is encountered in the stream.
Protected methodOnMboxMarkerEnd Called when the end of an Mbox marker is encountered in the stream.
Protected methodOnMboxMarkerRead Called when an Mbox marker is encountered in the stream.
Protected methodOnMboxMarkerReadAsync Called when an Mbox marker is encountered in the stream.
Protected methodOnMessagePartBegin Called when the beginning of a message part is encountered in the stream.
Protected methodOnMessagePartBeginAsync Called when the beginning of a message part is encountered in the stream.
Protected methodOnMessagePartEnd Called when the end of a message part is encountered in the stream.
Protected methodOnMessagePartEndAsync Called when the end of a message part is encountered in the stream.
Protected methodOnMimeMessageBegin Called when the beginning of a message is encountered in the stream.
Protected methodOnMimeMessageBeginAsync Called when the beginning of a message is encountered in the stream.
Protected methodOnMimeMessageEnd Called when the end of a message is encountered in the stream.
Protected methodOnMimeMessageEndAsync Called when the end of a message is encountered in the stream.
Protected methodOnMimePartBegin Called when the beginning of a MIME part is encountered in the stream.
Protected methodOnMimePartBeginAsync Called when the beginning of a MIME part is encountered in the stream.
Protected methodOnMimePartContentBegin Called when the beginning of a MIME part's content is encountered in the stream.
Protected methodOnMimePartContentBeginAsync Called when the beginning of a MIME part's content is encountered in the stream.
Protected methodOnMimePartContentEnd Called when the end of a MIME part's content is encountered in the stream.
Protected methodOnMimePartContentEndAsync Called when the end of a MIME part's content is encountered in the stream.
Protected methodOnMimePartContentRead Called when MIME part content is read from the stream.
Protected methodOnMimePartContentReadAsync Called when MIME part content is read from the stream.
Protected methodOnMimePartEnd Called when the end of a MIME part is encountered in the stream.
Protected methodOnMimePartEndAsync Called when the end of a MIME part is encountered in the stream.
Protected methodOnMultipartBegin Called when the beginning of a multipart is encountered in the stream.
Protected methodOnMultipartBeginAsync Called when the beginning of a multipart is encountered in the stream.
Protected methodOnMultipartBoundaryObsolete.
Called when a multipart boundary is encountered in the stream.
Protected methodOnMultipartBoundaryAsyncObsolete.
Called when a multipart boundary is encountered in the stream.
Protected methodOnMultipartBoundaryBegin Called when a multipart boundary is encountered in the stream.
Protected methodOnMultipartBoundaryBeginAsync Called when a multipart boundary is encountered in the stream.
Protected methodOnMultipartBoundaryEnd Called when a multipart boundary is encountered in the stream.
Protected methodOnMultipartBoundaryEndAsync Called when a multipart boundary is encountered in the stream.
Protected methodOnMultipartBoundaryRead Called when a multipart boundary is encountered in the stream.
Protected methodOnMultipartBoundaryReadAsync Called when a multipart boundary is encountered in the stream.
Protected methodOnMultipartEnd Called when the end of a multipart is encountered in the stream.
Protected methodOnMultipartEndAsync Called when the end of a multipart is encountered in the stream.
Protected methodOnMultipartEndBoundaryObsolete.
Called when a multipart end boundary is encountered in the stream.
Protected methodOnMultipartEndBoundaryAsyncObsolete.
Called when a multipart end boundary is encountered in the stream.
Protected methodOnMultipartEndBoundaryBegin Called when a multipart end boundary is encountered in the stream.
Protected methodOnMultipartEndBoundaryBeginAsync Called when a multipart end boundary is encountered in the stream.
Protected methodOnMultipartEndBoundaryEnd Called when a multipart end boundary is encountered in the stream.
Protected methodOnMultipartEndBoundaryEndAsync Called when a multipart end boundary is encountered in the stream.
Protected methodOnMultipartEndBoundaryRead Called when a multipart end boundary is encountered in the stream.
Protected methodOnMultipartEndBoundaryReadAsync Called when a multipart end boundary is encountered in the stream.
Protected methodOnMultipartEpilogueBegin Called when the beginning of the epilogue of a multipart is encountered in the stream.
Protected methodOnMultipartEpilogueBeginAsync Called when the beginning of the epilogue of a multipart is encountered in the stream.
Protected methodOnMultipartEpilogueEnd Called when the end of the epilogue of a multipart is encountered in the stream.
Protected methodOnMultipartEpilogueEndAsync Called when the end of the epilogue of a multipart is encountered in the stream.
Protected methodOnMultipartEpilogueRead Called when multipart epilogue text is read from the stream.
Protected methodOnMultipartEpilogueReadAsync Called when multipart epilogue text is read from the stream.
Protected methodOnMultipartPreambleBegin Called when the beginning of the preamble of a multipart is encountered in the stream.
Protected methodOnMultipartPreambleBeginAsync Called when the beginning of the preamble of a multipart is encountered in the stream.
Protected methodOnMultipartPreambleEnd Called when the end of the preamble of a multipart is encountered in the stream.
Protected methodOnMultipartPreambleEndAsync Called when the end of the preamble of a multipart is encountered in the stream.
Protected methodOnMultipartPreambleRead Called when multipart preamble text is read from the stream.
Protected methodOnMultipartPreambleReadAsync Called when multipart preamble text is read from the stream.
Public methodReadEntity Read an entity from the stream.
Public methodReadEntityAsync Asynchronously read an entity from the stream.
Public methodReadHeaders Read a block of headers from the stream.
Public methodReadHeadersAsync Asynchronously read a block of headers from the stream.
Public methodReadMessage Read a message from the stream.
Public methodReadMessageAsync Asynchronously read a message from the stream.
Public methodSetStream Set the stream to parse.
Public methodToString
(Inherited from Object)
Top
Remarks

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

See Also