cPanel API 2 Functions - Email::listmaildomains

Description

This function lists the cPanel account's mail domains.

Warning:

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

  • Email::list_mail_domains — This function lists the account's mail domains.

Examples 


 WHM API (JSON)

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=

 LiveAPI PHP Class

$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'
    
);

 LiveAPI Perl Module

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',
    }
);

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 

 Command Line

cpapi2 --user=username Email listdomains skipman=0

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

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

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

 Parameter 

Type

Description

Possible values

 Example 

 skipmain

 Boolean 

 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

 Return 

Type

Description

Possible values

Example

 domain

 string

 A mail domain on the cPanel account. 

 A valid domain.

 example.com

 reason

 string

 A reason for failure.

 Note:

 This function only returns a reasonvalue if it failed. 

 A string that describes the error.

 This is an error message. 

 result

 Boolean 

 Whether the function succeeded.

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

 1

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....