cPanel API 2 Functions - Email::listpopswithimage

Description

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

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

 

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

 LiveAPI PHP Class

$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',
    
);

 LiveAPI Perl Module

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',
    }
);

 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.

 

 Output (JSON)

{
  "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"
  }
}

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. 

 A valid PCRE.

 user

 

Returns

Return

Type

Description

Possible values

Example

 email

 string

 The email address, or the main 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, and an HTML link to  themainacct.jpgimage.

  • A valid email address, or the stringMain Account.
  • HTML code to display the account'smainacct.jpgimage. The cPanel theme that the account uses determines this image's location.
  • user@example.com
  • <img src="/frontend/cpanel-skin/images/mainacct.jpg">
 

 suspended_incoming 

 boolean 

 Whether the email account's incoming email is suspended.

 Note:

 cPanel & WHM introduced this return in 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:

 cPanel & WHM introduced this return in version 54.

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

 0

 reason

 string

 A reason for failure.

 Note:

 This function only returns a reasonvalue 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

 

  • 14 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....