Child pages
  • UAPI Functions - Email::list_default_address

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt
This function retrieves a domain's default address.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledReceiveSendMailRoles
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


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


Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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',
    )
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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',
  }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


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

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


Code Block
languagebash
uapi --user=username Email list_default_address domain=example.com

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


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


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


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