Return cPanel account's mailing lists

This function lists the account's Mailman mailing lists.

Authorizations:
query Parameters
domain
string <domain>

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

Example: domain=example.com
regex
string

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

Example: regex=user

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  Email \
  list_lists

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "list_lists",
  • "module": "Email",
  • "result": {
    • "data": [
      • {
        • "accesstype": "public",
        • "advertised": 1,
        • "archive_private": 0,
        • "desthost": "172.16.254.1",
        • "diskused": 20379,
        • "humandiskused": "19.9\\u00a0KB",
        • "list": "list@example.com",
        • "listadmin": "admin@example.com,admin2@example.com",
        • "listid": "list_example.com",
        • "subscribe_policy": 1
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}