Skip to Content

A mailbox's mail settings: its usage, its retention window, its event and message webhooks, what delivers to it, the addresses it may send as and whether it…

A mailbox's mail settings: its usage, its retention window, its event and message webhooks, what delivers to it, the addresses it may send as and whether it may send.

Its 16 methods, each a page of its own, in the order the API reference presents them:

MethodWhat it doesIt calls
mailboxes.getGet mailbox details and usage statisticsGET /mailboxes/{mailboxId}
mailboxes.getRetentionGet retention policy and previewGET /mailboxes/{mailboxId}/retention
mailboxes.setRetentionSet retention windowPUT /mailboxes/{mailboxId}/retention
mailboxes.clearRetentionClear retention windowDELETE /mailboxes/{mailboxId}/retention
mailboxes.getEventWebhookRead the mailbox's event webhookGET /mailboxes/{mailboxId}/event-webhook
mailboxes.setEventWebhookCreate or replace the mailbox's event webhookPUT /mailboxes/{mailboxId}/event-webhook
mailboxes.deleteEventWebhookRemove the mailbox's event webhookDELETE /mailboxes/{mailboxId}/event-webhook
mailboxes.testEventWebhookSend a test event to the mailbox's event webhookPOST /mailboxes/{mailboxId}/event-webhook/test
mailboxes.getMessageWebhookRead the mailbox's message webhookGET /mailboxes/{mailboxId}/message-webhook
mailboxes.setMessageWebhookCreate or replace the mailbox's message webhookPUT /mailboxes/{mailboxId}/message-webhook
mailboxes.deleteMessageWebhookRemove the mailbox's message webhookDELETE /mailboxes/{mailboxId}/message-webhook
mailboxes.getRoutingList what delivers to a mailboxGET /mailboxes/{mailboxId}/routing
mailboxes.listSendAsList the addresses a mailbox may send asGET /mailboxes/{mailboxId}/send-as
mailboxes.checkSendAsCheck whether a mailbox may send from an addressPOST /mailboxes/{mailboxId}/send-as/check
mailboxes.getSendUsageGet outbound send rate limit usageGET /mailboxes/{mailboxId}/send-usage
mailboxes.getSendStateGet whether a mailbox may sendGET /mailboxes/{mailboxId}/send-state

In the API reference: Mailboxes.