Mailboxes
Provision a hosted mailbox on an active hosted domain of the organization. The password is generated and sealed server-side and never returned. A taken address is 409, a reserved local part 422, no mail server configured 503, a mail-server refusal 502. Honours Idempotency-Key. (scope: mailboxes:write)
POST
bearerAuthheader
AuthorizationBearer <token>API key as Bearer token
application/json- body
domain_id*stringAn active hosted mail domain of the organization (GET /mail-domains).
Format
uuidlocal_part*stringThe part before @. Role addresses (postmaster, abuse, admin, support …) are reserved (422).
Match
^[A-Za-z0-9]([A-Za-z0-9._-]*[A-Za-z0-9])?$Length
1 <= length <= 64display_name?stringLength
length <= 255quota_mb?integerDefault 5120.
Range
256 <= value <= 51200OK
application/json- response
data*No password: it is generated and sealed server-side and never returned.
error*nullcurl -X POST "https://example.com/mailboxes" \ -H "Content-Type: application/json" \ -d '{ "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c", "local_part": "string" }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "address": "user@example.com", "status": "pending" }, "error": null}The organization's hosted mail domains, read-only; adding and verifying a domain happen in the app (scope: mailboxes:read) GET
Previous Page
Delete the mailbox on the mail server first, then its record (its aliases go with it); a mail-server refusal is 502 and keeps it. Honours Idempotency-Key. (scope: mailboxes:write) DELETE
Next Page