- Mailbox API – Authentication and Authorization
- Mailbox API – Schemas
- Mailbox API – Versioning
- Mailbox API – Service
- 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
This endpoint can be used for displaying the total number of unread items before actually opening a client application (as a badge for a mobile app, for example). Only the unread items in the Inbox folder are considered. New mails that are added directly into other mailboxes are not considered!
This endpoint requires authentication but it does not require an active session. As a consequence, it is not necessary to call the Login API before calling this endpoint.
Calling this endpoint will not result in a new API session.
If a session id is used, the server tries to use the corresponding session. If no session id is used, the server tries to login the user, generating a session that is removed immediately after the endpoint is executed.
Important note on data latency
In clustered environments the response from this endpoint is cached for up to 60 seconds.
Changes to the mailbox state (e.g., marking a message as read) may not be reflected in the unreadCount value until this cache TTL (Time To Live) expires. This is an intentional architectural design to ensure server stability and prevent performance degradation from high-frequency polling.
Response