Modify mail forward of domain zone.
Name | Data Type | Status | Description |
auth-id or sub-auth-id or sub-auth-user | Integer | Required | Authentication parameter |
auth-password | String | Required | Authentication parameter |
domain-name | String | Required | Domain name for which will be added this mail forward |
box | String | Required | Name of the mail box which you want to forward |
host | String | Required | Host of the mailbox. It should be empty, if you want mail forward to be for your main domain name |
destination | String | Required | E-mail address to which will be forwarded incoming mails |
mail-forward-id | Integer | Required | Mail forward ID from List mail forwards |
When the authenctication of API user is not correct, any API request will fail with the following status and statusDescription:
{"status":"Failed","statusDescription":"Invalid authentication, incorrect auth-id or auth-password."}
In case the credentials of API sub user are invalid, the following status and statusDescription will be returned:
{"status":"Failed","statusDescription":"Invalid authentication, incorrect sub-auth-id, sub-auth-user or auth-password."}
When invalid or non-existant domain-name is entered, the following status will be returned:
{"status":"Failed","statusDescription":"Missing domain-name"}
When one of the box, host and destination parameters is not valid, the API request will fail and the following status and statusDescription will be returned:
{"status":"Failed","statusDescription":"box: / host: / destination: is an invalid prefix / subdomain / e-mail address."}
When mail-forward-id parameter is invalid or incorrect, the API request will fail and the following status and statusDescription will be returned:
{"status":"Failed","statusDescription":"Invalid forward-id."}
Note: These are example errors in JSON format.
URL JSON: https://api.cloudns.net/dns/modify-mail-forward.json
POST/GET:
auth-id=0&auth-password=password&domain-name=cloudns.net&box=john.smith&host=&[email protected]&mail-forward-id=1235
sub-auth-id=0&auth-password=password&domain-name=cloudns.net&box=john.smith&host=&[email protected]&mail-forward-id=1235
URL XML: https://api.cloudns.net/dns/modify-mail-forward.xml
POST/GET:
auth-id=0&auth-password=password&domain-name=cloudns.net&box=john.smith&host=&[email protected]&mail-forward-id=1235
sub-auth-id=0&auth-password=password&domain-name=cloudns.net&box=john.smith&host=&[email protected]&mail-forward-id=1235