Table of Contents

Applications.Mail.Messages Entity

Namespace: Applications.Mail

Represents email messages. Entity: Mail_Messages

Default Visualization

Default Display Text Format:
{CreationDateTime:d} : {Subject}
Default Search Members:
__
Category: Definitions
Show in UI: ShownByDefault
API access: ReadWrite

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 Tree

Attributes

Name Type Description
Body string (max) nullable The body of the message.
CcEmailAddressList string (2048) nullable Semicolon-separated list of Cc email addresses. Filter(like)
CreationDateTime datetime Date and time when the message was created. Required Default(Now) Filter(ge;le)
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
ExternalId string The id of the object, when it is imported/synchronized with external system. Used by sync apps to identify the object in external systems. [Filter(multi eq)] [ORD] [Introduced in version 24.1.0.89]
ExternalSystem string The name of the external system from which the object is imported/synchronized. [Filter(multi eq)] [Introduced in version 24.1.0.89]
FromEmailAddress string (512) Sending email address. Required Filter(like)
Id guid
IsEncrypted boolean True when the message is stored in encrypted format. Required Default(false) Filter(eq)
IsRead boolean True when the message was read by the user. 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.
ReceivedDateTime datetime nullable Date and time when the message was received. Filter(ge;le)
SentDateTime datetime nullable Date and time when the message was sent. Filter(ge;le)
ServerMessageID string (256) nullable Message ID as it appears on the mail server. Filter(eq) ORD
Subject string (1024) nullable The message subject. Filter(like)
ToEmailAddressList string (2048) nullable Semicolon-separated list of receiving email addresses. Filter(like)

References

Name Type Description
MailBoxFolder BoxFolders The folder where the message belongs. Required Filter(multi eq)
RelatedToParty Parties (nullable) The party id of the external participating (sender/receiver) party (customer, supplier, etc.) in this mail. null means that the email is still not related to any specific party. Filter(multi eq)

Child Collections

Name Type Description
Attachments MessageAttachments List of MessageAttachment(Applications.Mail.MessageAttachments.md) child objects, based on the Applications.Mail.MessageAttachment.MailMessage(Applications.Mail.MessageAttachments.md#mailmessage) back reference

Attribute Details

Body

The body of the message.

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

CcEmailAddressList

Semicolon-separated list of Cc email addresses. Filter(like)

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

CreationDateTime

Date and time when the message was created. Required Default(Now) Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTime
Show in UI: HiddenByDefault

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

ExternalId

The id of the object, when it is imported/synchronized with external system. Used by sync apps to identify the object in external systems. [Filter(multi eq)] [ORD] [Introduced in version 24.1.0.89]

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

ExternalSystem

The name of the external system from which the object is imported/synchronized. [Filter(multi eq)] [Introduced in version 24.1.0.89]

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

FromEmailAddress

Sending email address. Required Filter(like)

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

Id

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

IsEncrypted

True when the message is 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

IsRead

True when the message was read by the user. 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

ReceivedDateTime

Date and time when the message was received. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

SentDateTime

Date and time when the message was sent. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

ServerMessageID

Message ID as it appears on the mail server. Filter(eq) ORD

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

Subject

The message subject. Filter(like)

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

ToEmailAddressList

Semicolon-separated list of receiving email addresses. Filter(like)

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

Reference Details

MailBoxFolder

The folder where the message belongs. Required Filter(multi eq)

Type: BoxFolders
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

RelatedToParty

The party id of the external participating (sender/receiver) party (customer, supplier, etc.) in this mail. null means that the email is still not related to any specific party. Filter(multi eq)

Type: Parties (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

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    The notification subject.
    Type: string

  • priority
    The notification priority.
    Type: Systems.Core.NotificationsRepository.Priority
    Allowed values for the Priority(Systems.Core.Notifications.md#priority) data attribute
    Allowed Values (Systems.Core.NotificationsRepository.Priority Enum Members)

    Value Description
    Background Background value. Stored as 1.
    Model Value: 1
    Domain API Value: 'Background'
    Low Low value. Stored as 2.
    Model Value: 2
    Domain API Value: 'Low'
    Normal Normal value. Stored as 3.
    Model Value: 3
    Domain API Value: 'Normal'
    High High value. Stored as 4.
    Model Value: 4
    Domain API Value: 'High'
    Urgent Urgent value. Stored as 5.
    Model Value: 5
    Domain API Value: 'Urgent'

    Optional: True
    Default Value: Normal

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

None

Front-End Business Rules

API

Domain API Entity Set: Applications_Mail_Messages

Domain API Entity Type: Applications_Mail_Message

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

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

Suggest improvement to this page