- Mailbox API – Authentication and Authorization
- Mailbox API – Schemas
- Mailbox API – Versioning
- Mailbox API – Account
- Mailbox API – Account Settings
- Mailbox API – Account Filters
- Mailbox API – Folders
- Mailbox API – Mails
- Mailbox API – Mails Create and Send
- Mailbox API – Mails Search
- Mailbox API – Mails Counters
- Mailbox API – Conversations
- Mailbox API – Labels
- Mailbox API – Contacts
- Mailbox API – Batch Operations
- Mailbox API – Undo
- Mailbox API – Error Handling
The Mailbox API is available starting with Axigen X4 (10.4).
List
This endpoint returns a list of conversation instances, starting from a specific (requested) folder.
Conversations are cross-folder, covering all folders except for Spam and Trash (and their children).
Query parameters
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
|
The folder ID |
|
|
|
"subject", "from", "to", "date", "isUnread", "isFlagged", "importance", "hasAttachments" |
The sorting field Default value: last provided value or "date" if not yet set |
|
|
|
|
"ASC", "DESC" |
The sorting direction Default value: last provided value or "DESC" if not yet set |
|
|
|
|
The starting position Default value: 0 |
||
|
|
|
The maximum number of retrieved items Default value: the WebMailData pageSize |
||
|
|
|
The active conversation ID is used to generate the activeRowIndex property. Note: this is used to compute server-side the absolute index in the list for the provided conversation item (used mainly for clients to restore selections etc.) |
||
|
|
|
|
|
When true, the endpoint should only return the syncToken without the conversation list. Default value: false |
Response
Get
URL parameters
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The conversation ID |
Query parameters
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
The starting position Default value: 0 |
||
|
|
|
The maximum number of retrieved items Default value: the WebMailData pageSize |
||
|
|
|
The array of mailIds to be retrieved from the specified conversation.
|
||
|
|
|
|
|
When true, the endpoint should only return the syncToken without the mail list. Default value: false |
If sent and not empty, overrides 
Response
Get conversation from mail
URL parameters
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The mail ID |
Response
If successful, the response will contain an instance of conversation.
Update
Updating isUnread affects all members of the conversation that are not in the Sent or Drafts folders, while updating isFlagged affects all members of the conversation.
Conversations are cross-folder, covering all folders except for Spam and Trash (and their children).
URL parameters
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The conversation ID |
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
The unread / read value |
||
|
|
|
The flagged / not flagged value |
Response
If successful, the response will contain an instance of conversation.
Move
This operation affects all members of the conversation that are not in the Sent or Drafts folders.
Conversations are cross-folder, covering all folders except for Spam and Trash (and their children).
URL parameters
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The conversation ID |
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The destination folder ID |
Response
If successful, the response will contain an instance of conversation.
Conversations can be moved to Spam. In this case, all the mails from the ConversationInstance are moved to Spam and the Conversation data is deleted.
This will result in a 200 OK response with an empty body, signaling that the Conversation doesn’t exist anymore.
Delete
URL parameters
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The conversation ID |
Response
If successful, the response will be empty.
Add Label
URL parameters
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The conversation ID |
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The label ID |
Response
If successful, the response will be empty.
Remove Label
URL parameters
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The conversation ID |
|
|
|
|
* |
The label ID |
Response
If successful, the response will be empty.
Spam Marker
Starting with version 10.5.27.
Mark as Spam
This operation affects all members of the conversation that are not in the Sent or Drafts folders.
Conversations are cross-folder, covering all folders except for Spam and Trash (and their children).
URL parameters
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The conversation ID |
Response
If successful, the response will be empty.