CPcpanel
Email
Email Accounts

Return email account's quota

This function retrieves an email account's quota.

Important:

When you disable the Receive Mail role, the system disables this function.

get/Email/get_pop_quota

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Query parameters

emailstring required
Example:user

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

as_bytes0 | 1
Example:1

Whether to return the quota as bytes.

  • 1 — Return the quota as bytes.
  • 0 — Return the quota as megabytes (MB).
domainstring domain
Example:example.com

The email account's domain. This parameter defaults to the cPanel account's main domain.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "get_pop_quota",
  "module": "Email",
  "result": {
    "data": 262144000,
    "status": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.