Description

This function retrieves an email account's current disk usage.


We strongly recommend that you use the following UAPI function instead of this function:

Examples 




https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=getdiskusage&domain="example.com"&user="user"



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Get the disk usage for user@example.com.
$list_email_address_info = $cpanel->api2(
    'Email', 'getdiskusage', 
    array(
        'domain'          => 'example.com',
        'user'            => 'user',
    ) 
);



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Get the disk usage for user@example.com.
my $get_disk_use = $cpliveapi->api2(
    'Email', 'getdiskusage',
    { 
        'domain'          => 'example.com',
        'user'            => 'user',
    }
);




cpapi2 --user=username Email getdiskusage domain=example.com user=user



{
  "cpanelresult": {
    "apiversion": 2,
    "func": "getdiskusage",
    "data": [
      {
        "domain": "example.com",
        "user": "user",
        "diskused": 0,
        "login": "user",
      },
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The email account's domain.

A valid domain.

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

example.com
userstring

Required

The email account username.

A valid username.

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

user

Returns

ReturnTypeDescriptionPossible valuesExample
domainstringThe email account's domain.

A valid domain.

 

example.com
userstringThe email account username.

A valid email account username.

 

user
diskusedintegerThe disk space that the email account uses, in Megabytes (MB).
  • A positive floating-point value.
  • 0 — The account possesses an unlimited disk quota.
0
loginstring

The email address, or the main account username.

  • A valid email address.
  • The cPanel account username.

user@example.com

reasonstring

A reason for failure.

This function only returns a reason value if it failed. 


A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1