Child pages
  • UAPI Functions - Email::list_domain_forwarders

Versions Compared

Key

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

Description

Excerpt
This function lists domain-level forwarders.

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_domain_forwarders?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 domain-level forwarders for example.com
$list_domain_forwarders = $cpanel->uapi(
    'Email', 'list_domain_forwarders',
    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 domain-level forwarders for example.com
my $list_domain_forwarders = $cpliveapi->uapi(
    'Email', 'list_domain_forwarders',
    {
        'domain'         => 'example.com',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


Code Block
languagexml
<!-- Get a hash, then display the dest value. -->
[% data = execute( 'Email', 'list_domain_forwarders', { 'domain' => 'example.com' } ); %]
[% FOREACH q = data.dest %]
     <p>
         [% q %]
     </p>
[% END %]
 
<!-- Get only the dest value. -->
[% execute( 'Email', 'list_domain_forwarders', { 'domain' => 'example.com' } ).data.dest %]

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


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

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": [
    {
      "dest": "example.com",
      "forward": "forwardexample.com"
    }
  ],
  "metadata": {
    "transformed": 1
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

The domain name to query.

If you do not use this parameter, the function returns all domain-level forwarders on the cPanel account.

A valid domain on the cPanel account.

example.com

Returns

ReturnTypeDescriptionPossible valuesExample
dataarray of hashesAn array of hashes of domain forwarder information.Each hash contains the dest and forward returns. 

dest

string

The forwarded domain.

The function returns this value in the data hash.

A valid domain on the cPanel account.

example.com

forward

string

The destination domain.

The function returns this value in the data hash.

A valid domain name.

forwardtome.com