 | Mime |
A MIME message.
Inheritance HierarchyNamespace: MimeKit
Assembly: MimeKit (in MimeKit.dll) Version: 4.12.0
SyntaxC#
public class MimeMessage : IMimeMessage, IDisposable
The MimeMessage type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MimeMessage | Initialize a new instance of the MimeMessage class. |
| MimeMessage(IEnumerableHeader) | Initialize a new instance of the MimeMessage class. |
| MimeMessage(Object) | Initialize a new instance of the MimeMessage class. |
| MimeMessage(IEnumerableInternetAddress, IEnumerableInternetAddress, String, MimeEntity) | Initialize a new instance of the MimeMessage class. |
Properties| Name | Description | |
|---|---|---|
  | Attachments | Get the attachments. |
| Bcc | Get the list of addresses in the Bcc header. |
| Body | Get or set the body of the message. |
| BodyParts | Get the body parts of the message. |
| Cc | Get the list of addresses in the Cc header. |
| Date | Get or set the date of the message. |
| From | Get the list of addresses in the From header. |
| Headers | Get the list of headers. |
| HtmlBody | Get the html body of the message if it exists. |
| Importance | Get or set the value of the Importance header. |
| InReplyTo | Get or set the Message-Id that this message is replying to. |
| MessageId | Get or set the message identifier. |
| MimeVersion | Get or set the MIME-Version. |
| Priority | Get or set the value of the Priority header. |
| References | Get the list of references to other messages. |
| ReplyTo | Get the list of addresses in the Reply-To header. |
| ResentBcc | Get the list of addresses in the Resent-Bcc header. |
| ResentCc | Get the list of addresses in the Resent-Cc header. |
| ResentDate | Get or set the Resent-Date of the message. |
| ResentFrom | Get the list of addresses in the Resent-From header. |
| ResentMessageId | Get or set the Resent-Message-Id header. |
| ResentReplyTo | Get the list of addresses in the Resent-Reply-To header. |
| ResentSender | Get or set the address in the Resent-Sender header. |
| ResentTo | Get the list of addresses in the Resent-To header. |
| Sender | Get or set the address in the Sender header. |
| Subject | Get or set the subject of the message. |
| TextBody | Get the text body of the message if it exists. |
| To | Get the list of addresses in the To header. |
| XPriority | Get or set the value of the X-Priority header. |
Methods| Name | Description | |
|---|---|---|
| Accept | Dispatches to the specific visit method for this MIME message. |
 | CreateFromMailMessage | Create a new MimeMessage from a MailMessage. |
| Dispose | Releases all resources used by the MimeMessage object. |
 | Dispose(Boolean) | Releases the unmanaged resources used by the MimeMessage and optionally releases the managed resources. |
