UAPI Functions - Email::list_default_address - Knowledgebase

Description

This function retrieves a domain's default address.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Email/list_default_address?domain=example.com

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

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

cPanel Template Toolkit

[% execute('Email', 'list_default_address', { 'domain' => 'example.com', } ) %]

Command Line

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

Notes:

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

 Output (JSON)

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

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	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

Parameter

Type

Description

Possible values

Example

domain

string

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

Returns

Return	Type	Description	Possible values	Example
	hash	A hash of data for a domain.	This hash includes the defaultaddress anddomain parameters.
domain	string	The domain name. The function includes this parameter 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 parameter 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

Knowledgebase

Categories

Categories