Mail

The Mail table in the Mail package serves as a centralized repository for managing and tracking email communications within a system. It includes fields for essential information such as sender, recipient, subject line, body content, timestamp, and status (e.g., sent, received, read). This table facilitates the seamless organization of email messages, allows for efficient retrieval and searching of correspondence, and supports automated processes for sending and logging emails, making it a crucial component for applications that rely on email interactions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
int32

The MailId field is an identity field of type integer within the Mail table, uniquely identifying each record. It automatically increments with each new entry, ensuring that every mail instance receives a distinct MailId value, which serves as the primary key for the table. This field facilitates efficient data retrieval and maintains the integrity of the mail records.

string | null

The 'Subject' field in the 'Mail' table is designed to store the subject line of an email message. It is of data type nvarchar, allowing for the inclusion of Unicode characters, and has a maximum length of 256 characters. This field captures a brief and concise indication of the email's content, providing context and relevance for recipients.

string | null

The 'Body' field is of data type nvarchar and is designed to store the main content of an email message. It can accommodate a variable-length string, allowing for the inclusion of text in multiple languages due to its support for Unicode characters. This field is essential for capturing the details of the communication, including any formatting, links, or special characters included in the email body. Its maximum length should be carefully defined to ensure it can handle extensive message content while maintaining database performance and storage efficiency.

date-time
required

The 'Date' field in the 'Mail' table represents the date and time when the email was created or sent. This field uses the datetime2 data type, which allows for high precision in recording time with a range that can encompass dates from January 1, 0001, to December 31, 9999, along with fractional seconds. This enables accurate tracking of email timestamps, essential for sorting and organizing correspondence chronologically.

string | null

The MailStateId field represents a unique identifier for the state of the mail item, stored as a string of variable character data. This identifier can be used to track or categorize the mail's status throughout its lifecycle, with a maximum length of 32 characters. This field allows for flexibility in the representation of various mail states while ensuring data consistency within the Mail table.

string | null

ServerMessageId is a field that stores a unique identifier for messages generated by the server, represented as a variable-length Unicode character string. This identifier is used to track and manage server communications related to email transactions, ensuring proper referencing and retrieval within the Mail table.

string | null

The EntityId field in the Mail table is defined as an nvarchar data type with a maximum length of 450 characters. This field serves to uniquely identify the associated entity, allowing for efficient tracking and referencing of related records within the database. It accommodates alphanumeric characters and special symbols, facilitating the storage of various identification formats, such as user IDs, transaction numbers, or external references. The EntityId is essential for establishing relationships between the Mail table and other entities in the system, ensuring data integrity and supporting effective data retrieval and management.

string | null

The EntityKeyValue field in the Mail table is designed to store a unique identifier for related entities using the nvarchar data type. This field can accommodate variable-length Unicode strings, enabling it to capture diverse key formats and enhance interoperability with various systems. It serves as a critical link for associating mail entries with corresponding entities, ensuring efficient data retrieval and maintaining referential integrity across related datasets.

Headers
string
enum
Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response
200

OK

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!