Return email account's disk usage

This function retrieves the disk space that an email account uses.

Important:

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

Authorizations:
query Parameters
domain
required
string <domain>

The email account's domain.

Example: domain=example.com
user
required
string <username>

The email account username.

Example: user=user

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

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "get_disk_usage",
  • "module": "Email",
  • "result": {
    • "data": {
      • "diskused": 399.6,
      • "domain": "example.com",
      • "login": "user@example.com",
      • "user": "user"
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}