cPanel API 2 Functions - Email::getdiskusage

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:

  • Email::get_disk_usage — This function retrieves the disk space that an email account uses.

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=

 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',
    
);

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

 cPanel Tag System (deprecated)

Warning:

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.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 

 Command Line

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

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

 Parameter 

 Type

Description

Possible values

Example

 domain

 string

 Required

 The email account's domain.

 A valid domain.

 For example, example.com if the email address isuser@example.com. 

 example.com 

 user

 string 

 Required

 The email account username. 

 A valid username.

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

 user

 

Returns

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). 

  • A positive floating-point value.
  • 0 — The account possesses an unlimited disk quota. 

 0

 login

 string

 The email address, or the main account username.

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

 user@example.com

 reason

 string

 A reason for failure.

 Note:

 This function only returns areason value if it failed. 

 A string that describes the error.

 This is an error message. 

 result

 Boolean 

 Whether the function succeeded.

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

 1

 

  • 9 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....