Child pages
  • UAPI Functions - Email::get_default_email_quota
Skip to end of metadata
Go to start of metadata

Description

This function retrieves the account's default email quota size, in bytes format.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/get_default_email_quota


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

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


Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
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'
);


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Template Toolkit
<!-- Display the default email quota.
[% execute( 'Email', 'get_default_email_quota' ).data.email %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username Email get_default_email_quota


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": 34359738368
}


Note:

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

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
datainteger

The default email quota, in bytes format.

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

    Note:

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

34359738368