Email
Email Forwarding
Return domain's forwarders
This function lists a domain's forwarders.
Important:
When you disable the Receive Mail role, the system disables this function.
get/Email/list_forwarders
Query parameters
domainstring domain required
Example:example.com
The domain.
regexstring
Example:user
A Perl Compatible Regular Expression (PCRE) that filters the forwarded address or destination. If you do not use this parameter, the function returns all of the account's forwarders.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "list_forwarders",
"module": "Email",
"result": {
"data": [
{
"dest": "forwarded@example.com",
"forward": "user@example.com",
"html_dest": "forwarded@example.com",
"html_forward": "user@example.com",
"uri_dest": "forwarded%40example.com",
"uri_forward": "user%40example.com"
}
],
"metadata": {
"transformed": 1
},
"status": 1
}
}