Return email accounts with disk information
This function lists the cPanel account's email accounts with disk information.
Important:
When you disable the Receive Mail role, the system disables this function.
Query parameters
A domain name to filter the results by. If you do not use this parameter, the function returns all of the cPanel account's email addresses.
The cPanel user account to query. If you do not use this parameter, the function returns the email addresses for all cPanel accounts that the user owns.
Note:
To retrieve information for a single email address, add the domain parameter. For example, email=user&domain=example.com will return information for the email address user@example.com.
Whether to display restriction status for each of the email addresses.
- 1 — Display.
- 0 — Do not display.
An image to display for email addresses with an unlimited quota. If you specify an infinityimg value, the function returns HTML code to display that image as the diskquota parameter's value.
Whether to return the ∞ character for email addresses with an unlimited quota.
- 1 — Return the ∞ character for unlimited diskquota values.
- 0 — Return the string unlimited for unlimited diskquota values.
Note:
If you specify 1 for this parameter and the infinityimg parameter, the function ignores this parameter and returns HTML code for unlimited diskquota values.
The maximum number of email addresses to return. If you do not use this parameter, the function returns an unlimited number of email addresses.
Whether to skip the collection of disk usage information.
- 1 — Do not collect.
- 0 — Collect.
Whether to skip email database validation.
- 1 — Skip validation.
- 0 — Perform the validation.
A Perl Compatible Regular Expression (PCRE) that filters the results. For example, /^[a-z0-9_-]{6,18}$/ matches the local portion of an email address, if it contains between six and 18 characters.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "list_pops_with_disk",
"module": "Email",
"result": {
"data": [
{
"_diskused": 483,
"domain": "example.com",
"humandiskused": "483 bytes",
"mtime": 1415894498,
"user": "user"
}
],
"metadata": {
"transformed": 1
},
"status": 1
}
}