- 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).
Mail Batch Operations
Copy
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The destination folder ID |
|
|
|
|
* |
|
The mail IDs to be copied |
|
|
|
* |
|
The list for ranges to be copied |
|
|
|
* (when using ranges) |
|
Sorting information to be used for range calculation |
One of ids or ranges is required.
Response
Depending on the size of the batch, the batch operation will be executed either synchronously or asynchronously.
Synchronous Response
Asynchronous Response
In case the batch is processed asynchronously, the end point will reply with HTTP status code: 201 Created.
Move
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The destination folder ID |
|
|
|
|
* |
|
The mail IDs to be moved |
|
|
|
* |
|
The list for ranges to be copied |
|
|
|
* (when using ranges) |
|
Sorting information to be used for range calculation |
One of ids or ranges is required.
Response
Depending on the size of the batch, the batch operation will be either executed synchronously or asynchronously.
Synchronous Response
Asynchronous Response
In case the batch is processed asynchronously, the end point will reply with HTTP status code: 201 Created.
Delete
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
|
The mail IDs to be deleted |
|
|
|
* |
|
The list for ranges to be copied |
|
|
|
* (when using ranges) |
|
Sorting information to be used for range calculation |
One of ids or ranges is required.
Response
Depending on the size of the batch, the batch operation will be either executed synchronously or asynchronously.
Synchronous Response
Asynchronous Response
In case the batch is processed asynchronously, the end point will reply with HTTP status code: 201 Created.
Update
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The unread / read value |
|
|
|
|
* |
The flagged / not flagged value |
|
|
|
|
* |
|
The mail IDs to be updated |
|
|
|
* |
|
The list for ranges to be copied |
|
|
|
* (when using ranges) |
|
Sorting information to be used for range calculation |
One of ids or ranges is required.
One of isUnread or isFlagged is required.
Response
Depending on the size of the batch, the batch operation will be either executed synchronously or asynchronously.
Synchronous Response
Asynchronous Response
In case the batch is processed asynchronously, the end point will reply with HTTP status code: 201 Created.
Add Label
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
|
The label ID |
|
|
|
* |
|
The mail IDs to which the label should be added |
|
|
|
* |
|
The list for ranges to be copied |
|
|
|
* (when using ranges) |
|
Sorting information to be used for range calculation |
One of ids or ranges is required.
Response
Depending on the size of the batch, the batch operation will be either executed synchronously or asynchronously.
Synchronous Response
Asynchronous Response
In case the batch is processed asynchronously, the end point will reply with HTTP status code: 201 Created.
Remove Label
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
|
The label ID |
|
|
|
* |
|
The mail IDs from which the label should be removed |
|
|
|
* |
|
The list for ranges to be copied |
|
|
|
* (when using ranges) |
|
Sorting information to be used for range calculation |
One of ids or ranges is required.
Response
Depending on the size of the batch, the batch operation will be either executed synchronously or asynchronously.
Synchronous Response
Asynchronous Response
In case the batch is processed asynchronously, the end point will reply with HTTP status code: 201 Created.
Conversations Batch Operations
Move
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The destination folder ID |
|
|
|
|
* |
|
The conversation IDs to be moved |
|
|
|
* |
|
The list for ranges to be copied |
|
|
|
* (when using ranges) |
|
Sorting information to be used for range calculation |
One of ids or ranges is required.
Response
Depending on the size of the batch, the batch operation will be either executed synchronously or asynchronously.
Synchronous Response
Asynchronous Response
In case the batch is processed asynchronously, the end point will reply with HTTP status code: 201 Created.
Delete
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
|
The conversation IDs to be deleted |
|
|
|
* |
|
The list for ranges to be copied |
|
|
|
* (when using ranges) |
|
Sorting information to be used for range calculation |
One of ids or ranges is required.
Response
Depending on the size of the batch, the batch operation will be either executed synchronously or asynchronously.
Synchronous Response
Asynchronous Response
In case the batch is processed asynchronously, the end point will reply with HTTP status code: 201 Created.
Update
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The unread / read value |
|
|
|
|
* |
The flagged / not flagged value |
|
|
|
|
* |
|
The conversation IDs to be updated |
|
|
|
* |
|
The list for ranges to be copied |
|
|
|
* (when using ranges) |
|
Sorting information to be used for range calculation |
One of ids or ranges is required.
One of isUnread or isFlagged is required.
Response
Depending on the size of the batch, the batch operation will be either executed synchronously or asynchronously.
Synchronous Response
Asynchronous Response
In case the batch is processed asynchronously, the end point will reply with HTTP status code: 201 Created.
Add Label
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
|
The label ID |
|
|
|
* |
|
The conversation IDs to which the label should be added |
|
|
|
* |
|
The list for ranges to be copied |
|
|
|
* (when using ranges) |
|
Sorting information to be used for range calculation |
One of ids or ranges is required.
Response
Depending on the size of the batch, the batch operation will be either executed synchronously or asynchronously.
Synchronous Response
Asynchronous Response
In case the batch is processed asynchronously, the end point will reply with HTTP status code: 201 Created.
Remove Label
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
|
The label ID |
|
|
|
* |
|
The conversation IDs from which the label should be removed |
|
|
|
* |
|
The list for ranges to be copied |
|
|
|
* (when using ranges) |
|
Sorting information to be used for range calculation |
One of ids or ranges is required.
Response
Depending on the size of the batch, the batch operation will be either executed synchronously or asynchronously.
Synchronous Response
Asynchronous Response
In case the batch is processed asynchronously, the end point will reply with HTTP status code: 201 Created.