What this mailbox can do

GET/api/v1/mailbox/capabilities
Requires amailbox token— it acts as one mailbox holder, not as the organization.

Which features this mail server offers this mailbox, and the shared mailboxes it may use. Call it once after signing in and hide what is off.

Errors

Status When
401 No token, or the session expired or was signed out. Sign in again with POST /mailbox-auth/login.
403 The account has a temporary password: until POST /security/password succeeds, every other call answers this with error_code: password_change_required.

Request

GET/api/v1/mailbox/capabilities
curl -X GET 'https://courier.mailyte.com/api/v1/mailbox/capabilities' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'

Response

Successful Response

  • dataobject
    • email_addressstring
    • capabilitiesobject
      • mailboolean
      • sendboolean
      • settingsboolean
      • two_factorboolean
      • rulesboolean
      • forwardingboolean
      • vacationboolean
      • aiboolean
      • calendarboolean
      • contactsboolean
      • scheduled_sendboolean
      • bulk_actionsboolean
    • shared_mailboxesarray<object>
      • addressstring
      • namestring
      • permissionstring

        read, send or full.

      • can_sendboolean
200application/json
{
  "type": "success",
  "msg": "Capabilities",
  "data": {
    "email_address": "ada@yourdomain.com",
    "capabilities": {
      "mail": true,
      "send": true,
      "settings": true,
      "two_factor": true,
      "rules": true,
      "forwarding": true,
      "vacation": true,
      "ai": false,
      "calendar": true,
      "contacts": true,
      "scheduled_send": true,
      "bulk_actions": true
    },
    "shared_mailboxes": [
      {
        "address": "finance@yourdomain.com",
        "name": "Finance",
        "permission": "send",
        "can_send": true
      }
    ]
  }
}

Returned inside the standard envelope.

Errors

StatusWhen
401No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`.
403The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`.

Every status, with what causes it and what to do, is on the error reference.