Table of Contents

Applications.Mail.Boxes Entity

Namespace: Applications.Mail

Represents user mailboxes. Entity: Mail_Boxes

Default Visualization

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

Track Changes

Min level: 0 - Do not track changes
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 Tree

Attributes

Name Type Description
Active boolean True when the mail box is active for mail sinchronization, sending and receiving. Required Default(true) Filter(eq)
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EmailAddress string (254) The email address associated with this mail box. Required Filter(eq)
Id guid
IsDefault boolean True when this is the default mailbox for the user. Required Default(true) Filter(eq)
IsEncrypted boolean True when the mailbox messages are stored in encrypted format. Required Default(false) Filter(eq)
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.
ResetOnNextSync boolean Reset is pending: true = next sync should delete and retrieve again all messages; false = no pending reset. Required Default(false) Filter(eq) ReadOnly
SendServerAddress string (254) nullable The address of the server to use for sending mail. The same credentials as the sync server are used. When null, the mail will be sent using the default server, which is setup at the application server.
SentItemsFolderName string (254) nullable The name of the SentItems folder. It is left empty, EnterpriseOne won't save the sent mail in any folder (but it is still possible that the actual mail server would nevertheless save the mail in a sent items folder, independently from EnterpriseOne).
SignatureHtml string (max) nullable Html text of the default signature, when creating new emails from this mailbox. When is null, a default generic signature is attached.
SyncPassword string (512) nullable The password to supply to the server when retrieving email. null when the connection is not setup or the server does not require user name.
SyncProtocol SyncProtocol nullable Synchronization protocol, 'POP3' or 'IMAP'. null means that syncrhonization is not setup.
SyncServerAddress string (254) nullable Incoming and outgoing mail server internet address. null when synchronization is not setup.
SyncUserName string (64) nullable User name to supply to the server, when retrieving email. null when the connection is not setup or the server does not require user name.

References

Name Type Description
OwnerUser Users The user, who owns the mailbox. Required Filter(multi eq)

Child Collections

Name Type Description
Folders BoxFolders List of BoxFolder(Applications.Mail.BoxFolders.md) child objects, based on the Applications.Mail.BoxFolder.MailBox(Applications.Mail.BoxFolders.md#mailbox) back reference

Attribute Details

Active

True when the mail box is active for mail sinchronization, sending and receiving. Required Default(true) Filter(eq)

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

EmailAddress

The email address associated with this mail box. Required Filter(eq)

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

Id

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

IsDefault

True when this is the default mailbox for the user. Required Default(true) Filter(eq)

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

IsEncrypted

True when the mailbox messages are stored in encrypted format. Required Default(false) Filter(eq)

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

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

ResetOnNextSync

Reset is pending: true = next sync should delete and retrieve again all messages; false = no pending reset. Required Default(false) Filter(eq) ReadOnly

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

SendServerAddress

The address of the server to use for sending mail. The same credentials as the sync server are used. When null, the mail will be sent using the default server, which is setup at the application server.

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

SentItemsFolderName

The name of the SentItems folder. It is left empty, EnterpriseOne won't save the sent mail in any folder (but it is still possible that the actual mail server would nevertheless save the mail in a sent items folder, independently from EnterpriseOne).

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

SignatureHtml

Html text of the default signature, when creating new emails from this mailbox. When is null, a default generic signature is attached.

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

SyncPassword

The password to supply to the server when retrieving email. null when the connection is not setup or the server does not require user name.

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

SyncProtocol

Synchronization protocol, 'POP3' or 'IMAP'. null means that syncrhonization is not setup.

Type: SyncProtocol nullable
Category: System
Allowed values for the SyncProtocol(Applications.Mail.Boxes.md#syncprotocol) data attribute
Allowed Values (Applications.Mail.BoxesRepository.SyncProtocol Enum Members)

Value Description
Recommended Recommended value. Stored as 'IMAP'.
Database Value: 'IMAP'
Model Value: 0
Domain API Value: 'Recommended'
POP3 POP3 value. Stored as 'POP3'.
Database Value: 'POP3'
Model Value: 1
Domain API Value: 'POP3'
MicrosoftExchange MicrosoftExchange value. Stored as 'MEWS'.
Database Value: 'MEWS'
Model Value: 2
Domain API Value: 'MicrosoftExchange'
NOSYNC Synchronization is not performed. Stored as 'NSNC'.
Database Value: 'NSNC'
Model Value: 3
Domain API Value: 'NOSYNC'

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

SyncServerAddress

Incoming and outgoing mail server internet address. null when synchronization is not setup.

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

SyncUserName

User name to supply to the server, when retrieving email. null when the connection is not setup or the server does not require user name.

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

Reference Details

OwnerUser

The user, who owns the mailbox. Required Filter(multi eq)

Type: Users
Indexed: True
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

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    The notification subject.
    Type: string

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

Front-End Business Rules

None

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Applications_Mail_Boxes?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Applications_Mail_Boxes?$top=10

Suggest improvement to this page