manage_inbox
Create, read, delete, and audit receive-only email inboxes. action=create writes an address on the inbound domain and returns inbox plus address (ACL inbox_create). Requires an active plan. Temporary inboxes expire and purge. action=list returns active inboxes (ACL inbox_list). action=get returns one inbox (ACL inbox_get). action=delete deletes the inbox and purges stored messages (ACL inbox_delete). action=audit lists account audit entries (ACL inbox_audit_list). These calls do not meter; inbound mail later meters inbound_email. No outbound email. Use read_inbox_message for mail, manage_inbox_webhook for HTTPS notifications, and manage_inbox_blocklist for sender blocks.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | temporary expires after ttlSeconds (default 86400, max 604800 unless the deployment overrides those). permanent does not expire. Required for action=create. Omit otherwise. | |
| limit | No | Page size for action=audit. Default 50. Ignored by create, list, get, and delete. | |
| action | Yes | create checks ACL inbox_create and writes an inbox. list checks inbox_list. get checks inbox_get. delete checks inbox_delete and purges messages. audit checks inbox_audit_list. Required. No default. | |
| domain | No | Inbound domain for action=create. Default is the deployment inbound domain. Must already be configured. Ignored by other actions. | |
| offset | No | Row offset for action=audit. Default 0. Ignored by create, list, get, and delete. | |
| inboxId | No | Inbox id. Required for get and delete. Omit for create, list, and audit. | |
| localPart | No | Address prefix before @domain. Required for action=create. Stored lowercased. Omit for other actions. | |
| ttlSeconds | No | Lifetime for kind=temporary. Default 86400 seconds. Ignored for permanent and for actions other than create. |