 | MimeEntity Class |
An abstract MIME entity.
Inheritance HierarchyNamespace: MimeKit
Assembly: MimeKit (in MimeKit.dll) Version: 3.0.0
SyntaxC#
public abstract class MimeEntity : IDisposable
The MimeEntity type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MimeEntity(ContentType) |
Initialize a new instance of the MimeEntity class.
|
| MimeEntity(MimeEntityConstructorArgs) |
Initialize a new instance of the MimeEntity class
based on the MimeEntityConstructorArgs.
|
| MimeEntity(String, String) |
Initialize a new instance of the MimeEntity class.
|
Properties| Name | Description | |
|---|---|---|
 | ContentBase |
Gets or sets the base content URI.
|
| ContentDisposition |
Gets or sets the content disposition.
|
| ContentId |
Gets or sets the content identifier.
|
| ContentLocation |
Gets or sets the content location.
|
| ContentType |
Gets the type of the content.
|
| Headers |
Gets the list of headers.
|
| IsAttachment |
Gets a value indicating whether this MimePart is an attachment.
|
Methods| Name | Description | |
|---|---|---|
 | Accept |
Dispatches to the specific visit method for this MIME entity.
|
| Dispose |
Releases all resources used by the MimeEntity object.
|
| Dispose(Boolean) |
Releases the unmanaged resources used by the MimeEntity and
optionally releases the managed resources.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize |
Releases unmanaged resources and performs other cleanup operations before the
MimeEntity is reclaimed by garbage collection.
(Overrides ObjectFinalize.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
 | Load(Stream, CancellationToken) |
Load a MimeEntity from the specified stream.
|
| Load(String, CancellationToken) |
Load a MimeEntity from the specified file.
|
 | Load(ContentType, Stream, CancellationToken) |
Load a MimeEntity from the specified content stream.
|
| Load(ParserOptions, Stream, CancellationToken) |
Load a MimeEntity from the specified stream.
|
| Load(ParserOptions, String, CancellationToken) |
Load a MimeEntity from the specified file.
|
| Load(Stream, Boolean, CancellationToken) |
Load a MimeEntity from the specified stream.
|
| Load(ParserOptions, ContentType, Stream, CancellationToken) |
Load a MimeEntity from the specified content stream.
|
| Load(ParserOptions, Stream, Boolean, CancellationToken) |
Load a MimeEntity from the specified stream.
|
| LoadAsync(Stream, CancellationToken) |
Asynchronously load a MimeEntity from the specified stream.
|
| LoadAsync(String, CancellationToken) |
Asynchroinously load a MimeEntity from the specified file.
|
| LoadAsync(ContentType, Stream, CancellationToken) |
Asynchronously load a MimeEntity from the specified content stream.
|
| LoadAsync(ParserOptions, Stream, CancellationToken) |
Asynchronously load a MimeEntity from the specified stream.
|
| LoadAsync(ParserOptions, String, CancellationToken) |
Asynchronously load a MimeEntity from the specified file.
|
| LoadAsync(Stream, Boolean, CancellationToken) |
Asynchronously load a MimeEntity from the specified stream.
|
| LoadAsync(ParserOptions, ContentType, Stream, CancellationToken) |
Asynchronously load a MimeEntity from the specified content stream.
|
| LoadAsync(ParserOptions, Stream, Boolean, CancellationToken) |
Asynchronously load a MimeEntity from the specified stream.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnHeadersChanged |
Called when the headers change in some way.
|
| Prepare |
Prepare the MIME entity for transport using the specified encoding constraints.
|
| RemoveHeader |
Remove a header by name.
|
| SetHeader(String, Byte) |
Set the value of a header using the raw value.
|
| SetHeader(String, String) |
Set the value of a header.
|
| ToString |
Returns a String that represents the MimeEntity for debugging purposes.
(Overrides ObjectToString.) |
| TryInit |
Tries to use the given object to initialize the appropriate property.
|
| WriteTo(Stream, CancellationToken) |
Write the MimeEntity to the specified output stream.
|
| WriteTo(String, CancellationToken) |
Write the MimeEntity to the specified file.
|
| WriteTo(FormatOptions, Stream, CancellationToken) |
Write the MimeEntity to the specified output stream.
|
| WriteTo(FormatOptions, String, CancellationToken) |
Write the MimeEntity to the specified file.
|
| WriteTo(Stream, Boolean, CancellationToken) |
Write the MimeEntity to the specified output stream.
|
| WriteTo(String, Boolean, CancellationToken) |
Write the MimeEntity to the specified file.
|
| WriteTo(FormatOptions, Stream, Boolean, CancellationToken) |
Write the MimeEntity to the specified output stream.
|
| WriteTo(FormatOptions, String, Boolean, CancellationToken) |
Write the MimeEntity to the specified file.
|
| WriteToAsync(Stream, CancellationToken) |
Asynchronously write the MimeEntity to the specified output stream.
|
| WriteToAsync(String, CancellationToken) |
Asynchronously write the MimeEntity to the specified file.
|
| WriteToAsync(FormatOptions, Stream, CancellationToken) |
Asynchronously write the MimeEntity to the specified output stream.
|
| WriteToAsync(FormatOptions, String, CancellationToken) |
Asynchronously write the MimeEntity to the specified file.
|
| WriteToAsync(Stream, Boolean, CancellationToken) |
Asynchronously write the MimeEntity to the specified output stream.
|
| WriteToAsync(String, Boolean, CancellationToken) |
Asynchronously write the MimeEntity to the specified file.
|
| WriteToAsync(FormatOptions, Stream, Boolean, CancellationToken) |
Asynchronously write the MimeEntity to the specified output stream.
|
| WriteToAsync(FormatOptions, String, Boolean, CancellationToken) |
Asynchronously write the MimeEntity to the specified file.
|
RemarksA 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