cPanel API 2 Functions - Email::listpopssingle - Knowledgebase

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.

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=listpopssingle&regex=

 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', 'listpopssingle', 
    array(
        'regex'           => 'user',
    ) 
);

 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', 'listpopssingle',
    {
        'regex'           => 'user',
    }
);

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 listpopssingle regex=user

Notes:

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listpopssingle",
    "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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

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

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

Returns

Return	Type	Description	Possible values	Example
email	string	The email address, or the main cPanel account's username.	A valid email address, or the username for the main account.	user@example.com
login	string	The email address, or the stringMain 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. Note: We introduced this return in cPanel & WHM version 54.	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. Note: We introduced this return in cPanel & WHM version 54.	1 — Logins are suspended. 0 — Logins are notsuspended.	0
reason	string	A reason for failure. Note: This function only returns areason 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

Knowledgebase

Categories

Categories