Sanggunian ng API
46 mga endpoint sa lugar na ito. Ang bawat isa ay may sariling pahina kasama ang mga parameter nito, ang tugon nito, at isang kahilingan na maaari ninyong patakbuhin.
| Paraan | Path | Ang ginagawa nito | Pahintulot |
|---|---|---|---|
| GET | /.well-known/autoconfig/mail/config-v1.1.xml | Thunderbird auto-setup (discovery, well-known path). | Walang API key |
| GET | /Autodiscover/Autodiscover.xml | Outlook auto-setup (discovery), capitalised path. | Walang API key |
| POST | /Autodiscover/Autodiscover.xml | Outlook auto-setup (discovery), capitalised path, as Outlook actually asks. | Walang API key |
| GET | /autodiscover/autodiscover.xml | Outlook auto-setup (discovery). | Walang API key |
| POST | /autodiscover/autodiscover.xml | Outlook auto-setup (discovery), as Outlook actually asks. | Walang API key |
| GET | /mail/config-v1.1.xml | Thunderbird auto-setup (discovery). | Walang API key |
| 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 |
| GET | /v1/mail/mailboxes/{mailboxId}/apple-profile | An Apple configuration profile for this mailbox. | mail.view |
| GET | /v1/mail/mailboxes/{mailboxId}/client-setup | Everything needed to add this mailbox to a mail app. | mail.view |
| POST | /v1/mail/mailboxes/{mailboxId}/password | Set or reset a mailbox password. | mail.manage |
| DELETE | /v1/mail/mailboxes/{mailboxId}/recovery | Remove a mailbox's recovery address. | mail.manage |
| PUT | /v1/mail/mailboxes/{mailboxId}/recovery | Set a mailbox's recovery address. | 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 |
| DELETE | /v1/sites/{siteId}/mail-smtp | Stop using the site's own SMTP server. | mail.manage |
| GET | /v1/sites/{siteId}/mail-smtp | Get the site's own SMTP server for website mail. | mail.view |
| PUT | /v1/sites/{siteId}/mail-smtp | Save (and prove) the site's own SMTP server. | mail.manage |
| POST | /v1/sites/{siteId}/mail-smtp/test | Prove the saved SMTP server again now. | mail.manage |
| POST | /v1/webhooks/mail-relay-events | Ingest signed delivery events from our own mail relay. | Walang API key |