cPanel API 2 Functions - Email::listdefaultaddresses

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:

  • Email::list_default_address — This function retrieves a domain's default address.

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=

 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',
    
);

 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',
    }
);

 cPanel Tag System (deprecated)

Warning:

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.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 

 Command Line

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

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

 Parameter 

 Type 

Description

Possible values

Example

 domain

 string 

Required

The domain.

A valid domain on the cPanel account.

example.com

 

Returns

Return

Type

Description

Possible values

Example

 domain

 string

 The domain.

 A valid domain on the cPanel account.

 example.com

 defaultaddress 

 string

 The 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

 reason

 string

 A reason for failure.

 Note:

 This functiononly returns areason value if it failed. 

 A string that describes the error.

 This is an error message. 

 result

 Boolean 

 Whether the function succeeded.

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

 1

 

  • 6 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....