Child pages
  • UAPI Functions - Email::list_default_address
Skip to end of metadata
Go to start of metadata

Description

This function retrieves a domain's default address.

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive and MailSend roles, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/list_default_address?domain=example.com



Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List the default address for "example.com".
$default_email = $cpanel->uapi(
  'Email', 'list_default_address',
  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.
 
# List the default address for "example.com".
my $default_email = $cpliveapi->uapi(
  'Email', 'list_default_address',
  {
    'domain'   => 'example.com',
  }
);


Note:

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

 cPanel Template Toolkit
<!-- List the default address for "example.com". -->
[% execute('Email', 'list_default_address', { 'domain' => 'example.com', } ) %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username Email list_default_address domain=example.com


Notes:

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

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  
      "transformed":1
   },
   "data":[  
      {  
         "domain":"example.com",
         "defaultaddress":"username"
      }
   ]
}


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
 hash

A hash of data for a domain.

This hash includes the defaultaddress and domain returns. 

domain

string

The domain name.

The function includes this value in the unnamed hash for each domain.

A valid domain on the cPanel account.

example.com

defaultaddress

string

The domain's default address.

The function includes this value in the unnamed hash for each domain.

  • An email account username — 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.
user