Table of Contents

Class EmailMessage

Namespace
CMS.EmailEngine
Assembly
CMS.EmailEngine.dll

Represents an e-mail message.

public class EmailMessage
Inheritance
object
EmailMessage
Extension Methods

Constructors

EmailMessage()

Initializes a new instance of the EmailMessage class.

public EmailMessage()

EmailMessage(EmailInfo)

Initializes a new instance of the EmailMessage class form the specified emailInfo.

public EmailMessage(EmailInfo emailInfo)

Parameters

emailInfo EmailInfo

Properties

Attachments

Gets the collection of e-mail attachments.

public AttachmentCollection Attachments { get; }

Property Value

AttachmentCollection

BccRecipients

Gets or sets the BccRecipients.

public string BccRecipients { get; set; }

Property Value

string

Remarks

List of addresses of BCC recipients separated by semicolon. The format of the addresses needs to be supported by System.Net.Mail.MailAddress.

Body

Gets or sets the Body.

public string Body { get; set; }

Property Value

string

CcRecipients

Gets or sets the CcRecipients.

public string CcRecipients { get; set; }

Property Value

string

Remarks

List of addresses of CC recipients separated by semicolon. The format of the addresses needs to be supported by System.Net.Mail.MailAddress.

EmailConfigurationID

Email configuration id.

public int EmailConfigurationID { get; set; }

Property Value

int

EmailFormat

Gets or sets the e-mail format.

public EmailFormatEnum EmailFormat { get; set; }

Property Value

EmailFormatEnum

From

Gets or sets the From address.

public string From { get; set; }

Property Value

string

Remarks

This address specifies on whose behalf the message is sent and is visible in the client's email software. The format of the address needs to be supported by System.Net.Mail.MailAddress.

Guid

Unique identifier that can be used to identify the message within the email application.

public Guid Guid { get; set; }

Property Value

Guid

Headers

Gets the collection of extra e-mail header fields (apart from the standard set).

public NameValueCollection Headers { get; }

Property Value

NameValueCollection

MailoutGuid

Mailout guid.

public Guid MailoutGuid { get; set; }

Property Value

Guid

PlainTextBody

Gets or sets plain text body.

public string PlainTextBody { get; set; }

Property Value

string

Priority

Gets or sets e-mail priority which defines order when sending via email queue.

public EmailPriorityEnum Priority { get; set; }

Property Value

EmailPriorityEnum

Recipients

Gets or sets the Recipients.

public string Recipients { get; set; }

Property Value

string

Remarks

List of addresses of recipients separated by semicolon. The format of the addresses needs to be supported by System.Net.Mail.MailAddress.

ReplyTo

Gets or sets the ReplyTo address.

public string ReplyTo { get; set; }

Property Value

string

Remarks

This address specifies where the replies to this message should be sent. The format of the address needs to be supported by System.Net.Mail.MailAddress.

Subject

Gets or sets the Subject.

public string Subject { get; set; }

Property Value

string

Methods

Dispose()

Releases all resources used by the current instance of the EmailMessage class.

public void Dispose()

Dispose(bool)

When overridden in a derived class, releases the unmanaged resources used by the EmailMessage, and optionally releases the managed resources.

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

True to release both managed and unmanaged resources; false to release only unmanaged resources.

SetAttachmentsTransferEncoding(TransferEncoding)

Sets the attachments' transfer encoding property.

public void SetAttachmentsTransferEncoding(TransferEncoding transferEncoding)

Parameters

transferEncoding TransferEncoding

Transfer Encoding to be set in attachments

ToMailMessage(Encoding)

Converts the EmailMessage to System.Net.Mail.MailMessage.

[Obsolete("Use ToMailMessage(Encoding encoding, TransferEncoding transferEncoding) instead.")]
[ObsoleteSince(29, 7)]
public MailMessage ToMailMessage(Encoding encoding)

Parameters

encoding Encoding

Returns

MailMessage

A System.Net.Mail.MailMessage object

ToMailMessage(Encoding, TransferEncoding)

Converts the EmailMessage to System.Net.Mail.MailMessage.

public MailMessage ToMailMessage(Encoding encoding, TransferEncoding transferEncoding)

Parameters

encoding Encoding
transferEncoding TransferEncoding

Returns

MailMessage

A System.Net.Mail.MailMessage object

Remarks

This method doesn't set TransferEncoding value to Attachments. Use method SetAttachmentsTransferEncoding(TransferEncoding) to change value for Attachments.