Group 9 of 25
Mailboxes, quotas, forwarders, autoresponders, vacation and delivery tracing.
Endpoints
41
Path prefix
/api/v1
Endpoints
GET
/api/v1/email/deliverability
Check email deliverability (SPF/DKIM/DMARC/MX)
R
GET
/api/v1/email/dkim
Get DKIM state (or attempt to enable it)
R
GET
/api/v1/email/settings
Get mail-client (IMAP/POP/SMTP) settings
R
GET
/api/v1/email/account
Get one mailbox's usage and limits
R
GET
/api/v1/email/spam-settings
Get or update SpamAssassin settings
R
GET
/api/v1/email/catch-all
Get the catch-all mode
R
GET
/api/v1/email/messages/folders
List a mailbox's folders with unread counts
R
GET
/api/v1/email/autoresponders
List autoresponders
R
GET
/api/v1/email/usage
List mailboxes by usage
R
GET
/api/v1/email/accounts
List mailboxes with usage and quota
R
GET
/api/v1/email/vacation
List vacation messages
R
GET
/api/v1/email/filters
List, add or remove mail-filter rules
R
GET
/api/v1/email/forwarders
List, create or delete email forwarders
W
GET
/api/v1/email/mx-probe
Probe a domain's mail exchangers over live SMTP
R
GET
/api/v1/email/logs
Read mail-log lines for a mailbox
R
GET
/api/v1/email/messages/detail
Read one email message
R
GET
/api/v1/email/messages
Search or list messages in a mail folder
R
GET
/api/v1/email/queue
Show the mail queue
R
GET
/api/v1/email/trace
Trace what happened to a message
R
POST
/api/v1/email/accounts
Create a mailbox
W
POST
/api/v1/email/account/actions/webmail-sso
Get the webmail login page for a mailbox
W
POST
/api/v1/email/filters
List, add or remove mail-filter rules
W
POST
/api/v1/email/forwarders
List, create or delete email forwarders
W
POST
/api/v1/email/autoresponders
List, create, update or delete autoresponders
W
POST
/api/v1/email/vacation
List, create, update or delete vacation messages
W
POST
/api/v1/email/messages/actions/organize
Move, flag, trash or organize messages and folders
W
POST
/api/v1/email/account/actions/suspend
Suspend or unsuspend a mailbox
W
PUT
/api/v1/email/accounts/password
Change a mailbox password
W
PUT
/api/v1/email/dkim
Get DKIM state (or attempt to enable it)
W
PUT
/api/v1/email/spam-settings
Get or update SpamAssassin settings
W
PUT
/api/v1/email/autoresponders
List, create, update or delete autoresponders
W
PUT
/api/v1/email/vacation
List, create, update or delete vacation messages
W
PUT
/api/v1/email/catch-all
Set the catch-all mode
W
PATCH
/api/v1/email/accounts/quota
Change a mailbox quota
W
PATCH
/api/v1/email/account
Change a mailbox send limit or quota
W
DELETE
/api/v1/email/account
Hold a mailbox deletion for confirmation
W
DELETE
/api/v1/email/filters
List, add or remove mail-filter rules
W
DELETE
/api/v1/email/forwarders
List, create or delete email forwarders
W
DELETE
/api/v1/email/autoresponders
List, create, update or delete autoresponders
W
DELETE
/api/v1/email/vacation
List, create, update or delete vacation messages
W
DELETE
/api/v1/email/account/actions/suspend
Suspend or unsuspend a mailbox
W