- 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 – 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).
Undo
Concepts and considerations
-
For each session a stack of reversible operations is stored. The stack is not influenced by actions executed on different sessions.
-
The size of the stack is limited to 16 undo operations. Once the size is exceeded, the oldest reversible operation is evicted.
-
The reversible operation are added to the stack in the order they are initiated.
-
When called, the undo endpoint will attempt to consume the last reversible operation added to the stack of the current session.
When several requests are executed in parallel on a session, there is no control on the order they are registered as reversible operation.
Batch operations
-
A batch operation registers a single reversible operation of type batch.
-
A batch reversible operation is registered as soon as the operation is initiated. It can be undone only after the batch operation is completed. If the undo endpoint is called while a batch operation is in progress for the current session, then the undo operation will fail.
-
Supported batch operations
-
mails and conversations (including batch operations):
-
add – undo moves the message to Trash
-
move
-
copy
-
delete – move to Trash only; no support for permanently deleted items.
-
-
folders
-
create
-
rename
-
move
-
copy
-
delete – move to Trash only; no support for permanently deleted items.
-
-
-
Unsupported batch operations for mails and conversations:
-
update (mark as read / unread, flagged / not flagged)
-
add label
-
remove label
-
Response
If successful, the response will be empty.