Table of Contents

Class EmailInfo

Namespace
CMS.EmailEngine
Assembly
CMS.EmailEngine.dll

EmailInfo data container class.

public class EmailInfo : AbstractInfo<EmailInfo, IEmailInfoProvider>, IExtensible, IInfo, IAdvancedDataContainer, ICMSObject, IHierarchicalDataContainer, IDataContainer, ISimpleDataContainer, IVirtualHierarchicalObject, IHierarchicalObject, INameIndexable, IMacroObject, IInfoWithId
Inheritance
object
EmailInfo
Implements
Inherited Members
Extension Methods

Constructors

EmailInfo()

Constructor - Creates an empty EmailInfo object.

public EmailInfo()

EmailInfo(EmailMessage)

Creates a new EmailInfo object from the specified EmailMessage.

public EmailInfo(EmailMessage message)

Parameters

message EmailMessage

Email message to copy data from

Exceptions

ArgumentNullException

message cannot be null

EmailInfo(DataRow)

Constructor - Creates a new EmailInfo object from the given DataRow.

public EmailInfo(DataRow dr)

Parameters

dr DataRow

Fields

OBJECT_TYPE

Object type

public const string OBJECT_TYPE = "cms.email"

Field Value

string

TYPEINFO

Type information.

public static ObjectTypeInfo TYPEINFO

Field Value

ObjectTypeInfo

Properties

EmailBcc

E-mail Bcc.

public virtual string EmailBcc { get; set; }

Property Value

string

EmailBody

E-mail body.

public virtual string EmailBody { get; set; }

Property Value

string

EmailCc

E-mail Cc.

public virtual string EmailCc { get; set; }

Property Value

string

EmailCreated

Timestamp of object creation. Is set when creating a new object.

public virtual DateTime EmailCreated { get; set; }

Property Value

DateTime

EmailEmailConfigurationID

Email configuration id.

public virtual int EmailEmailConfigurationID { get; set; }

Property Value

int

EmailFormat

E-mail format - Html, PlainText, Both, Default (default).

public virtual EmailFormatEnum EmailFormat { get; set; }

Property Value

EmailFormatEnum

EmailFrom

E-mail from.

public virtual string EmailFrom { get; set; }

Property Value

string

EmailGUID

E-mail GUID.

public virtual Guid EmailGUID { get; set; }

Property Value

Guid

EmailHeaders

Gets or sets additional email headers to append to email message.

public virtual string EmailHeaders { get; set; }

Property Value

string

EmailID

E-mail ID.

public virtual int EmailID { get; set; }

Property Value

int

EmailLastSendAttempt

E-mail last send attempt.

public virtual DateTime EmailLastSendAttempt { get; set; }

Property Value

DateTime

EmailLastSendResult

E-mail last send result.

public virtual string EmailLastSendResult { get; set; }

Property Value

string

EmailMailoutGuid

Email mailout guid.

public virtual Guid EmailMailoutGuid { get; set; }

Property Value

Guid

EmailPlainTextBody

E-mail plain text body.

public virtual string EmailPlainTextBody { get; set; }

Property Value

string

EmailPriority

E-mail priority - Low, Normal (default), High.

public virtual EmailPriorityEnum EmailPriority { get; set; }

Property Value

EmailPriorityEnum

EmailReplyTo

E-mail reply to.

public virtual string EmailReplyTo { get; set; }

Property Value

string

EmailStatus

E-mail status - Created, Waiting, Sending, Archived.

public virtual EmailStatusEnum EmailStatus { get; set; }

Property Value

EmailStatusEnum

EmailSubject

E-mail subject.

public virtual string EmailSubject { get; set; }

Property Value

string

EmailTo

E-mail to.

public virtual string EmailTo { get; set; }

Property Value

string

Methods

DeleteDataInternal()

Deletes main object with its dependencies via stored procedure "Proc_CMS_Email_DeleteEmail".

protected override void DeleteDataInternal()

DeleteDataInternalAsync(CancellationToken)

Asynchronously deletes main object with its dependencies via stored procedure "Proc_CMS_Email_DeleteEmail".

protected override Task DeleteDataInternalAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task

DeleteObject()

Deletes the object using appropriate provider.

protected override void DeleteObject()

RemoveObjectDependencies(bool, bool)

Removes object dependencies. First tries to execute removedependencies query, if not found, automatic process is executed.

protected override void RemoveObjectDependencies(bool deleteAll = false, bool clearHashtables = true)

Parameters

deleteAll bool

If false, only required dependencies are deleted, dependencies with default value are replaced with default value and nullable values are replaced with null

clearHashtables bool

If true, hashtables of all objecttypes which were potentionally modified are cleared

SetObject()

Updates the object using appropriate provider.

protected override void SetObject()