Domain Email Forward List
Resource path /Domain/EmailForward/List
The command is intended to retrieve the list of email forwarding rules for a domain.
HTTPS POST/GET Request parameters:
| Parameter name | Description |
ApiKey |
The API key that we provided to you when you requested API access for your account |
Password |
The password we provided when you requested API access for your account |
Domain |
The domain name for which the Email Forwarding rules have to be retrieved |
rangeFrom and |
By default we return all rules. If you want the results paginated use these two parameters. |
ResponseFormat |
This specifies how the response will be returned. Possible values are TEXT, JSON and XML. |
Returned data:
RULE_[x]_SOURCE = the source for the rule [x] where [x] is a number starting with 1 and incrementing for each rule
RULE_[x]_DESTINATION = the destination for rule [x]
Example:
The result for this request is:
total_rules=3
rule_1_source=bbb@test-api-domain7.net
rule_1_destination=myemail@example.com
rule_2_source=@test-api-domain7.net
rule_2_destination=updatedmyemail@example.com
rule_3_source=aaa@test-api-domain7.net
rule_3_destination=myemail@example.com
status=SUCCESS