Click or drag to resize
MimeKit

MimeMessage Class

A MIME message.
Inheritance Hierarchy
SystemObject
  MimeKitMimeMessage

Namespace: MimeKit
Assembly: MimeKit (in MimeKit.dll) Version: 4.3.0
Syntax
C#
public class MimeMessage : IDisposable

The MimeMessage type exposes the following members.

Constructors
 NameDescription
Public methodMimeMessage Initialize a new instance of the MimeMessage class.
Public methodMimeMessage(Object) Initialize a new instance of the MimeMessage class.
Public methodMimeMessage(IEnumerableInternetAddress, IEnumerableInternetAddress, String, MimeEntity) Initialize a new instance of the MimeMessage class.
Top
Properties
 NameDescription
Public propertyCode exampleAttachments Get the attachments.
Public propertyBcc Get the list of addresses in the Bcc header.
Public propertyBody Get or set the body of the message.
Public propertyCode exampleBodyParts Get the body parts of the message.
Public propertyCc Get the list of addresses in the Cc header.
Public propertyDate Get or set the date of the message.
Public propertyFrom Get the list of addresses in the From header.
Public propertyHeaders Get the list of headers.
Public propertyHtmlBody Get the html body of the message if it exists.
Public propertyImportance Get or set the value of the Importance header.
Public propertyInReplyTo Get or set the Message-Id that this message is replying to.
Public propertyMessageId Get or set the message identifier.
Public propertyMimeVersion Get or set the MIME-Version.
Public propertyPriority Get or set the value of the Priority header.
Public propertyReferences Get the list of references to other messages.
Public propertyReplyTo Get the list of addresses in the Reply-To header.
Public propertyResentBcc Get the list of addresses in the Resent-Bcc header.
Public propertyResentCc Get the list of addresses in the Resent-Cc header.
Public propertyResentDate Get or set the Resent-Date of the message.
Public propertyResentFrom Get the list of addresses in the Resent-From header.
Public propertyResentMessageId Get or set the Resent-Message-Id header.
Public propertyResentReplyTo Get the list of addresses in the Resent-Reply-To header.
Public propertyResentSender Get or set the address in the Resent-Sender header.
Public propertyResentTo Get the list of addresses in the Resent-To header.
Public propertySender Get or set the address in the Sender header.
Public propertySubject Get or set the subject of the message.
Public propertyTextBody Get the text body of the message if it exists.
Public propertyTo Get the list of addresses in the To header.
Public propertyXPriority Get or set the value of the X-Priority header.
Top
Methods
 NameDescription