| Encrypt | Encrypt the message to the sender and all the recipients using the specified cryptography context. |
| EncryptAsync | Asynchronously encrypt the message to the sender and all the recipients using the specified cryptography context. |
| Equals | (Inherited from Object) |
| Finalize |
Releases unmanaged resources and performs other cleanup operations before the
MimeMessage is reclaimed by garbage collection.
(Overrides ObjectFinalize) |
| GetHashCode | (Inherited from Object) |
| GetRecipients | Get the concatenated list of recipients. |
| GetTextBody | Get the text body in the specified format. |
| GetType | (Inherited from Object) |
| Load(Stream, CancellationToken) | Load a MimeMessage from the specified stream. |
| Load(String, CancellationToken) | Load a MimeMessage from the specified file. |
| Load(ParserOptions, Stream, CancellationToken) | Load a MimeMessage from the specified stream. |
| Load(ParserOptions, String, CancellationToken) | Load a MimeMessage from the specified file. |
| Load(Stream, Boolean, CancellationToken) | Load a MimeMessage from the specified stream. |
| Load(ParserOptions, Stream, Boolean, CancellationToken) | Load a MimeMessage from the specified stream. |
| LoadAsync(Stream, CancellationToken) | Asynchronously load a MimeMessage from the specified stream. |
| LoadAsync(String, CancellationToken) | Asynchronously load a MimeMessage from the specified file. |
| LoadAsync(ParserOptions, Stream, CancellationToken) | Asynchronously load a MimeMessage from the specified stream. |
| LoadAsync(ParserOptions, String, CancellationToken) | Asynchronously load a MimeMessage from the specified file. |
| LoadAsync(Stream, Boolean, CancellationToken) | Asynchronously load a MimeMessage from the specified stream. |
| LoadAsync(ParserOptions, Stream, Boolean, CancellationToken) | Asynchronously load a MimeMessage from the specified stream. |
| MemberwiseClone | (Inherited from Object) |
| Prepare | Prepare the message for transport using the specified encoding constraints. |
| Sign(CryptographyContext, CancellationToken) | Sign the message using the specified cryptography context and the SHA-1 digest algorithm. |
| Sign(CryptographyContext, DigestAlgorithm, CancellationToken) | Sign the message using the specified cryptography context and digest algorithm. |
| SignAndEncrypt(CryptographyContext, CancellationToken) | Sign and encrypt the message to the sender and all the recipients using the specified cryptography context and the SHA-1 digest algorithm. |
| SignAndEncrypt(CryptographyContext, DigestAlgorithm, CancellationToken) | Sign and encrypt the message to the sender and all the recipients using the specified cryptography context and the specified digest algorithm. |
| SignAndEncryptAsync(CryptographyContext, CancellationToken) | Asynchronously sign and encrypt the message to the sender and all the recipients using the specified cryptography context and the SHA-1 digest algorithm. |
| SignAndEncryptAsync(CryptographyContext, DigestAlgorithm, CancellationToken) | Asynchronously sign and encrypt the message to the sender and all the recipients using the specified cryptography context and the specified digest algorithm. |
| SignAsync(CryptographyContext, CancellationToken) | Asynchronously sign the message using the specified cryptography context and the SHA-1 digest algorithm. |
| SignAsync(CryptographyContext, DigestAlgorithm, CancellationToken) | Asynchronously sign the message using the specified cryptography context and digest algorithm. |
| ToString |
Returns a String that represents the MimeMessage for debugging purposes.
(Overrides ObjectToString) |
| WriteTo(Stream, CancellationToken) | Write the message to the specified output stream. |
| WriteTo(String, CancellationToken) | Write the message to the specified file. |
| WriteTo(FormatOptions, Stream, CancellationToken) | Write the message to the specified output stream. |
| WriteTo(FormatOptions, String, CancellationToken) | Write the message to the specified file. |
| WriteTo(Stream, Boolean, CancellationToken) | Write the message to the specified output stream. |
| WriteTo(FormatOptions, Stream, Boolean, CancellationToken) | Write the message to the specified output stream. |
| WriteToAsync(Stream, CancellationToken) | Asynchronously write the message to the specified output stream. |
| WriteToAsync(String, CancellationToken) | Asynchronously write the message to the specified file. |
| WriteToAsync(FormatOptions, Stream, CancellationToken) | Asynchronously write the message to the specified output stream. |
| WriteToAsync(FormatOptions, String, CancellationToken) | Asynchronously write the message to the specified file. |
| WriteToAsync(Stream, Boolean, CancellationToken) | Asynchronously write the message to the specified output stream. |
| WriteToAsync(FormatOptions, Stream, Boolean, CancellationToken) | Asynchronously write the message to the specified output stream. |
Operators| Name | Description | |
|---|---|---|
 | (MailMessage to MimeMessage) | Explicit cast to convert a MailMessage to a MimeMessage. |
RemarksA message consists of header fields and, optionally, a body.
The body of the message can either be plain text or it can be a tree of MIME entities such as a text/plain MIME part and a collection of file attachments.
See Also