Click or drag to resize
MimeKit

MimeEntity Class

An abstract MIME entity.
Inheritance Hierarchy

Namespace:  MimeKit
Assembly:  MimeKit (in MimeKit.dll) Version: 2.0.6.0
Syntax
C#
public abstract class MimeEntity

The MimeEntity type exposes the following members.

Constructors
  NameDescription
Protected methodMimeEntity(ContentType)
Initializes a new instance of the MimeEntity class.
Protected methodMimeEntity(MimeEntityConstructorArgs)
Initializes a new instance of the MimeEntity class based on the MimeEntityConstructorArgs.
Protected methodMimeEntity(String, String)
Initializes a new instance of the MimeEntity class.
Top
Properties
  NameDescription
Public propertyContentBase
Gets or sets the base content URI.
Public propertyContentDisposition
Gets or sets the content disposition.
Public propertyContentId
Gets or sets the content identifier.
Public propertyContentLocation
Gets or sets the content location.
Public propertyContentType
Gets the type of the content.
Public propertyHeaders
Gets the list of headers.
Public propertyIsAttachment
Gets a value indicating whether this MimePart is an attachment.
Top
Methods
  NameDescription
Public methodAccept
Dispatches to the specific visit method for this MIME entity.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodStatic memberLoad(Stream, CancellationToken)
Load a MimeEntity from the specified stream.
Public methodStatic memberLoad(String, CancellationToken)
Load a MimeEntity from the specified file.
Public methodStatic memberLoad(Stream, Boolean, CancellationToken)
Load a MimeEntity from the specified stream.
Public methodStatic memberCode exampleLoad(ContentType, Stream, CancellationToken)
Load a MimeEntity from the specified content stream.
Public methodStatic memberLoad(ParserOptions, Stream, CancellationToken)
Load a MimeEntity from the specified stream.
Public methodStatic memberLoad(ParserOptions, String, CancellationToken)
Load a MimeEntity from the specified file.
Public methodStatic memberLoad(ParserOptions, ContentType, Stream, CancellationToken)
Load a MimeEntity from the specified content stream.
Public methodStatic memberLoad(ParserOptions, Stream, Boolean, CancellationToken)
Load a MimeEntity from the specified stream.
Public methodStatic memberLoadAsync(Stream, CancellationToken)
Asynchronously load a MimeEntity from the specified stream.
Public methodStatic memberLoadAsync(String, CancellationToken)
Asynchroinously load a MimeEntity from the specified file.
Public methodStatic memberLoadAsync(Stream, Boolean, CancellationToken)
Asynchronously load a MimeEntity from the specified stream.
Public methodStatic memberLoadAsync(ContentType, Stream, CancellationToken)
Asynchronously load a MimeEntity from the specified content stream.
Public methodStatic memberLoadAsync(ParserOptions, Stream, CancellationToken)
Asynchronously load a MimeEntity from the specified stream.
Public methodStatic memberLoadAsync(ParserOptions, String, CancellationToken)
Asynchronously load a MimeEntity from the specified file.
Public methodStatic memberLoadAsync(ParserOptions, ContentType, Stream, CancellationToken)
Asynchronously load a MimeEntity from the specified content stream.
Public methodStatic memberLoadAsync(ParserOptions, Stream, Boolean, CancellationToken)
Asynchronously load a MimeEntity from the specified stream.
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodOnHeadersChanged
Called when the headers change in some way.
Public methodPrepare
Prepare the MIME entity for transport using the specified encoding constraints.
Protected methodRemoveHeader
Removes the header.
Protected methodSetHeader(String, Byte)
Sets the header using the raw value.
Protected methodSetHeader(String, String)
Sets the header.
Public methodToString
Returns a String that represents the current MimeEntity.
(Overrides ObjectToString.)
Protected methodTryInit
Tries to use the given object to initialize the appropriate property.
Public methodWriteTo(Stream, CancellationToken)
Write the MimeEntity to the specified output stream.
Public methodWriteTo(String, CancellationToken)
Writes the MimeEntity to the specified file.
Public methodWriteTo(Stream, Boolean, CancellationToken)
Write the MimeEntity to the specified output stream.
Public methodWriteTo(String, Boolean, CancellationToken)
Write the MimeEntity to the specified file.
Public methodWriteTo(FormatOptions, Stream, CancellationToken)
Write the MimeEntity to the specified output stream.
Public methodWriteTo(FormatOptions, String, CancellationToken)
Write the MimeEntity to the specified file.
Public methodWriteTo(FormatOptions, Stream, Boolean, CancellationToken)
Write the MimeEntity to the specified output stream.
Public methodWriteTo(FormatOptions, String, Boolean, CancellationToken)
Write the MimeEntity to the specified file.
Public methodWriteToAsync(Stream, CancellationToken)
Asynchronously write the MimeEntity to the specified output stream.
Public methodWriteToAsync(String, CancellationToken)
Asynchronously writes the MimeEntity to the specified file.
Public methodWriteToAsync(Stream, Boolean, CancellationToken)
Adsynchronously write the MimeEntity to the specified output stream.
Public methodWriteToAsync(String, Boolean, CancellationToken)
Asynchronously write the MimeEntity to the specified file.
Public methodWriteToAsync(FormatOptions, Stream, CancellationToken)
Asynchronously write the MimeEntity to the specified output stream.
Public methodWriteToAsync(FormatOptions, String, CancellationToken)
Asynchronously write the MimeEntity to the specified file.
Public methodWriteToAsync(FormatOptions, Stream, Boolean, CancellationToken)
Asynchronously write the MimeEntity to the specified output stream.
Public methodWriteToAsync(FormatOptions, String, Boolean, CancellationToken)
Asynchronously write the MimeEntity to the specified file.
Top
Remarks

A MIME entity is really just a node in a tree structure of MIME parts in a MIME message.

There are 3 basic types of entities: MimePart, Multipart, and MessagePart (which is actually just a special variation of MimePart who's content is another MIME message/document). All other types are derivatives of one of those.

See Also