MailMessage Class

MailMessage Class

 

Represents an e-mail message that can be sent using the SmtpClient class.

Namespace:   System.Net.Mail
Assembly:  System (in System.dll)

System.Object
  System.Net.Mail.MailMessage

public class MailMessage : IDisposable

NameDescription
System_CAPS_pubmethodMailMessage()

Initializes an empty instance of the MailMessage class.

System_CAPS_pubmethodMailMessage(MailAddress, MailAddress)

Initializes a new instance of the MailMessage class by using the specified MailAddress class objects.

System_CAPS_pubmethodMailMessage(String, String)

Initializes a new instance of the MailMessage class by using the specified String class objects.

System_CAPS_pubmethodMailMessage(String, String, String, String)

Initializes a new instance of the MailMessage class.

NameDescription
System_CAPS_pubpropertyAlternateViews

Gets the attachment collection used to store alternate forms of the message body.

System_CAPS_pubpropertyAttachments

Gets the attachment collection used to store data attached to this e-mail message.

System_CAPS_pubpropertyBcc

Gets the address collection that contains the blind carbon copy (BCC) recipients for this e-mail message.

System_CAPS_pubpropertyBody

Gets or sets the message body.

System_CAPS_pubpropertyBodyEncoding

Gets or sets the encoding used to encode the message body.

System_CAPS_pubpropertyBodyTransferEncoding

Gets or sets the transfer encoding used to encode the message body.

System_CAPS_pubpropertyCC

Gets the address collection that contains the carbon copy (CC) recipients for this e-mail message.

System_CAPS_pubpropertyDeliveryNotificationOptions

Gets or sets the delivery notifications for this e-mail message.

System_CAPS_pubpropertyFrom

Gets or sets the from address for this e-mail message.

System_CAPS_pubpropertyHeaders

Gets the e-mail headers that are transmitted with this e-mail message.

System_CAPS_pubpropertyHeadersEncoding

Gets or sets the encoding used for the user-defined custom headers for this e-mail message.

System_CAPS_pubpropertyIsBodyHtml

Gets or sets a value indicating whether the mail message body is in Html.

System_CAPS_pubpropertyPriority

Gets or sets the priority of this e-mail message.

System_CAPS_pubpropertyReplyTo

Obsolete.Gets or sets the ReplyTo address for the mail message.

System_CAPS_pubpropertyReplyToList

Gets or sets the list of addresses to reply to for the mail message.

System_CAPS_pubpropertySender

Gets or sets the sender's address for this e-mail message.

System_CAPS_pubpropertySubject

Gets or sets the subject line for this e-mail message.

System_CAPS_pubpropertySubjectEncoding

Gets or sets the encoding used for the subject content for this e-mail message.

System_CAPS_pubpropertyTo

Gets the address collection that contains the recipients of this e-mail message.

NameDescription
System_CAPS_pubmethodDispose()

Releases all resources used by the MailMessage.

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the MailMessage and optionally releases the managed resources.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

Instances of the MailMessage class are used to construct e-mail messages that are transmitted to an SMTP server for delivery using the SmtpClient class.

The sender, recipient, subject, and body of an e-mail message may be specified as parameters when a MailMessage is used to initialize a MailMessage object. These parameters may also be set or accessed using properties on the MailMessage object.

The primary mail message headers and elements for the message may be set using the following properties of the MailMessage class.

Mail header or part

Property

Attachments

Attachments

Blind carbon copies (BCC)

Bcc

Carbon copies (CC)

CC

Content-Type

BodyEncoding

Encoding for custom headers

HeadersEncoding

Message body

Body

Priority

Priority

Recipient

To

Reply-To

ReplyToList

Sender

From

Subject

Subject

The MailMessage class also allows an application to access the headers collection for the message using the Headers property. While this collection is read-only (a new collection can not be set), custom headers can be added to or deleted from this collection. Any custom headers added will be included when the MailMessage instance is sent. Before a message is sent, only headers specifically added to this collection in the Headers property are included in the collection. After a the MailMessage instance is sent, the Headers property will also include headers that are set using the associated properties of the MailMessage class or parameters passed when a MailMessage is used to initialize a MailMessage object.

If some mail headers are malformed, they could cause the email message to become corrupted. So any mail header in the headers collection that can be set using a property on the MailMessage class should only be set using the MailMessage class property or as a parameter passed when a MailMessage initializes a MailMessage object. The following list of mail headers should not be added using the Headers property and any values set for these headers using the Headers property will be discarded or overwritten when the message is sent:

  • Bcc

  • Cc

  • Content-ID

  • Content-Location

  • Content-Transfer-Encoding

  • Content-Type

  • Date

  • From

  • Importance

  • MIME-Version

  • Priority

  • Reply-To

  • Sender

  • To

  • X-Priority

If the application does not specify an X-Sender header using the Headers property, the MailMessage class will create one when the message is sent.

Use the AlternateViews property to specify copies of an e-mail message in different formats. For example, if you send a message in HTML, you might also want to provide a plain text version in case some of the recipients use e-mail readers that cannot display HTML content. For an example that demonstrates creating a message with alternate views, see AlternateViews.

Use the Attachments property to add attachments to an e-mail message. For an example that demonstrates creating a message with an attachment, see Attachments.

After assembling your e-mail message, you can send it by using the Send or SendAsync methods.

The following code example demonstrates creating and sending an e-mail message that includes an attachment.

public static void CreateMessageWithAttachment(string server)
{
	// Specify the file to be attached and sent.
	// This example assumes that a file named Data.xls exists in the
	// current working directory.
	string file = "data.xls";
	// Create a message and set up the recipients.
	MailMessage message = new MailMessage(
	   "jane@contoso.com",
	   "ben@contoso.com",
	   "Quarterly data report.",
	   "See the attached spreadsheet.");

	// Create  the file attachment for this e-mail message.
	Attachment data = new Attachment(file, MediaTypeNames.Application.Octet);
	// Add time stamp information for the file.
	ContentDisposition disposition = data.ContentDisposition;
	disposition.CreationDate = System.IO.File.GetCreationTime(file);
	disposition.ModificationDate = System.IO.File.GetLastWriteTime(file);
	disposition.ReadDate = System.IO.File.GetLastAccessTime(file);
	// Add the file attachment to this e-mail message.
	message.Attachments.Add(data);

	//Send the message.
	SmtpClient client = new SmtpClient(server);
	// Add credentials if the SMTP server requires them.
	client.Credentials = CredentialCache.DefaultNetworkCredentials;

    try {
	  client.Send(message);
	}
	catch (Exception ex) {
	  Console.WriteLine("Exception caught in CreateMessageWithAttachment(): {0}", 
                  ex.ToString() );			  
	}
	// Display the values in the ContentDisposition for the attachment.
	ContentDisposition cd = data.ContentDisposition;
	Console.WriteLine("Content disposition");
	Console.WriteLine(cd.ToString());
	Console.WriteLine("File {0}", cd.FileName);
	Console.WriteLine("Size {0}", cd.Size);
	Console.WriteLine("Creation {0}", cd.CreationDate);
	Console.WriteLine("Modification {0}", cd.ModificationDate);
	Console.WriteLine("Read {0}", cd.ReadDate);
	Console.WriteLine("Inline {0}", cd.Inline);
	Console.WriteLine("Parameters: {0}", cd.Parameters.Count);
	foreach (DictionaryEntry d in cd.Parameters)
	{
		Console.WriteLine("{0} = {1}", d.Key, d.Value);
	}
	data.Dispose();
}

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft