Description

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

Examples 




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




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

 



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

 



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

 



uapi --user=username Email get_main_account_disk_usage



{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data": "3076 bytes",
}



Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample

data

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

A numeric value, and the string bytes.

3076 bytes