- Mailbox API – Authentication and Authorization
- Mailbox API – Schemas
- Mailbox API – Versioning
- Mailbox API – Account
- Mailbox API – Account Settings
- Mailbox API – Account Security
- 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 – BIMI
- 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).
Get
Response
Update
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
Whether the addresses in the address book are automatically included in the Whitelist Default value: true |
||
|
|
|
Whether the addresses not in the address book are automatically excluded from the Blacklist Default value: true |
Response
Whitelist
List
Query parameters
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
The starting position Default value: 0 |
||
|
|
|
The maximum number of retrieved items Default value: the WebMailData pageSize |
Response
Create
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The email address to whitelist |
Response
Update
URL parameters
|
Name |
Type |
Description |
|---|---|---|
|
|
|
The whitelisted email address ID |
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The new email address |
Response
Delete
URL parameters
|
Name |
Type |
Description |
|---|---|---|
|
|
|
The whitelisted email address ID |
Response
If successful, the response will be empty.
Blacklist
List
Query parameters
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
The starting position Default value: 0 |
||
|
|
|
The maximum number of retrieved items Default value: the WebMailData pageSize |
Response
Create
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The email address to blacklist |
Response
Update
URL parameters
|
Name |
Type |
Description |
|---|---|---|
|
|
|
The blacklisted email address ID |
Request body (JSON)
|
Name |
Type |
Required |
Values |
Description |
|---|---|---|---|---|
|
|
|
* |
The new email address |
Response
Delete
URL parameters
|
Name |
Type |
Description |
|---|---|---|
|
|
|
The blacklisted email address ID |
Response
If successful, the response will be empty.
Filters - on/off
List Presets
Response
Get Preset
Response
Choose Preset
Request body (JSON)
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
|
true |
Possible values are: “off”, “strong”, “weak”. |
Response
If successful, the response will be empty.
List Filters
Response
Update Filter
URL parameters
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
|
true |
Filter id to be updated |
Request body (JSON)
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
|
true |
Possible values are: “true”, “false”. |
Response
If successful, the response will be empty.