Child pages
  • cPanel API 2 Functions - Email::listpops

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function lists the cPanel account's email addresses.


Warning
titleWarning:

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

  • Email::list_pops

    Excerpt Include
    DD:UAPI Functions - Email::list_pops
    DD:UAPI Functions - Email::list_pops
    nopaneltrue

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledReceiveMailRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
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"

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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',
    ) 
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
cpapi2 --user=username Email listpops regex=user

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "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"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


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

A valid PCRE.

user

Returns

ReturnTypeDescriptionPossible valuesExample
emailstringThe email address, or the main cPanel account username.A valid email address, or the username for the main account.user@example.com
loginstringThe 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.

Note
titleNote:

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
titleNote:

We introduced this return in cPanel & WHM version 54.


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

A reason for failure.

Note
titleNote:

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