Child pages
  • cPanel API 2 Functions - Email::listmaildomains

Versions Compared

Key

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

Description

Excerpt
This function lists the cPanel account's mail domains.


Warning
titleWarning:

We strongly recommend that you use the following UAPI function instead of this function:

  • Email::list_mail_domains

    Excerpt Include
    DD:UAPI Functions - Email::list_mail_domainsDD:
    UAPI Functions - Email::list_mail_domains
    nopaneltrue

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

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=listmaildomains&skipmain="0"

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List all mail domains, including the main domain.
$list_mail_domains = $cpanel->api2(
    'Email', 'listmaildomains', 
    array(
        'skipmain'        => '0', 
    ) 
);

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 all mail domains, including the main domain.
my $list_mail_domains = $cpliveapi->api2(
    'Email', 'listmaildomains',
    { 
        'skipmain'        => '0',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
cpapi2 --user=username Email listdomains skipman=0

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listmaildomains",
    "data": [
      {
        "domain": "example.com",
      }
      {
        "domain": "secondexample.com",
      }
      {
        "domain": "addondomain.com",
      }
      {
        "domain": "rutabagas4you.com",
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
skipmainBoolean

Whether to list the cPanel account's main domain.

This parameter defaults to 0.

  • 1 — Do not list the main domain.
  • 0 — List the main domain.
0

Returns

ReturnTypeDescriptionPossible valuesExample
domainstringA mail domain on the cPanel account.A valid domain.example.com
reasonstring

A reason for failure.

Note
titleNote:

This function only returns a reason value if it failed. 


A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

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