Mailboxes

Get a mailbox

Returns details for a single mailbox. Requires scope mailboxes:read.

get/mailboxes/{address}

Request

Base URL: https://faivelo.com/api/v1
URL: https://faivelo.com/api/v1/mailboxes/{address}
Auth: HTTP bearer

Path parameters

addressstring required

Full mailbox address, e.g. user@yourdomain.com

Response

Mailbox details

successboolean

Example response

{
  "success": true,
  "data": {
    "localPart": "jane",
    "fullAddress": "jane@yourdomain.com",
    "displayName": "Jane Doe",
    "active": true,
    "storage": {
      "usedBytes": 3221225472,
      "limitBytes": 53687091200,
      "availableBytes": 50465865728
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.