Return domain-level forwarders

This function lists domain-level forwarders.

Important:

When you disable the Receive Mail role, the system disables this function.

Authorizations:
query Parameters
domain
string <domain>

The domain name to query. If you do not use this parameter, the function returns all domain-level forwarders on the cPanel account.

Example: domain=example.com

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  Email \
  list_domain_forwarders

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "list_domain_forwarders",
  • "module": "Email",
  • "result": {
    • "data": [
      • {
        • "dest": "example.com",
        • "forward": "forwardtome.com"
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}