Description

This function retrieves information about a domain-level forwarder.


We strongly recommend that you use the following UAPI function instead of this function:

Examples 




https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=listdomainforwards&domain="example.com"



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List the domain-level forwarder information for example.com.
$list_domain_fwd_info = $cpanel->api2(
    'Email', 'listdomainforwards', 
    array(
        'domain'          => 'example.com',
    ) 
);



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List the domain-level forwarder information for example.com.
my $list_domain_fwd_info = $cpliveapi->api2(
    'Email', 'listdomainforwards',
    { 
        'domain'          => 'example.com',
    }
);




cpapi2 --user=username Email listdomainforwarders domain=example.com



{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listdomainforwards",
    "data": [
      {
        "dest": "example.com",
        "forward": "forwardtome.com"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain.

A valid domain on the cPanel account.

example.com

Returns

ReturnTypeDescriptionPossible valuesExample
deststringThe specified domain.A valid domain on the cPanel account.example.com
forwardstringThe domain to which the system forwards the dest domain's mail.A valid domain name.forwardtome.com
reasonstring

A reason for failure.

This function only returns a reason value if it failed. 


A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1