# cPanel API 2 Functions - Email::listlists

Warning:

The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

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

Warning:

We **strongly** recommend that you use the following [UAPI](/cpanel/introduction/) function instead of this function:

- ` Email::list_lists ` — This function lists the account's Mailman mailing lists.


div
Important:
br
When you disable the [*Receive Mail* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

br
## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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
```

div
Note:
br
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

br
LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$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',
);
```

div
Note:
br
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

br
LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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',
);
```

div
Note:
br
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

br
cPanel Tag System (deprecated)

div
Warnings:
br
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system).
- cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
- For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


br
Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Email listlists domain=example.com regex=list
```

div
Notes:
br
- You **must** URI-encode values.
- `username` represents your account-level username.
- You **must** run the `--user=username` command.
- For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "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"
  }
}
```

div
Note:
br
Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

br
## Parameters

table
thead
tr
th
strong
Parameter
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
domain
td
em
string
td
p
The domain to search for mailing lists.
p
If you do not use this parameter, the function lists all of the cPanel account's mailing lists.
td
p
A valid domain on the server.
td
code
example.com
tr
td
code
regex
td
em
string
td
p
A 
a
Perl Compatible Regular Expression (PCRE)
 that filters the results.
p
If you do not use this parameter, the function lists all of the mailing lists for all of the cPanel account's domains.
td
p
A valid PCRE.
td
code
list 
## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
diskused
td
em
integer
td
The disk space that the mailing list currently uses, in megabytes (MB).
td
A positive integer.
td
code
20379
tr
td
code
listid
td
em
string
td
The mailing list's name and domain.
td
The mailing list name, an underscore (
code
_
), and the domain.
td
code
list_example.com
tr
td
code
subscribe_policy
td
em
integer
td
The level of control that the mailing list administrator maintains over new subscribers.
td
ul
li
code
1
 — Anyone can subscribe. The system sends a confirmation email.
li
code
2
 — The administrator must approve subscriptions. The system does 
strong
not
 send a confirmation email.
li
code
3
 — The administrator 
strong
must
 approve subscriptions. The system sends a confirmation email.
td
code
1
tr
td
code
archive_private
td
em
Boolean
td
Whether the mailing list archive is private.
td
ul
li
code
1
 — The mailing list archive is private.
li
code
0
 — The mailing list archive is public.
td
code
0
tr
td
code
accesstype
td
em
string
td
The user's level of access to the mailing list.
td
ul
li
code
private
— The list contains 
strong
all
 of the following settings:

ul
li
The list contains private archives.
li
The administrator 
strong
must
 approve subscriptions.
li
The Mailman directory page does 
strong
not
 display the list.
li
code
public
 — The list contains 
strong
any
 of 
strong
 the following settings:

ul
li
The list contains public archives.
li
Anyone can subscribe.
li
The Mailman directory page displays the list.
td
code
public
tr
td
code
desthost
td
em
string
td
The IP address of the domain that you specified in the 
code
domain
 input parameter.
td
An IPv4 address.
td
code
172.16.254.1
tr
td
code
advertised
td
em
Boolean
td
Whether the Mailman directory page displays the list.
td
ul
li
code
1
 — The Mailman directory page displays the list.
li
code
0
 — The Mailman directory page does 
strong
not
 display the list.
td
code
1
tr
td
code
humandiskused
td
em
string
td
The disk space that the mailing list uses, in human-readable format.
td
The disk space that the mailing list uses, a non-breaking space (
code
\u00a0
), and the unit of measure.
td
code
19.9\u00a0KB
tr
td
code
listadmin
td
em
string
td
The mailing list's administrators' email addresses.
td
A comma-separated list of email addresses.
td
code
admin@example.com,admin2@example.com
tr
td
code
list
td
em
string
td
The mailing list name and domain.
td
The mailing list name, the 
code
@
 character, and the domain.
td
code
list@example.com
tr
td
code
reason
td
em
string
td
div
p
A reason for failure.
p
div
Note:
br
p
This function 
strong
only
 returns a 
code
reason
 value if it failed. 
br
td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1