Mailbox API – Mails Counters

APIs & Tools

The Mailbox API is available starting with Axigen X4 (10.4).


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.