# Return email accounts with disk information

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



  When you disable the  role, the system  this function.

Endpoint: GET /Email/list_pops_with_disk
Version: 11.134.0.5
Security: BasicAuth

## Query parameters:

  - `domain` (string)
    A domain name to filter the results by. If you do  use this parameter, the function returns  of the cPanel account's email addresses.
    Example: "example.com"

  - `email` (string)
    The cPanel user account to query. If you do  use this parameter, the function returns the email addresses for  cPanel accounts that the user owns.



 To retrieve information for a single email address, add the domain parameter. For example,  will return information for the email address .
    Example: "user"

  - `get_restrictions` (integer)
    Whether to display restriction status for each of the email addresses.
*  — Display.
*  — Do  display.
    Enum: 0, 1

  - `infinityimg` (string)
    An image to display for email addresses with an unlimited quota. If you specify an  value, the function returns HTML code to display that image as the  parameter's value.
    Example: "images/myimg.jpg"

  - `infinitylang` (integer)
    Whether to return the  character for email addresses with an unlimited quota.
*  — Return the  character for unlimited  values.
*  — Return the string  for unlimited  values.



 If you specify  for this parameter  the  parameter, the function ignores  parameter and returns HTML code for unlimited  values.
    Enum: 0, 1

  - `maxaccounts` (integer)
    The maximum number of email addresses to return. If you do not use this parameter, the function returns an unlimited number of email addresses.
    Example: 500

  - `no_disk` (integer)
    Whether to skip the collection of disk usage information.
*  — Do  collect.
*  — Collect.
    Enum: 0, 1

  - `no_validate` (integer)
    Whether to skip email database validation.
*  — Skip validation.
*  — Perform the validation.
    Enum: 0, 1

  - `regex` (string)
    A Perl Compatible Regular Expression (PCRE) that filters the results. For example,  matches the local portion of an email address, if it contains between six and 18 characters.
    Example: "/^[a-z0-9_-]{6,18}$/"

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "list_pops_with_disk"

  - `module` (string)
    The name of the module called.
    Example: "Email"

  - `result` (object)

  - `result.data` (array)
    An array of objects containing data for each email address.

  - `result.data._diskquota` (integer)
    The disk quota.
* A positive value that represents the disk quota, in bytes.
*  - The account possesses an unlimited disk quota.

  - `result.data._diskused` (integer)
    The disk space that the email account uses.
* A positive value that represents the used disk space, in bytes.
*  - The account possesses an unlimited disk quota.
    Example: 483

  - `result.data.diskquota` (any)
    The email account's disk quota.
* A positive value that represents the email address's quota, in megabytes (MB).
* , , or HTML code to display an infinity image - The email account has an unlimited quota.



  The  and  parameters determine the unlimited value for this return.
    Example: "unlimited"

  - `result.data.diskused` (integer)
    The disk space that the email account uses.
* A positive floating-point value that represents the used disk space, in megabytes (MB).
*  - The account possesses an unlimited disk quota.

  - `result.data.diskusedpercent` (integer)
    The percentage of disk space that the email account uses.
* A positive value.
*  - The account has an unlimited disk quota.

  - `result.data.diskusedpercent20` (integer)
    The percentage of disk space that the email account uses.
* A positive value.
*  - The account possesses an unlimited disk quota.

  - `result.data.diskusedpercent_float` (number)
    The floating-point value from which the function derives the  return.
* A floating-point value.
*  - Unlimited or disabled disk quota.



 The  number can contain scientific notation values. For example, .

  - `result.data.domain` (string)
    The email account's domain. For example,  if the email address is .
    Example: "example.com"

  - `result.data.email` (any)
    The email address, or the string .
* A valid email address.
*
    Example: "user@example.com"

  - `result.data.has_suspended` (integer)
    Whether the email account possesses one of the following suspension parameters:    
*  - The email account has a suspension.
*  - The email account does  have a suspension.



  The function  returns this value if you pass the  parameter.
    Enum: 0, 1

  - `result.data.hold_outgoing` (integer)
    Whether the email account's outgoing email is held in Exim's queue.
*  - Outgoing email is held in Exim's queue.
*  - Outgoing email is  held in Exim's queue.



  The function  returns this value if you pass the  parameter.
    Enum: 0, 1

  - `result.data.humandiskquota` (any)
    The disk quota, in human-readable format.
* The disk quota and the unit of measure.
*  - The account possesses an unlimited disk quota.
    Example: "None"

  - `result.data.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 (), and the unit of measure.
*  - The account possesses an unlimited disk quota.
    Example: "483 bytes"

  - `result.data.login` (any)
    The email address, or the main account username.
* A valid email address.
* The username for the main account.
    Example: "user@example.com"

  - `result.data.mtime` (integer)
    The email account's last modification time, in [Unix time](https://wikipedia.org/wiki/Unix_time) format.
    Example: 1415894498

  - `result.data.suspended_incoming` (integer)
    Whether the email account's incoming email is suspended.
*  - Suspended.
*  -  suspended.
    Enum: 0, 1

  - `result.data.suspended_login` (integer)
    Whether the user's ability to log in to, send mail from, and read their email account is suspended.
*  - Suspended.
*  -  suspended.
    Enum: 0, 1

  - `result.data.suspended_outgoing` (integer)
    Whether the email account's outgoing email is suspended.
*  - Suspended.
*  -  suspended.
    Enum: 0, 1

  - `result.data.txtdiskquota` (any)
    The email account's disk quota.
* A positive value that represents the email address's quota, in megabytes (MB).
*  - The email account has an unlimited quota.
    Example: "unlimited"

  - `result.data.user` (string)
    The email account username. For example,  if the email address is .
    Example: "user"

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

  - `result.metadata.transformed` (integer)
    Post-processing may have transformed the data.
    Enum: 1

  - `result.status` (integer)
    *  - Success.
*  - Failed. Check the  field for more details.
    Enum: 0, 1

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.