mailboxes

Provision a new mailbox

Creates the mailbox row, seeds its default policy, and provisions the domain/user/mailbox in Stalwart, all inside one transaction — a Stalwart provisioning failure rolls back the DB row. Subject to the account tier's mailbox limit.

post/v1/mailboxes

Request

  • Base URL: https://mbag.ai/api
  • URL: https://mbag.ai/api/v1/mailboxes
  • Auth: HTTP bearer

Request body

descriptionstring nullable
domain_idinteger required
email_local_partstring nullable

Local part of the mailbox address. Lowercased; must be 1-64 chars of alphanumerics, ., -, _. Falls back to a normalised form of name when omitted or invalid.

namestring required

Response

Mailbox created.

created_atstring date-time required
descriptionstring nullable
domain_idinteger required
email_addressstring required
idinteger required
is_activeboolean required
namestring required
updated_atstring date-time required
user_idinteger required

Changes

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