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

Versions Compared

Key

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

Description

Excerpt

This function lists all of a cPanel account's mail domains, with the main domain preselected.


Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended) Email::list_mail_domains
    Excerpt Include
    DD:UAPI Functions - Email::list_mail_domainsDD:
    UAPI Functions - Email::list_mail_domains
    nopaneltrue
  • cPanel API 2 Email::listmaildomains
    Excerpt Include
    DD:cPanel API 2 Functions - Email::listmaildomainsDD:
    cPanel API 2 Functions - Email::listmaildomains
    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
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$list_mail_domains = $cpanel->api1('Email', 'listmaildomains') ); // Call the function.

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.
my $list_mail_domains = $cpliveapi->api1('Email', 'listmaildomains'); # Call the function.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="Email::listmaildomains() )">



Expand
titleCommand Line


Code Block
cpapi1 --user=username Email listmaildomains

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (HTML)


Code Block
languagexml
linenumberstrue
<option value="example.com" selected>example.com</option>
<option value="exampledomain.com">exampledomain.com</option> 
<option value="domain.com">domain.com</option> 




Parameters

This function does not accept parameters.

Returns

This function returns a list of each mail domain on the account, wrapped in <option> tags.

The cPanel account's main domain automatically includes the selected option in its <option> tag.