Mailboxes

Create a mailbox

Creates a new mailbox and returns IMAP/SMTP credentials. The password is shown only once in this response. Requires scope mailboxes:write. Limited to 10 mailboxes per key per rolling 24h. When called with an agent key, the new mailbox is automatically granted to that key.

post/mailboxes

Request

  • Base URL: https://faivelo.com/api/v1
  • URL: https://faivelo.com/api/v1/mailboxes
  • Auth: HTTP bearer

Request body

domainstring required
localPartstring required

The part before the @. 1–64 chars, alphanumeric plus ._%+-.

passwordstring

Optional; a secure password is generated if omitted. 8 to 128 characters.

displayNamestring

Display name for the mailbox (max 128 chars)

Example request

{
  "domain": "yourdomain.com",
  "localPart": "jane"
}

Response

Mailbox created with credentials

successboolean

Example response

{
  "success": true,
  "data": {
    "localPart": "jane",
    "fullAddress": "jane@yourdomain.com",
    "active": true,
    "credentials": {
      "imapServer": "mail.faivelo.com",
      "imapPort": 993,
      "smtpServer": "mail.faivelo.com",
      "smtpPort": 465,
      "username": "jane@yourdomain.com",
      "password": "generated-password-here",
      "ssl": true
    }
  }
}

Changes

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