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.

Authorizations:
query Parameters
email
required
string

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

Example: email=user
as_bytes
integer
Default: 0

Whether to return the quota as bytes.

  • 1 — Return the quota as bytes.
  • 0 — Return the quota as megabytes (MB).
Enum: 0 1
Example: as_bytes=1
domain
string <domain>

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

Example: domain=example.com

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  Email \
  get_pop_quota \
  email='user'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "get_pop_quota",
  • "module": "Email",
  • "result": {
    • "data": 262144000,
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}