We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

Description

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

Important:

In cPanel & WHM version 76 and later, when you disable the Receive Mail role, the system disables this function.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/get_max_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 maximum email quota.
$default_quota = $cpanel->uapi(
    'Email', 'get_max_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 maximum email quota.
my $display_quota = $cpliveapi->uapi(
    'Email', 'get_max_email_quota'
);


Note:

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

 Command Line
uapi --user=username Email get_max_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. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


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


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 maximum email quota, in bytes format.

  • The system's default maximum quota value (4 Pebibytes).

    Note:

    We increased the default maximum value to 4 Pebibytes in cPanel & WHM version 70.

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

    Note:

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

4503599627370496