Applications.Mail.BoxFolders Entity

Contains the folders inside the mailboxes. Entity: Mail_Box_Folders

Default Visualization

Default Display Text Format:
{FolderName:T}
Default Search Members:
FolderName
Name Data Member:
FolderName
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 1 - Track last changes only
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Parent:
Applications.Mail.Boxes
Aggregate Root:
Applications.Mail.Boxes

Attributes

Name	Type	Description
Active	boolean	True when the mail box folder is active. `Required` `Default(true)` `Filter(eq)` `Introduced in version 25.1.0.76`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FolderName	MultilanguageString (254)	Multi-language folder name. `Required` `Filter(eq;like)`
Id	guid
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
ServerFolderID	string (256) nullable	ID of the folder on the mail server in the format of the mail server. `Filter(eq)`
SyncState	string (max) nullable	The synchronization state for the folder. The format of the contents is dependant on the server type. For IMAP, this is last message Id, for Exchange - this is SyncState.
SystemPurpose	SystemPurpose nullable	When not null means that the folder has special system designation. Designations are: M=Mailbox(root folder), I=Inbox, D=Drafts, O=Outbox, S=Sent, T=Trash. `Filter(eq)` `ReadOnly`

References

Name	Type	Description
MailBox	Boxes	The to which this BoxFolder belongs. `Required` `Filter(multi eq)` `ReadOnly` `Owner`
ParentFolder	BoxFolders (nullable)	The parent folder in the folder hierarchy. Null when the folder is a root folder. `Filter(multi eq)`

Attribute Details

Active

True when the mail box folder is active. Required Default(true) Filter(eq) Introduced in version 25.1.0.76

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

FolderName

Multi-language folder name. Required Filter(eq;like)

Type: MultilanguageString (254)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

ServerFolderID

ID of the folder on the mail server in the format of the mail server. Filter(eq)

Type: string (256) nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Maximum Length: 256
Show in UI: ShownByDefault

SyncState

The synchronization state for the folder. The format of the contents is dependant on the server type. For IMAP, this is last message Id, for Exchange - this is SyncState.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: CannotBeShown

SystemPurpose

When not null means that the folder has special system designation. Designations are: M=Mailbox(root folder), I=Inbox, D=Drafts, O=Outbox, S=Sent, T=Trash. Filter(eq) ReadOnly

Type: SystemPurpose nullable
Category: System
Allowed values for the SystemPurpose(Applications.Mail.BoxFolders.md#systempurpose) data attribute
Allowed Values (Applications.Mail.BoxFoldersRepository.SystemPurpose Enum Members)

Value	Description
Mailbox	Mailbox value. Stored as 'M'. Database Value: 'M' Model Value: 0 Domain API Value: 'Mailbox'
Inbox	Inbox value. Stored as 'I'. Database Value: 'I' Model Value: 1 Domain API Value: 'Inbox'
Drafts	Drafts value. Stored as 'D'. Database Value: 'D' Model Value: 2 Domain API Value: 'Drafts'
Outbox	Outbox value. Stored as 'O'. Database Value: 'O' Model Value: 3 Domain API Value: 'Outbox'
Sent	Sent value. Stored as 'S'. Database Value: 'S' Model Value: 4 Domain API Value: 'Sent'
Trash	Trash value. Stored as 'T'. Database Value: 'T' Model Value: 5 Domain API Value: 'Trash'

Supported Filters: Equals
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

MailBox

The to which this BoxFolder belongs. Required Filter(multi eq) ReadOnly Owner

Type: Boxes
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

ParentFolder

The parent folder in the folder hierarchy. Null when the folder is a root folder. Filter(multi eq)

Type: BoxFolders (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST