Class EmailFolder

Namespace

Dynamicweb.EmailMarketing

Assembly

Dynamicweb.EmailMarketing.dll

Represents email folder

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

Inheritance

object

DbObject

EmailFolder

Implements

IPermissionEntity

IPermissionEntityLookup

Inherited Members

DbObject._id

DbObject._tableName

DbObject._keyField

DbObject.ID

DbObject.IsNew

DbObject.Delete()

DbObject.Delete(int)

DbObject.Load(int)

DbObject.Save()

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

EmailFolder()

Initializes a new instance of the EmailFolder class.

public EmailFolder()

Properties

EmailsCount

public int EmailsCount { get; }

Property Value

int

HasChildFolders

public bool HasChildFolders { get; }

Property Value

bool

Name

Gets or sets the name of folder.

public string? Name { get; set; }

Property Value

string

The name.

ParentId

Gets or sets the parent folder ID of the email folder.

public int ParentId { get; set; }

Property Value

int

The parent folder ID.

TopFolderID

Gets or sets the top folder ID of the email folder.

public int TopFolderID { get; set; }

Property Value

int

The top folder ID.

Methods

Fill(IDataReader)

Fills the specified data reader.

public override void Fill(IDataReader datareader)

Parameters

datareader IDataReader

The data reader.

FillRow(DataRow)

Fills the data row.

protected override void FillRow(DataRow row)

Parameters

row DataRow

The data row.

GetAllCustomFolders(bool, int)

Gets all custom folders.

public static IEnumerable<EmailFolder> GetAllCustomFolders(bool onlyParent, int topFolderId)

Parameters

onlyParent bool

if set to true parent only.

topFolderId int

The top folder id.

Returns

IEnumerable<EmailFolder>

The colection of folders

GetAllEmailsFolders()

Gets all emails folders.

public static IEnumerable<EmailFolder> GetAllEmailsFolders()

Returns

IEnumerable<EmailFolder>

All folders

GetEmailsCustomFoldersByParentId(int)

Gets emails custom folder using parent id value

public static List<EmailFolder> GetEmailsCustomFoldersByParentId(int parentID)

Parameters

parentID int

Id of parent folder

Returns

List<EmailFolder>

List of email folders

GetEmailsCustomFoldersByTopFolderId(int)

Gets email custom folders by id of top folder

public static List<EmailFolder> GetEmailsCustomFoldersByTopFolderId(int topFolderID)

Parameters

topFolderID int

Top folder id

Returns

List<EmailFolder>

List of email folders

GetEmailsFolderById(int)

Gets the emails folder by id.

public static EmailFolder? GetEmailsFolderById(int folderId)

Parameters

folderId int

The folder id.

Returns

EmailFolder

The folder

GetEmailsFolderIdByFolderName(string, int)

Gets the name of the emails folder id by folder.

public static int GetEmailsFolderIdByFolderName(string folderName, int topFolderID)

Parameters

folderName string

Name of the folder.

topFolderID int

The top folder id.

Returns

int

The id of folder

GetEmailsFolderTopFolderId(string)

Gets the emails folder top folder id.

public static int GetEmailsFolderTopFolderId(string folderID)

Parameters

folderID string

The folder id.

Returns

int

The id of top folder

GetEmailsFoldersByParentId(int)

Gets the emails folders by parent id.

public static IEnumerable<EmailFolder> GetEmailsFoldersByParentId(int parentID)

Parameters

parentID int

The parent id.

Returns

IEnumerable<EmailFolder>

The colection of folders

GetEmailsFoldersByTopFolderId(int)

Gets the emails folders by top folder id.

public static IEnumerable<EmailFolder> GetEmailsFoldersByTopFolderId(int topFolderID)

Parameters

topFolderID int

The top folder id.

Returns

IEnumerable<EmailFolder>

The colection of folders

IsDraftSystemFolder(EmailFolder)

public static bool IsDraftSystemFolder(EmailFolder folder)

Parameters

folder EmailFolder

Returns

bool

IsScheduledSystemFolder(EmailFolder)

public static bool IsScheduledSystemFolder(EmailFolder folder)

Parameters

folder EmailFolder

Returns

bool

IsSentSystemFolder(EmailFolder)

public static bool IsSentSystemFolder(EmailFolder folder)

Parameters

folder EmailFolder

Returns

bool

IsSystemFolder(EmailFolder)

public static bool IsSystemFolder(EmailFolder folder)

Parameters

folder EmailFolder

Returns

bool

IsSystemFolder(string?, int)

Determines whether is system folder by specified folder name or folder id.

public static bool IsSystemFolder(string? folderName, int folderId)

Parameters

folderName string

Name of the folder.

folderId int

The folder id.

Returns

bool

true if system folder; otherwise, false.