Description

This function retrieves the account's default email quota size, in Mebibytes (MiB) format.

Examples




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



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Display the default email quota.
$default_quota = $cpanel->uapi(
    'Email', 'get_default_email_quota_mib'
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Display the default email quota.
my $display_quota = $cpliveapi->uapi(
    'Email', 'get_default_email_quota_mib'
);



<!-- Display the default email quota.
[% execute( 'Email', 'get_default_email_quota_mib' ).data.email %]



uapi --user=username Email get_default_email_quota_mib



{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": 32768
}



Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
datainteger

The default email quota, in Mebibytes (MiB).

  • The system's default quota value (32 Gigabytes).
  • The account's quota value, if it is less than the system's default value.

    We introduced this possible value in cPanel & WHM version 70.


32768