You can find our user documentation at

Check out our new API beta site!

Child pages
  • cPanel API 1 Functions - Email::listmaildomainsoptndef
Skip to end of metadata
Go to start of metadata



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


cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$list_mail_domains_opt = $cpanel->api1('Email', 'listmaildomainsoptndef', array('') ); // Call the function.


For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $list_mail_domains_opt = $cpliveapi->api1('Email', 'listmaildomainsoptndef', [''] ); # Call the function.


For more information, read our Guide to the LiveAPI System.

 cPanel Tag System (deprecated)


In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Email::listmaildomainsoptndef('sdomain') )">
 Command Line
cpapi1 --user=username Email listmaildomainoptndef


  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:


 Output (HTML)
<option value="" selected></option>
<option value=""></option> 
<option value=""></option> 


ParameterTypeDescriptionPossible valuesExample


The domain to mark as selected in the function's results.

A valid mail domain.


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

The domain that you specify in the sdomain parameter will include the selected option in its <option> tag.