Warning:
The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.
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:
Email::get_disk_usage— This function retrieves the disk space that an email account uses.
When you disable the Receive Mail role, the system disables this function.
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"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',
)
);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',
}
);For more information, read our Guide to the LiveAPI System.
cPanel Tag System (deprecated)
- 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- You must URI-encode values.
usernamerepresents your account-level username.- You must run the
--user=usernamecommand. - For more information and additional output options, read our Guide to cPanel API 2 documentation or run the
cpapi2 --helpcommand. - If you run CloudLinux™, you must use the full path of the
cpapi2command:syntaxhighlighter-pre/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"
}
}Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.
| Parameter | Type | Description | Possible values | Example |
|---|---|---|---|---|
domain | string | Required The email account's domain. | A valid domain. For example, | example.com |
user | string | Required The email account username. | A valid username For example, | user |
| Return | Type | Description | Possible values | Example |
|---|---|---|---|---|
domain | string | The email account's domain. | A valid domain. | example.com |
user | string | The email account username. | A valid email account username. | user |
diskused | integer | The disk space that the email account uses, in megabytes (MB). |
| 0 |
login | string | The email address, or the main account username. |
|
|
reason | string | A reason for failure. Note: This function only returns a | A string that describes the error. | This is an error message. |
result | Boolean | Whether the function succeeded. |
| 1 |