Page History

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"

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

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

cpapi2 --user=username Email listpops regex=user

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