GET
/v1/me/mail/mailboxesWhat a mailbox picker draws. The unread counts come with the list rather than from a call each, because this is the first thing an app asks for and the counts are the reason it asks.
Which mailboxes appear is decided by the environment: either the account is
named on a mailbox, or its role is, or it holds manage_mailbox and sees all of
them.
Request
curl https://api.proppertrading.com/v1/me/mail/mailboxes \
-H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f"
Response
{
"data": [
{
"id": "mbx_w6sy3skvgydh5e3b",
"object": "mailbox",
"email": "[email protected]",
"name": "Acme Support",
"is_catch_all": true,
"unread": 7,
"notify": true,
"channel": "private-mail-address.mbx_w6sy3skvgydh5e3b"
}
],
"meta": {
"request_id": "req_01kz4bkr1aj1gv63d8fv3133ey",
"unread": 7,
"storage": {
"used": 419430400,
"limit": 53687091200,
"percent": 0.8,
"unlimited": false
}
}
}
| Field | Description |
|---|---|
id | The mailbox, such as mbx_w6sy3skvgydh5e3b. What address_id on a message, mailbox on the message list, the assignees and the signatures, and the keys of meta.defaults on the signatures refer to |
is_catch_all | Everything addressed to the domain that has no mailbox of its own lands here |
unread | Unread in that mailbox's inbox. meta.unread is the same across all of them, which is the number for a badge |
notify | Whether this account gets phone notifications for this mailbox. Changed with mailbox notifications |
channel | The socket channel that hears mail.received for this mailbox, such as private-mail-address.mbx_w6sy3skvgydh5e3b. Subscribe to it as it is rather than building it from id |
meta.storage | Bytes used and allowed, with the percentage worked out. The whole firm's storage rather than one mailbox's, and everything they keep rather than the mail alone: attachments, images inside messages, ticket screenshots. Nothing is refused when it is full, so treat this as something to show, never as a reason to stop uploading. unlimited is true for a workspace with no limit at all, and then limit is 0 and percent is 0 |
Errors
| Status | Code | Meaning |
|---|---|---|
| 403 | insufficient_scope | This device does not hold mail:read |
| 403 | mailbox_not_permitted | The account may not open a mailbox at all |