Class TopFolder

Namespace

Dynamicweb.EmailMarketing

Assembly

Dynamicweb.EmailMarketing.dll

Represents top folder

[PermissionEntity("TopFolder")]
public class TopFolder : DbObject, IPermissionEntity, IPermissionEntityLookup

Inheritance

object

DbObject

TopFolder

Implements

IPermissionEntity

IPermissionEntityLookup

Inherited Members

DbObject._id

DbObject._tableName

DbObject._keyField

DbObject.ID

DbObject.IsNew

DbObject.Delete()

DbObject.Delete(int)

DbObject.Load(int)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

PermissionEntityExtensions.GetPermission(IPermissionEntity)

PermissionEntityExtensions.GetPermissionIdentifier(IPermissionEntity)

PermissionEntityExtensions.HasPermission(IPermissionEntity, PermissionLevel)

Constructors

TopFolder()

Initializes a new instance of the EmailFolder class.

public TopFolder()

Properties

DeliveryProviderId

Gets or sets the delivery provider id.

public int DeliveryProviderId { get; set; }

Property Value

int

The delivery provider id.

Description

Gets or sets the description.

public string? Description { get; set; }

Property Value

string

The description.

DomainName

Domain Url

public string? DomainName { get; set; }

Property Value

string

EmailsCount

public int EmailsCount { get; }

Property Value

int

EngagementIndex

Gets or sets the EmailEngagementIndex.

public EmailEngagementIndex? EngagementIndex { get; set; }

Property Value

EmailEngagementIndex

FolderName

Gets or sets the name.

public string? FolderName { get; set; }

Property Value

string

The name.

QuarantinePeriod

Gets or sets the quarantine period (in minutes). The period in which the same Recipient is quarantined from receiving the same Email.

public int QuarantinePeriod { get; set; }

Property Value

int

The quarantine period. This cannot be negative. Default is 0, indicating no quarantine period.

RecipientProvider

Gets the EmailRecipientProvider.

public EmailRecipientProvider? RecipientProvider { get; }

Property Value

EmailRecipientProvider

RecipientProviderConfiguration

Gets or sets the configuration for the EmailRecipientProvider.

public string? RecipientProviderConfiguration { get; set; }

Property Value

string

The recipient provider configuration.

RecipientSpecificContent

Gets or sets value indicating whether to render content for each recipient.

public bool RecipientSpecificContent { get; set; }

Property Value

bool

true if need to render content for each recipient; otherwise, false.

SenderEmail

Gets or sets the sender email.

public string? SenderEmail { get; set; }

Property Value

string

The sender email.

SenderName

Gets or sets the name of the sender.

public string? SenderName { get; set; }

Property Value

string

The name of the sender.

Subject

Gets or sets the subject.

public string? Subject { get; set; }

Property Value

string

The subject.

TrackingProvider

Gets the EmailTrackingProvider.

public EmailTrackingProvider? TrackingProvider { get; }

Property Value

EmailTrackingProvider

TrackingProviderConfiguration

Gets or sets the configuration for the EmailTrackingProvider.

public string? TrackingProviderConfiguration { get; set; }

Property Value

string

The tracking provider configuration.

UnsubscribePageId

Gets or sets the Id for the Page where Unsubscribe is located.

public int UnsubscribePageId { get; set; }

Property Value

int

The unsubscription page id.

UnsubscribeText

Gets or sets the description text for the Page where Unsubscribe is located.

public string? UnsubscribeText { get; set; }

Property Value

string

The unsubscription page text.

Methods

Fill(IDataReader)

Fills the specified reader.

public override void Fill(IDataReader reader)

Parameters

reader IDataReader

The reader.

FillRow(DataRow)

Fills the row.

protected override void FillRow(DataRow row)

Parameters

row DataRow

The row.

GetAllTopFolders()

Gets all top folders.

public static TopFolderCollection GetAllTopFolders()

Returns

TopFolderCollection

The collection of top folders

GetTopFolderByID(int)

Gets the top folder by id.

public static TopFolder? GetTopFolderByID(int folderID)

Parameters

folderID int

The folder id.

Returns

TopFolder

The top folder

Save()

Saves current data to the database.

public override void Save()