Mailbox settings

API 0.16.0OpenAPIllms-full.txt

Email templates

Up to 100 templates per mailbox. Fields: name, subject, text and html; HTML is sanitized. A template does not send mail by itself.

The template will replace the editor text. Recipients and attachments are preserved.

POST /v1/mailboxes/42/templates
Content-Type: application/json

{"name":"Welcome","subject":"Welcome","text":"Thank you for joining us.","html":"<p>Thank you for joining us.</p>"}

Autoresponder

Automatic replies work while your browser is closed and count towards sending limits. Mailing lists and automated messages are excluded.

Supply autoresponder dates with a time zone; repeat_days ranges from 1 to 30. Replies apply only to new personal messages: From must match Return-Path.

PUT /v1/mailboxes/42/autoresponder
Content-Type: application/json

{"enabled":true,"subject":"Away","text":"I will reply when I return.","starts_at":null,"ends_at":null,"repeat_days":7}

Filters

Up to 100 filters per mailbox and 20 conditions per filter. Conditions compare complete headers; ASCII matching is case-insensitive, other characters are case-sensitive.

The first matching filter applies. Sender rules take priority. Processing existing messages is a separate action.

A filter change returns operation. Applying to history requires an Idempotency-Key of 8–120 characters. Reuse the key when retrying; check status through GET /v1/operations/{operation_id}.

Incoming and custom folders will be processed. Sent, drafts, spam and trash are excluded.

POST /v1/mailboxes/42/filters
Content-Type: application/json

{"name":"Invoices","enabled":true,"match":"all","conditions":[{"field":"subject","operator":"contains","value":"Invoice"}],"mark_read":false,"important":true,"trash":false,"move_to":null}

POST /v1/mailboxes/42/filters/17/apply
Idempotency-Key: apply-filter-0001

Preview

file_infected

A threat was detected. Opening this file is blocked.

file_scan_unavailable

Antivirus is temporarily unavailable. Try again later.

Add preview=pdf to a file or attachment content request for DOC, XLS, XLSX, PPT, PPTX and ODT. Limit: 10 conversions per minute per mailbox.

X-File-Scan: clean and X-File-Scanned-At report the scan result and time. scanned_at in file lists may be null. Results are cached for one hour; threats or an unavailable scanner block file delivery.

GET /v1/mailboxes/42/files/<file_id>/content?preview=pdf

X-File-Scan: clean
X-File-Scanned-At: 2026-10-22T12:00:00Z