Email Forwarding

Return domain-level forwarders

This function lists domain-level forwarders.

Important:

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

get/Email/list_domain_forwarders

Request

Base URL
https://cpanel-server.tld:2083/execute
Auth
HTTP basic

Query parameters

domainstring domain

Example:example.com

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

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "list_domain_forwarders",
  "module": "Email",
  "result": {
    "data": [
      {
        "dest": "example.com",
        "forward": "forwardtome.com"
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.