Update mail forwarder
update_mail_forwarderReplaces the destination addresses and/or comment of an existing email forwarder, with optional confirmation before applying changes.
Instructions
Replace the destination list and/or comment of an e-mail forwarder. fwd_addresses replaces the whole list. When the client supports it, the user is asked to confirm first.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | The forwarder address, e.g. 'info@example.com'. | |
| comment | No | ||
| vserver | Yes | Webhosting (virtual server) name, usually its main domain, e.g. 'example.com' (see list_webhostings). | |
| fwd_addresses | No | New full list of destination addresses. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | ||
| message | No | Set when the user declined or dismissed the confirmation. | |
| mail_forwarder | No |