---
title: "Return email accounts with disk information"
method: GET
path: "/Email/list_pops_with_disk"
tags: ["Email", "Email Accounts"]
---

# Return email accounts with disk information

`GET /Email/list_pops_with_disk`

This function lists the cPanel account's email accounts with disk information.

**Important:**

  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.

## Query parameters

- `domain` string, domain
- `email` string, username
- `get_restrictions` 0 | 1
- `infinityimg` string
- `infinitylang` 0 | 1
- `maxaccounts` integer
- `no_disk` 0 | 1
- `no_validate` 0 | 1
- `regex` string

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object[] — An array of objects containing data for each email address.
      - `_diskquota` integer — The disk quota. * A positive value that represents the disk quota, in bytes. * `0` - The account possesses an unlimited disk quota.
      - `_diskused` integer — The disk space that the email account uses. * A positive value that represents the used disk space, in bytes. * `0` - The account possesses an unlimited disk quota.
      - `diskquota` union — The email account's disk quota. * A positive value that represents the email address's quota, in megabytes (MB). * `unlimited`, `∞`, or HTML code to display an infinity image - The email account has an unlimited quota. **Note:** The `infinityimg` and `infinitylang` parameters determine the unlimited value for this return.
        - integer
        - string
      - `diskused` integer — The disk space that the email account uses. * A positive floating-point value that represents the used disk space, in megabytes (MB). * `0` - The account possesses an unlimited disk quota.
      - `diskusedpercent` integer — The percentage of disk space that the email account uses. * A positive value. * `0` - The account has an unlimited disk quota.
      - `diskusedpercent20` integer — The percentage of disk space that the email account uses. * A positive value. * `0` - The account possesses an unlimited disk quota.
      - `diskusedpercent_float` number — The floating-point value from which the function derives the `diskusedpercent` return. * A floating-point value. * `0` - Unlimited or disabled disk quota. **Note:** The `diskusedpercent_float` number can contain scientific notation values. For example, `1.20494365692139e-05`.
      - `domain` string, domain — The email account's domain. For example, `example.com` if the email address is `user@example.com`.
      - `email` union — The email address, or the string `Main Account`. * A valid email address. * `Main Account`
        - string, email
        - 'Main Account'
      - `has_suspended` 0 | 1 — Whether the email account possesses one of the following suspension parameters: `suspended_login` `suspended_incoming` `suspended_outgoing` `hold_outgoing` * `1` - The email account has a suspension. * `0` - The email account does **not** have a suspension. **Note:** The function **only** returns this value if you pass the `get_restrictions=1` parameter.
      - `hold_outgoing` 0 | 1 — Whether the email account's outgoing email is held in Exim's queue. * `1` - Outgoing email is held in Exim's queue. * `0` - Outgoing email is **not** held in Exim's queue. **Note:** The function **only** returns this value if you pass the `get_restrictions=1` parameter.
      - `humandiskquota` union — The disk quota, in human-readable format. * The disk quota and the unit of measure. * `None` - The account possesses an unlimited disk quota.
        - integer
        - 'None'
      - `humandiskused` string — 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. * `None` - The account possesses an unlimited disk quota.
      - `login` union — The email address, or the main account username. * A valid email address. * The username for the main account.
        - string, username
        - string, email
      - `mtime` integer — The email account's last modification time, in [Unix time](https://wikipedia.org/wiki/Unix_time) format.
      - `suspended_incoming` 0 | 1 — Whether the email account's incoming email is suspended. * `1` - Suspended. * `0` - **Not** suspended.
      - `suspended_login` 0 | 1 — Whether the user's ability to log in to, send mail from, and read their email account is suspended. * `1` - Suspended. * `0` - **Not** suspended.
      - `suspended_outgoing` 0 | 1 — Whether the email account's outgoing email is suspended. * `1` - Suspended. * `0` - **Not** suspended.
      - `txtdiskquota` union — The email account's disk quota. * A positive value that represents the email address's quota, in megabytes (MB). * `unlimited` - The email account has an unlimited quota.
        - integer
        - 'unlimited'
      - `user` string — The email account username. For example, `user` if the email address is `user@example.com`.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
      - `transformed` 1 — Post-processing may have transformed the data.
    - `status` 0 | 1 — * `1` - Success. * `0` - Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)