Create a mailbox
Creates a Woyra Mail mailbox, local_part@domain, on one of the account's sending domains. The domain must be verified: a mailbox on an unproven domain could never send, and its owner would find that out from a bounce. Mail to the address is delivered once the domain's MX record points at Woyra.
Addresses are unique across mailboxes and aliases, and lower-case. Requires mailboxes:manage.
**Price.** A mailbox costs $3.49 a month with 10 GB, sending included, charged from the account's balance: the first month when it is created, then monthly. A balance that does not cover the first month gets 402 insufficient_funds and no mailbox. Nothing is refunded on deletion; a month is what was bought. Partners that resell Woyra Mail are billed wholesale instead and pay nothing per mailbox here.
Body
| Field | Type | Description |
|---|---|---|
| domain_idrequired | string | |
| local_partrequired | string | The part before the @. 1-64 letters, digits, dots, hyphens, underscores or plus signs, starting and ending with a letter or digit. Lower-cased. |
| quota_bytes | integernull | Storage limit in bytes. A mailbox includes 10 GB (10737418240), which is also the default and the most a directly billed mailbox may have. |
| password | string | Lets the mailbox's owner sign in to Woyra Mail directly
(POST /v1/mail/auth/token). Leave it out for a mailbox
reached only through a partner such as TalariCloud, which
exchanges its key for a token instead. |
Example
curl -X POST https://api.woyra.io/v1/mailboxes \
-H "Authorization: Bearer $WOYRA_KEY" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: create-mailbox-1' \
-d '{
"domain_id": "<domain_id>",
"local_part": "<local_part>"
}'Response
201 The mailbox.
| Field | Type | Description |
|---|---|---|
| objectrequired | "mailbox" | |
| idrequired | string | |
| addressrequired | string | |
| domain_idrequired | string | |
| quota_bytesrequired | integernull | Null is no quota. |
| suspendedrequired | boolean | Delivery stopped; mail retained. |
| suspended_at | timestamp | |
| has_passwordrequired | boolean | Whether someone can sign in to the mailbox directly. |
| past_duerequired | boolean | The monthly charge could not be taken from the balance. Mail still arrives; signing in and sending resume once a top-up clears it. |
| created_atrequired | timestamp |
Errors
Also in Mailboxes
- GET /v1/mailboxes — List mailboxes
- GET /v1/mailboxes/{id} — Get a mailbox
- PATCH /v1/mailboxes/{id} — Change a mailbox's quota, suspension or password
- DELETE /v1/mailboxes/{id} — Delete a mailbox and its mail
- GET /v1/mailboxes/usage — Usage per mailbox for a period
- GET /v1/mailboxes/{id}/messages — List the messages in a folder
- GET /v1/mailboxes/{id}/messages/{message_id} — Read a message
- GET /v1/mailboxes/{id}/messages/{message_id}/attachments/{attachment_id} — Download an attachment by signed link
- POST /v1/mailboxes/{id}/messages/flags — Mark messages read, unread, flagged or unflagged
- POST /v1/mailboxes/{id}/messages/move — Move messages to another folder
- POST /v1/mailboxes/{id}/messages/delete — Delete messages for good
- GET /v1/mailboxes/{id}/changes — What changed in a mailbox since a cursor
- POST /v1/mailboxes/{id}/send — Send a message from a mailbox
- GET /v1/mailboxes/{id}/profile — A mailbox's profile
- PATCH /v1/mailboxes/{id}/profile — Change a mailbox's display name, letterhead or signature
- PUT /v1/mailboxes/{id}/profile/picture — Set a mailbox's picture
- GET /v1/mailboxes/sending_limits — What the account may send today, and why
- POST /v1/mail/auth/token — Get a mailbox token for Woyra Mail's apps
- POST /v1/mail/devices — Register this native device for mailbox notifications
- DELETE /v1/mail/devices — Remove a push destination belonging to this device session
- POST /v1/mail/auth/refresh — Rotate a mailbox device session
- POST /v1/mail/auth/revoke — Revoke this mailbox device session
- GET /v1/mail/sync/changes — What changed in the mailbox since a cursor
- GET /v1/mail/sync/messages — Several messages at once
- GET /v1/mail/messages — A folder's messages, newest first
- GET /v1/mail/search — Search the whole mailbox, newest first
- GET /v1/mail/rules — The mailbox's rules and blocked senders
- POST /v1/mail/rules — Add a rule, or block a sender
- DELETE /v1/mail/rules/{id} — Remove a rule, or unblock a sender
- GET /v1/mail/autoreply — The out-of-office reply
- PUT /v1/mail/autoreply — Set the out-of-office reply
- POST /v1/mail/messages/{id}/unsubscribe — Leave the list a message came from
- POST /v1/mail/messages/{id}/cancel-send — Call back a message sent for later
- POST /v1/mail/messages/send — Send from the token's mailbox
- GET /v1/mail/profile — The token's mailbox profile
- PATCH /v1/mail/profile — Change the display name, letterhead or signature
- PUT /v1/mail/profile/picture — Set the mailbox's picture
- DELETE /v1/mail/profile/picture — Remove the mailbox's picture
- PUT /v1/mail/profile/letterhead-image — Set the picture at the head of the letterhead
- DELETE /v1/mail/profile/letterhead-image — Remove the letterhead picture
- GET /v1/mail/letterheads/{id} — A mailbox's letterhead picture, by signed link
- GET /v1/mail/avatars — Pictures, names and company logos for the addresses a client shows
- GET /v1/mail/logos/{domain} — A company's logo, by signed link
- GET /v1/mail/pictures/{id} — A mailbox's picture, by signed link
- GET /v1/mail/messages/{id} — One message with its body, marking it read
- PATCH /v1/mail/messages/{id} — Mark a message read or unread, star it, or file it in another folder
- GET /v1/mail/messages/{id}/attachments/{attachment_id} — A short-lived link to one attachment
- GET /v1/mail/unread — How many messages in INBOX are unread
- GET /v1/aliases — List aliases
- POST /v1/aliases — Create or repoint an alias
- DELETE /v1/aliases/{id} — Delete an alias