Read settings

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

The mailbox holder's own settings, and storage used.

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/settings
curl -X GET 'https://courier.mailyte.com/api/v1/mailbox/settings' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'

Response

Successful Response

  • dataobject
    • email_addressstring
    • namestring or null

      The display name recipients see.

    • signature_htmlstring
    • signature_on_replyboolean
    • display_densitystringcomfortable | compact
    • undo_send_enabledboolean
    • undo_send_secondsinteger5 | 10 | 20 | 30
    • storageobject
      • used_mbnumber
      • quota_mbnumber
      • percentagenumber or null
200application/json
{
  "type": "success",
  "msg": "Settings retrieved successfully",
  "data": {
    "email_address": "ada@yourdomain.com",
    "name": "Ada Obi",
    "signature_html": "<p>Ada Obi<br>Head of Finance</p>",
    "signature_on_reply": true,
    "display_density": "comfortable",
    "undo_send_enabled": true,
    "undo_send_seconds": 10,
    "storage": {
      "used_mb": 812.4,
      "quota_mb": 5120,
      "percentage": 15.9
    }
  }
}

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.