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

Versions Compared

Key

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

Description

Excerpt

This function lists a domain's email addresses with quota and disk usage information.


Warning
titleWarning:

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

  • Email::list_pops_with_disk

    Excerpt Include
    DD:UAPI Functions - Email::list_pops_with_diskDD:
    UAPI Functions - Email::list_pops_with_disk
    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=listpopswithdisk&domain="example.com"&nearquotaonly="0"&no_validate="0"

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 all example.com email addresses, and validate the
// information across multiple files.
$list_email_address_info = $cpanel->api2(
    'Email', 'listpopswithdisk', 
    array(
        'domain'          => 'example.com',
        'nearquotaonly'   => '0',
        'no_validate'     => '0',
    ) 
);

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 all example.com email addresses, and validate the
# information across multiple files.
my $list_email_addresses = $cpliveapi->api2(
    'Email', 'listpopswithdisk',
    { 
        'domain'          => 'example.com',
        'nearquotaonly'   => '0',
        'no_validate'     => '0',
    }
);

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 listpopswithdisk domain=example.com nearquotaonly=0 no_validate=0 regex=user

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listpopswithdisk",
    "data": [
      {
        "txtdiskquota": "unlimited",
        "diskquota": "unlimited",
        "diskusedpercent": 0,
        "mtime": 1412881950,
        "diskused": 0,
        "humandiskquota": "None",
        "_diskused": "483",
        "login": "user@example.com",
        "email": "user@example.com",
        "domain": "example.com",
        "user": "user",
        "suspended_incoming":0,
        "suspended_login":0,
        "suspended_incoming":0,
        "suspended_login":0,
        "humandiskused": "483\u00a0bytes",
        "diskusedpercent20": 0,
        "_diskquota": 0
      },
      {
        "txtdiskquota": "unlimited",
        "diskquota": "unlimited",
        "diskusedpercent": 0,
        "mtime": 1412881950,
        "diskused": 0,
        "humandiskquota": "None",
        "_diskused": "0",
        "login": "account@example.com",
        "email": "account@example.com",
        "domain": "example.com",
        "user": "account",
        "suspended_incoming":0,
        "suspended_login":0,
        "suspended_incoming":0,
        "suspended_login":0,
        "humandiskused": "None",
        "diskusedpercent20": 0,
        "_diskquota": 0
      },
      {
        "txtdiskquota": 250,
        "diskquota": 250,
        "diskusedpercent": 0,
        "mtime": 1412881950,
        "diskused": 0,
        "humandiskquota": "250\u00a0MB",
        "_diskused": 0,
        "login": "mail@addondomain.com",
        "email": "mail@addondomain.com",
        "domain": "addondomain.com",
        "user": "mail",
        "suspended_incoming":0,
        "suspended_login":0,
        "suspended_incoming":0,
        "suspended_login":0,
        "humandiskused": "None",
        "diskusedpercent20": 0,
        "_diskquota": "262144000"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

The domain to search for email address information.

If you do not specify a value, the function lists information for all of the account's domains.

A valid domain on the account.example.com
nearquotaonlyBoolean

Whether to limit results to accounts that use 95% or more of their allotted disk space.

If you do not specify a value, the function lists information for all email addresses.

  • 1 — Limit results.
  • 0 — Do not limit results.
0
no_validateBoolean

Whether to only read data from the .cpanel/email_accounts.yaml file.

If you specify 0 or do not specify a value, the function also checks the passwd file and quota files to ensure that the account information is identical.

  • 1 — Only check the .cpanel/email_accounts.yaml file.
  • 0 — Check all of the files.
0
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.

A valid PCRE.

user

Returns

ReturnTypeDescriptionPossible valuesExample
txtdiskquota

integer

or

string

The disk quota.
  • A positive integer that represents the disk quota in Megabytes (MB).
  • unlimited — The email account's disk quota is unlimited.
555
diskquota

integer

or

string

The disk quota.

This return's value is localized for the account's locale setting.

  • A positive integer that represents the disk quota in Megabytes (MB).
  • unlimited — The email account's disk quota is unlimited.
555
diskusedpercentintegerThe percentage of disk space that the email account uses.
  • A positive integer.
  • 0 — The account's disk quota is unlimited.
72
mtimeintegerThe file modification time, in Unix time.A time, in Unix time format.1412881950
diskusedintegerThe disk space that the email account uses, in Megabytes (MB).
  • A positive floating-point value.
  • 0 — The account has an unlimited disk quota.
399.6
humandiskquotastringThe disk quota, in human-readable format.
  • The disk quota and the unit of measure.
  • None — The account's disk quota is unlimited.
555 MB
_diskusedintegerThe disk space that the email account uses, in bytes.A positive integer.399600000
loginstring

The email address, or the main account username.

  • A valid email address.
  • The username for the main account.

user@example.com

emailstring

The email address, or the string Main Account .

  • A valid email address.
  •   Main Account
user@example.com
domainstringThe email account's domain.

The email account's domain.

For example, example.com if the email address is user@example.com.

example.com
userstringThe email account username.

The email account's username.

For example, user if the email address is user@example.com.

user
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
humandiskusedstring The disk space that the email account uses, in human-readable format. The disk space that the email account uses, a non-breaking space (\u00a0), and the unit of measure.399.6\u00a0bytes
diskusedpercent20integerThe percentage of disk space that the email account uses.
  • A positive integer.
  • 0 — The account's disk quota is unlimited.
72
_diskquotaintegerThe disk quota, in bytes.
  • A positive integer.
  • 0 — The account's disk quota is unlimited.
555000000
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