Child pages
  • cPanel API 2 Functions - Email::getdiskusage
Skip to end of metadata
Go to start of metadata

Description

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

Warning:

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

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 WHM API (JSON)
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"


Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$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',
    ) 
);


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
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',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Tag System (deprecated)


Warnings:

  • In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

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


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

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


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

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.

Note:

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