UAPI Functions - Email::get_main_account_disk_usage

Description

This function returns the disk space that the main account uses.

Examples 


 cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Email/get_main_account_disk_usage

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// List disk usage for the main account.
$disk_used $cpanel->uapi(
    'Email''get_main_account_disk_usage'
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List disk usage for the main account.
my $disk_used $cpliveapi->uapi(
    'Email''get_main_account_disk_usage',
);

 cPanel Template Toolkit

<!-- Get only the disk use. -->
[% execute('Email', 'get_main_account_disk_usage', ) %]

 Command Line

uapi --user=username Email get_main_account_disk_usage

 

Notes:

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

 Output (JSON)

   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
 
   },
   "data": "3076 bytes",
}

 

Note:

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

 

Parameters

This function does not accept parameters.

Returns

 Return 

Type

Description

Possible values

Example

data

 string 

 The current amount of disk space that the main email account uses. 

 A numeric value, and the stringbytes. 

 3076 bytes 

 

  • 0 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....