Public methodAccept Dispatches to the specific visit method for this MIME message.
Public methodStatic memberCreateFromMailMessage Create a new MimeMessage from a MailMessage.
Public methodDispose Releases all resources used by the MimeMessage object.
Protected methodDispose(Boolean) Releases the unmanaged resources used by the MimeMessage and optionally releases the managed resources.
Public methodEncrypt Encrypt the message to the sender and all of the recipients using the specified cryptography context.
Public methodEncryptAsync Asynchronously encrypt the message to the sender and all of the recipients using the specified cryptography context.
Public methodEquals
(Inherited from Object)
Protected methodFinalize Releases unmanaged resources and performs other cleanup operations before the MimeMessage is reclaimed by garbage collection.
(Overrides ObjectFinalize)
Public methodGetHashCode
(Inherited from Object)
Public methodGetRecipients Get the concatenated list of recipients.
Public methodGetTextBody Get the text body in the specified format.
Public methodGetType
(Inherited from Object)
Public methodStatic memberLoad(Stream, CancellationToken) Load a MimeMessage from the specified stream.
Public methodStatic memberLoad(String, CancellationToken) Load a MimeMessage from the specified file.
Public methodStatic memberLoad(ParserOptions, Stream, CancellationToken) Load a MimeMessage from the specified stream.
Public methodStatic memberLoad(ParserOptions, String, CancellationToken) Load a MimeMessage from the specified file.
Public methodStatic memberLoad(Stream, Boolean, CancellationToken) Load a MimeMessage from the specified stream.
Public methodStatic memberLoad(ParserOptions, Stream, Boolean, CancellationToken) Load a MimeMessage from the specified stream.
Public methodStatic memberLoadAsync(Stream, CancellationToken) Asynchronously load a MimeMessage from the specified stream.
Public methodStatic memberLoadAsync(String, CancellationToken) Asynchronously load a MimeMessage from the specified file.
Public methodStatic memberLoadAsync(ParserOptions, Stream, CancellationToken) Asynchronously load a MimeMessage from the specified stream.
Public methodStatic memberLoadAsync(ParserOptions, String, CancellationToken) Asynchronously load a MimeMessage from the specified file.
Public methodStatic memberLoadAsync(Stream, Boolean, CancellationToken) Asynchronously load a MimeMessage from the specified stream.
Public methodStatic memberLoadAsync(ParserOptions, Stream, Boolean, CancellationToken) Asynchronously load a MimeMessage from the specified stream.
Protected methodMemberwiseClone
(Inherited from Object)
Public methodPrepare Prepare the message for transport using the specified encoding constraints.
Public methodSign(CryptographyContext, CancellationToken) Sign the message using the specified cryptography context and the SHA-1 digest algorithm.
Public methodSign(CryptographyContext, DigestAlgorithm, CancellationToken) Sign the message using the specified cryptography context and digest algorithm.
Public methodSignAndEncrypt(CryptographyContext, CancellationToken) Sign and encrypt the message to the sender and all of the recipients using the specified cryptography context and the SHA-1 digest algorithm.
Public methodSignAndEncrypt(CryptographyContext, DigestAlgorithm, CancellationToken) Sign and encrypt the message to the sender and all of the recipients using the specified cryptography context and the specified digest algorithm.
Public methodSignAndEncryptAsync(CryptographyContext, CancellationToken) Asynchronously sign and encrypt the message to the sender and all of the recipients using the specified cryptography context and the SHA-1 digest algorithm.
Public methodSignAndEncryptAsync(CryptographyContext, DigestAlgorithm, CancellationToken) Asynchronously sign and encrypt the message to the sender and all of the recipients using the specified cryptography context and the specified digest algorithm.
Public methodSignAsync(CryptographyContext, CancellationToken) Asynchronously sign the message using the specified cryptography context and the SHA-1 digest algorithm.
Public methodSignAsync(CryptographyContext, DigestAlgorithm, CancellationToken) Asynchronously sign the message using the specified cryptography context and digest algorithm.
Public methodToString Returns a String that represents the MimeMessage for debugging purposes.
(Overrides ObjectToString)
Public methodWriteTo(Stream, CancellationToken) Write the message to the specified output stream.
Public methodWriteTo(String, CancellationToken) Write the message to the specified file.
Public methodWriteTo(FormatOptions, Stream, CancellationToken) Write the message to the specified output stream.
Public methodWriteTo(FormatOptions, String, CancellationToken) Write the message to the specified file.
Public methodWriteTo(Stream, Boolean, CancellationToken) Write the message to the specified output stream.
Public methodWriteTo(FormatOptions, Stream, Boolean, CancellationToken) Write the message to the specified output stream.
Public methodWriteToAsync(Stream, CancellationToken) Asynchronously write the message to the specified output stream.
Public methodWriteToAsync(String, CancellationToken) Asynchronously write the message to the specified file.
Public methodWriteToAsync(FormatOptions, Stream, CancellationToken) Asynchronously write the message to the specified output stream.
Public methodWriteToAsync(FormatOptions, String, CancellationToken) Asynchronously write the message to the specified file.
Public methodWriteToAsync(Stream, Boolean, CancellationToken) Asynchronously write the message to the specified output stream.
Public methodWriteToAsync(FormatOptions, Stream, Boolean, CancellationToken) Asynchronously write the message to the specified output stream.
Top
Operators
 NameDescription
Public operatorStatic member(MailMessage to MimeMessage) Explicit cast to convert a MailMessage to a MimeMessage.
Top
Remarks

A 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