Update email account's quota

This function changes an email address's quota.

Authorizations:
query Parameters
domain
required
string <domain>

The email account's domain. Defaults to the cPanel account's main domain.

Example: domain=example.com
email
required
string

The email account username.

Example: email=user
quota
string

The maximum amount of disk space that the new email account may use. Defaults to the system value.

  • A positive integer that represents the maximum amount of disk space, in megabytes (MB).

Note:

You cannot enter a value that exceeds the maximum email quota.

  • 0 or unlimited — The account possesses unlimited disk space.

If the email account's quota value is set higher (or unlimited) than the account's max quota, the account's max quota will be applied instead of the value entered.

Note:

This value is only available to users without a maximum email account quota.

Example: quota=500

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 \
  edit_pop_quota \
  email='user' \
  domain='example.com'

Response samples

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