# cPanel API 2 Functions - Email::listpopswithdisk Warning: The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2. ## Description This function lists a domain's email addresses with quota and disk usage information. Warning: We **strongly** recommend that you use the following [UAPI](/cpanel/introduction/) function instead of this function: - ` Email::list_pops_with_disk ` — This function lists the cPanel account's email accounts with disk information. div Important: br When you disable the [*Receive Mail* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function. br ## Examples WHM API (JSON) ```undefined syntaxhighlighter-pre 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" ``` div Note: br For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation. br LiveAPI PHP Class ```undefined syntaxhighlighter-pre $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', ) ); ``` div Note: br For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system). br LiveAPI Perl Module ```undefined syntaxhighlighter-pre 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', } ); ``` div Note: br For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system). br cPanel Tag System (deprecated) div Warnings: br - cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system). - cPanel API 2 calls that use cPanel tags vary in code syntax and in their output. - For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation. br Command Line ```undefined syntaxhighlighter-pre cpapi2 --user=username Email listpopswithdisk domain=example.com nearquotaonly=0 no_validate=0 regex=user ``` div Notes: br - You **must** URI-encode values. - `username` represents your account-level username. - You **must** run the `--user=username` command. - For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command. - If you run CloudLinux™, you **must** use the full path of the `cpapi2` command: ```undefined syntaxhighlighter-pre /usr/local/cpanel/bin/cpapi2 ``` br Output (JSON) ```undefined syntaxhighlighter-pre { "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" } } ``` div Note: br Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls. br ## Parameters table thead tr th strong Parameter th strong Type th strong Description th strong Possible values th strong Example tbody tr td code domain td em string td p The domain to search for email address information. p If you do not specify a value, the function lists information for all of the account's domains. td A valid domain on the account. td code example.com tr td code nearquotaonly td em Boolean td p Whether to limit results to accounts that use 95% or more of their allotted disk space. p If you do not specify a value, the function lists information for all email addresses. td ul li code 1 — Limit results. li code 0 — Do not limit results. td code 0 tr td code no_validate td em Boolean td p Whether to only read data from the code .cpanel/email_accounts.yaml file. p If you specify code 0 or do not specify a value, the function also checks the code passwd file and quota files to ensure that the account information is identical. td ul li code 1 — Only check the code .cpanel/email_accounts.yaml file. li code 0 — Check all of the files. td code 0 tr td code regex td em string td p A a Perl Compatible Regular Expression (PCRE) that filters the results. The system matches the PCRE to both the email address's username and domain. td p A valid PCRE. td code user ## Returns table thead tr th strong Return th strong Type th strong Description th strong Possible values th strong Example tbody tr td code txtdiskquota td p em integer p strong or p em string td The disk quota. td ul li A positive integer that represents the disk quota in megabytes (MB). li code unlimited — The email account's disk quota is unlimited. td code 555 tr td code diskquota td p em integer p strong or p em string td p The disk quota. p This return's value is localized for the account's locale setting. td ul li A positive integer that represents the disk quota in megabytes (MB). li code unlimited — The email account's disk quota is unlimited. td code 555 tr td code diskusedpercent td em integer td The percentage of disk space that the email account uses. td ul li A positive integer. li code 0 — The account's disk quota is unlimited. td code 72 tr td code mtime td em integer td The file modification time, in Unix time. td A time, in a Unix time format. td code 1412881950 tr td code diskused td em integer td The disk space that the email account uses, in megabytes (MB). td ul li A positive floating-point value. li code 0 — The account has an unlimited disk quota. td code 399.6 tr td code humandiskquota td em string td The disk quota, in human-readable format. td ul li The disk quota and the unit of measure. li code None — The account's disk quota is unlimited. td code 555 MB tr td code _diskused td em integer td The disk space that the email account uses, in bytes. td A positive integer. td code 399600000 tr td code login td em string td p The email address, or the main account username. td ul li A valid email address. li The username for the main account. td p code user@example.com tr td code email td em string td p The email address, or the string code Main Account . td ul li A valid email address. li code Main Account td code user@example.com tr td code domain td em string td The email account's domain. td p The email account's domain. p For example, code example.com if the email address is code user@example.com . td code example.com tr td code user td em string td The email account username. td p The email account's username. p For example, code user if the email address is code user@example.com . td code user tr td code suspended_incoming td em Boolean td div p Whether the email account's incoming email is suspended. td ul li code 1 — Incoming email is suspended. li code 0 — Incoming email is strong not suspended. td code 0 tr td code suspended_login td em Boolean td div p Whether the user's ability to log in to, send mail from, and read their email account is suspended. td ul li code 1 — Logins are suspended. li code 0 — Logins are strong not suspended. td code 0 tr td code humandiskused td em string td The disk space that the email account uses, in human-readable format. td The disk space that the email account uses, a non-breaking space ( code \u00a0 ), and the unit of measure. td code 399.6\u00a0bytes tr td code diskusedpercent20 td em integer td The percentage of disk space that the email account uses. td ul li A positive integer. li code 0 — The account's disk quota is unlimited. td code 72 tr td code _diskquota td em integer td The disk quota, in bytes. td ul li A positive integer. li code 0 — The account's disk quota is unlimited. td code 555000000 tr td code reason td em string td div p A reason for failure. p div Note: br p This function strong only returns a code reason value if there is an error. br td p A string that describes the error. td code This is an error message. tr td code result td em Boolean td p Whether the function succeeded. td ul li code 1 — The function succeeded. li code 0 — The function failed. td code 1