Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function lists the cPanel account or domain's mailing lists.

Warning:

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

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=listlists&domain=example.com&regex=list

Unable to render {include} The included page could not be found.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List all of example.com's mailing lists.
$list_mailing_lists = $cpanel->api2(
    'Email', 'listlists', 
    array(
        'domain'          => 'example.com', 
    ) 
);
 
// List all of the cPanel account's mailing lists.
$list_mailing_lists = $cpanel->api2(
    'Email', 'listlists', 
);

Unable to render {include} The included page could not be found.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List all of example.com's mailing lists.
my $list_mailing_lists = $cpliveapi->api2(
    'Email', 'listlists',
    { 
        'domain'          => 'example.com', 
    }
);
 
# List all of the cPanel account's mailing lists.
my $list_mailing_lists = $cpliveapi->api2(
    'Email', 'listlists',
);

Unable to render {include} The included page could not be found.

 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 listlists domain=example.com regex=list


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listlists",
    "data": [
      {
        "diskused": "20379",
        "listid": "list_example.com",
        "subscribe_policy": 1,
        "archive_private": 0,
        "accesstype": "public",
        "desthost": "172.16.254.1",
        "advertised": 1,
        "humandiskused": "19.9\u00a0KB",
        "listadmin": "admin@example.com",
        "list": "list@example.com"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

Unable to render {include} The included page could not be found.

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

The domain to search for mailing lists.

If you do not use this parameter, the function lists all of the cPanel account's mailing lists.

A valid domain on the server.

example.com
regexstring

A Perl Compatible Regular Expression (PCRE) that filters the results.

If you do not use this parameter, the function lists all of the mailing lists for all of the cPanel account's domains.

A valid PCRE.

list

Returns

ReturnTypeDescriptionPossible valuesExample
diskusedintegerThe disk space that the mailing list currently uses, in Megabytes (MB).A positive integer.20379
listidstringThe mailing list's name and domain.The mailing list name, an underscore (_), and the domain.list_example.com
subscribe_policyintegerThe level of control that the mailing list administrator maintains over new subscribers.
  • 1 — Anyone can subscribe. The system sends a confirmation email.
  • 2 — The administrator must approve subscriptions. The system does not send a confirmation email.
  • 3 — The administrator must approve subscriptions. The system sends a confirmation email.
1
archive_privateBooleanWhether the mailing list archive is private.
  • 1 — The mailing list archive is private.
  • 0 — The mailing list archive is public.
0
accesstypestringThe user's level of access to the mailing list.
  • private— The list contains all of the following settings:
    • The list contains private archives.
    • The administrator must approve subscriptions.
    • The Mailman directory page does not display the list.
  • public — The list contains any of the following settings:
    • The list contains public archives.
    • Anyone can subscribe.
    • The Mailman directory page displays the list.
public
desthoststringThe IP address of the domain that you specified in the domain input parameter.An IPv4 address.
172.16.254.1
advertisedBooleanWhether the Mailman directory page displays the list.
  • 1 — The Mailman directory page displays the list.
  • 0 — The Mailman directory page does not display the list.
1
humandiskusedstringThe disk space that the mailing list uses, in human-readable format.The disk space that the mailing list uses, a non-breaking space (\u00a0), and the unit of measure.19.9\u00a0KB
listadminstringThe mailing list's administrators' email addresses.A comma-separated list of email addresses.admin@example.com,admin2@example.com
liststringThe mailing list name and domain.The mailing list name, the @ character, and the domain.list@example.com
reasonstring

A reason for failure.

Note:

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