Updates an existing ingress mailbox associated with the account API key used.
See Also:
list_mailboxes,
update_mailbox,
delete_mailbox
Request Fields
| Key | Type | Description |
|---|---|---|
| id | string Required* |
A mailbox ID returned by list_mailboxes or obtained by a previous create_mailbox call. |
| uid | string Required* |
An identifier to refer to this mailbox on subsequent API calls. |
| label | string Optional |
A descriptive name for this mailbox. |
| host | string Optional |
IMAP server hostname. |
| port | integer Optional |
IMAP server port number. |
| username | string Optional |
Username/email-address used to authenticate with the IMAP server. |
| password | string Optional |
Password used to authenticate with the IMAP server. |
| tls | boolean Optional |
Set to true to connect to IMAP server with TLS enabled. |
* One of id or uid must be supplied in order to identify which mailbox to
update. If both are supplied the id key has priority and the mailbox’s uid
will be changed to the supplied value.
Request Example
{
"api_key" : "__ACCOUNT_API__KEY__",
"arguments": {
"uid": "example-mailbox",
"label": "Example Mailbox",
"host": "imap.gmail.com",
"username": "example-mailbox-account@gmail.com",
"password": "*********"
}
}