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

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 none preselected.

Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended)Email::list_mail_domains
    Excerpt Include
    UAPI Functions - Email::list_mail_domains
    UAPI Functions - Email::list_mail_domains
    nopaneltrue
  • cPanel API 2Email::listmaildomains
    Excerpt Include
    cPanel API 2 Functions - Email::listmaildomains
    cPanel API 2 Functions - Email::listmaildomains
    nopaneltrue
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_opt = $cpanel->api1('Email', 'listmaildomainsopt'); // 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_opt = $cpliveapi->api1('Email', 'listmaildomainsopt'); # 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::listmaildomainsopt() )">
Expand
titleCommand Line
Code Block
cpapi1 --user=username Email listmaildomainsopt

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote

Expand
titleOutput (HTML)
Code Block
languagexml
linenumberstrue
<option value="example.com">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.