Tài liệu tham khảo API
31 điểm cuối trong khu vực này. Mỗi điểm cuối có trang riêng với các tham số, phản hồi và một yêu cầu bạn có thể chạy.
| Phương thức | Đường dẫn | Chức năng | Quyền |
|---|---|---|---|
| GET | /v1/mail/allowance | What the caller's plan grants for mailboxes. | mail.view |
| GET | /v1/mail/free-tier | What a free mailbox is, and what it costs to provide. | mail.view |
| DELETE | /v1/mail/mailboxes/{mailboxId} | Delete a mailbox. | mail.manage |
| PUT | /v1/mail/mailboxes/{mailboxId} | Change a mailbox's size, or its send/receive switches. | mail.manage |
| POST | /v1/mail/mailboxes/{mailboxId}/password | Reset a mailbox password. | mail.manage |
| POST | /v1/mail/mailboxes/{mailboxId}/rename | Change a mailbox's address, keeping the mail in it. | mail.manage |
| POST | /v1/mail/mailboxes/{mailboxId}/webmail | Open webmail for a mailbox. | mail.manage |
| GET | /v1/mail/preflight | What setting email up on a domain would do to its DNS. | mail.view |
| GET | /v1/mail/reseller-brand | The mail hostnames this reseller's mail is published and served under. | mail.view |
| PUT | /v1/mail/reseller-brand | Set the mail hostnames this reseller's mail carries. | mail.manage |
| GET | /v1/mail/routing | How every domain in this organization has its mail routed. | mail.view |
| GET | /v1/mail/routing/{fqdn} | How one domain's mail is routed. | mail.view |
| PATCH | /v1/mail/routing/{fqdn} | Re-point a forwarding domain's catch-all. | mail.manage |
| GET | /v1/mail/services | List the organization's email services. | mail.view |
| POST | /v1/mail/services | Set email up on a domain. | mail.manage |
| DELETE | /v1/mail/services/{mailServiceId} | Remove a domain's email service. | mail.manage |
| GET | /v1/mail/services/{mailServiceId} | Get one email service. | mail.view |
| GET | /v1/mail/services/{mailServiceId}/connection-settings | IMAP and SMTP settings for a mail client. | mail.view |
| GET | /v1/mail/services/{mailServiceId}/deliverability | SPF, DKIM and DMARC state for a domain that already has email. | mail.view |
| POST | /v1/mail/services/{mailServiceId}/deliverability | Publish this domain's mail records. | mail.manage |
| GET | /v1/mail/services/{mailServiceId}/forwarders | The forwarders on this domain. | mail.view |
| POST | /v1/mail/services/{mailServiceId}/forwarders | Forward an address, a catch-all, or a whole domain. | mail.manage |
| DELETE | /v1/mail/services/{mailServiceId}/forwarders/{forwarderId} | Remove a forwarder. | mail.manage |
| GET | /v1/mail/services/{mailServiceId}/mailboxes | List a domain's mailboxes. | mail.view |
| POST | /v1/mail/services/{mailServiceId}/mailboxes | Create a mailbox. | mail.manage |
| POST | /v1/mail/services/{mailServiceId}/provider | Move a domain's email to a different provider. | mail.manage |
| GET | /v1/mail/services/{mailServiceId}/responders | The auto-responders on this domain. | mail.view |
| POST | /v1/mail/services/{mailServiceId}/responders | Set an auto-reply on a mailbox. | mail.manage |
| DELETE | /v1/mail/services/{mailServiceId}/responders/{responderId} | Remove an auto-reply. | mail.manage |
| PATCH | /v1/mail/services/{mailServiceId}/responders/{responderId} | Edit an auto-reply. | mail.manage |
| POST | /v1/mail/services/{mailServiceId}/retry | Retry a mail service whose setup failed. | mail.manage |