Delete mailbox
mailbox_deletePermanently delete a non-default mailbox after confirmation by transferring its aliases to another verified mailbox or deleting them with it; default mailboxes cannot be deleted.
Instructions
Permanently delete a mailbox. The aliases it owns must be dealt with explicitly: pass transfer_aliases_to (the id of a different, verified mailbox from mailbox_list) to move them, or delete_aliases=true to delete them with the mailbox; exactly one of the two is required. The default mailbox cannot be deleted; promote another mailbox first via mailbox_update with set_default=true. This cannot be undone. Requires confirm=true as an explicit acknowledgement of the deletion.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | Yes | Must be set to true to confirm this permanent, irreversible deletion. | |
| mailbox_id | Yes | Numeric id of the mailbox to delete. | |
| delete_aliases | No | Explicitly acknowledge that the owned aliases are deleted with the mailbox. | |
| transfer_aliases_to | No | Id of a different verified mailbox that takes over the owned aliases. |