Update mailbox
mailbox_updateUpdate a mailbox: set it as default, start an email change pending verification, or cancel a pending change.
Instructions
Update a mailbox. Provide at least one change: set_default=true makes this mailbox the account default (it must be verified); email starts an address change that stays pending until the new address is verified via the email SimpleLogin sends it; cancel_email_change=true aborts such a pending change. set_default and cancel_email_change only accept true (a mailbox stops being default only when another is promoted, and a pending change is cancelled rather than toggled back), email and cancel_email_change are mutually exclusive, and a call that changes nothing is rejected without contacting SimpleLogin.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | New address for the mailbox; the change is pending until verified. | ||
| mailbox_id | Yes | Numeric id of the mailbox to update. | |
| set_default | No | Make this mailbox the account default. The mailbox must be verified. | |
| cancel_email_change | No | Cancel a pending email change on this mailbox. |