Description
This function retrieves the system's maximum email quota.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/get_max_email_quota
LiveAPI PHP Class
$cpanel = new CPANEL();
$default_quota = $cpanel->uapi(
'Email', 'get_max_email_quota'
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $display_quota = $cpliveapi->uapi(
'Email', 'get_max_email_quota'
);
cPanel Template Toolkit
<!-- Display the maximum email quota.
[% execute( 'Email', 'get_max_email_quota' ).data.email %]
|
Command Line
uapi --user=username Email get_max_email_quota
|
Output (JSON)
{
"messages": null,
"errors": null,
"status": 1,
"data": 2048
}
Parameters
This function does not accept parameters.
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
data
|
string
|
The system's maximum email quota.
|
A positive value that represents the quota, measured in Megabytes (MB).
|
2048
|
