Child pages
  • cPanel API 2 Functions - Email::listdefaultaddresses
Skip to end of metadata
Go to start of metadata

 

Description

This function retrieves the domain's default address and its rules. The cPanel account's default (catchall) address handles unroutable mail that the account's domains receive.

Warning:

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

Examples 


 WHM API (JSON)
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=listdefaultaddresses&domain="example.com"


Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Check example.com's default address rules.
$check_default_address_rules = $cpanel->api2(
    'Email', 'listdefaultaddresses', 
    array(
        'domain'          => 'example.com',
    ) 
);


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Check example.com's default address rules.
my $check_default_address_rules = $cpliveapi->api2(
    'Email', 'listdefaultaddresses',
    { 
        'domain'          => 'example.com',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Tag System (deprecated)


Warnings:

  • In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 Command Line
cpapi2 --user=username Email listdefaultaddresses domain=example.com


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listdefaultaddresses",
    "data": [
      {
        "domain": "example.com",
        "defaultaddress": "":blackhole:""
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

The domain.

If you do not specify a value, the function lists default addresses for all of the cPanel account's domains.

A valid domain on the cPanel account.example.com
userstring

Required

The user whose default addresses to list.

A valid user on the cPanel account.user

Returns

ReturnTypeDescriptionPossible valuesExample
domainstring

The domain.

A valid domain on the cPanel account.

example.com
defaultaddressstringThe method that the domain uses to handle unroutable mail.
  • An email address — The system forwards unroutable mail to this address.
  • ":fail:" — The system bounces unroutable mail back to the sender, and sends a failure message.
  • ":blackhole:" — The system deletes unroutable mail without a failure message.
  • The path to an application — The system pipes unroutable mail to this application.
catchall@example.com
reasonstring

A reason for failure.

Note:

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