Description

This function lists the cPanel account's email addresses with mainacct.jpg image links.

Examples 




https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=listpopswithimage&regex="user"



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List email addresses that contain "user", with mainacct.jpg links.
$list_email_addresses = $cpanel->api2(
    'Email', 'listpopswithimage', 
    array(
        'regex'           => 'user',
    ) 
);



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List email addresses that contain "user", with mainacct.jpg links.
my $list_email_addresses = $cpliveapi->api2(
    'Email', 'listpopswithimage',
    { 
        'regex'           => 'user',
    }
);




cpapi2 --user=username Email listpopswithimage regex=user



{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listpopswithimage",
    "data": [
      {
        "email": "user@example.com",
        "login": "user@example.com",
        "login": "<img src="/frontend/cpanel-skin/images/mainacct.jpg">",
        "suspended_incoming":0,
        "suspended_login":0
      },
      {
        "email": "data@userexample.com",
        "login": "data@userexample.com",
        "login": "<img src="/frontend/cpanel-skin/images/mainacct.jpg">",
        "suspended_incoming":0,
        "suspended_login":0
      },
      {
        "email": "manyusers@example.com",
        "login": "manyusers@example.com",
        "login": "<img src="/frontend/cpanel-skin/images/mainacct.jpg">",
        "suspended_incoming":0,
        "suspended_login":0
      },
      {
        "email": "cpaneluser",
        "login": "Main Account",
        "login": "<img src="/frontend/cpanel-skin/images/mainacct.jpg">",
        "suspended_incoming":0,
        "suspended_login":0
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample
regexstring

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 image links for all of the cPanel account's email addresses.

A valid PCRE.

user

Returns

ReturnTypeDescriptionPossible valuesExample
emailstringThe email address, or the main account username.A valid email address, or the username for the main account.user@example.com
loginstring

The email address or the Main Account string, and an HTML link to the mainacct.jpg image.

  • A valid email address, or the string Main Account.
  • HTML code to display the account's mainacct.jpg image. The cPanel theme that the account uses determines this image's location.

<img src="/frontend/cpanel-skin/images/mainacct.jpg">

suspended_incoming Boolean

Whether the email account's incoming email is suspended.

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.

We introduced this return in cPanel & WHM version 54.


  • 1 — Logins are suspended.
  • 0 — Logins are not suspended.
0
reasonstring

A reason for failure.

This function only returns a reason value if there is an error. 


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