cPanel API 2 Functions - Email::listpops

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function lists the cPanel account's email addresses.

Warning:

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

Email::list_pops — This function lists the cPanel account's email accounts.

Important:

When you disable the Receive Mail role, the system disables 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=listpops&regex="user"

Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List email addresses that contain "user".
$list_email_addresses = $cpanel->api2(
    'Email', 'listpops',
    array(
        'regex'           => 'user',
    )
);

Note:

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.

# List email addresses that contain "user".
my $list_email_addresses = $cpliveapi->api2(
    'Email', 'listpops',
    {
        'regex'           => 'user',
    }
);

Note:

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

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI 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 .
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 documentation.

Command Line

cpapi2 --user=username Email listpops regex=user

Notes:

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 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listpops",
    "data": [
      {
        "email": "user@example.com",
        "login": "user@example.com",
        "suspended_incoming":0,
        "suspended_login":0
      },
      {
        "email": "data@userexample.com",
        "login": "data@userexample.com",
        "suspended_incoming":0,
        "suspended_login":0
      },
      {
        "email": "manyusers@example.com",
        "login": "manyusers@example.com",
        "suspended_incoming":0,
        "suspended_login":0
      },
      {
        "email": "cpaneluser",
        "login": "Main Account",
        "suspended_incoming":0,
        "suspended_login":0
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

Note:

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

Parameters

Parameter Type Description Possible values Example

Parameter	Type	Description	Possible values	Example
`regex`	string	A Perl Compatible Regular Expression (PCRE) that filters the results. The system matches the PCRE to both the email address's username and domain. If you do not use this parameter, the function returns all of the cPanel account's email addresses.	A valid PCRE.	`user`

regex

string

A Perl Compatible Regular Expression (PCRE) that filters the results. The system matches the PCRE to both the email address's username and domain.

If you do not use this parameter, the function returns all of the cPanel account's email addresses.

A valid PCRE.

user

Returns

Return	Type	Description	Possible values	Example
`email`	string	The email address, or the main cPanel account username.	A valid email address, or the username for the main account.	`user@example.com`
`login`	string	The email address, or the string `Main Account`.	A valid email address, or the string `Main Account`.	`user@example.com`
`suspended_incoming`	Boolean	Whether the email account's incoming email is suspended.	`1` — Incoming email is suspended. `0` — Incoming email is not suspended.	`0`
`suspended_login`	Boolean	Whether the user's ability to log in to, send mail from, and read their email account is suspended.	`1` — Logins are suspended. `0` — Logins are not suspended.	`0`
`reason`	string	A reason for failure. Note: This function only returns a `reason` value if there is an error.	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`