Skip to content
cPanel API 2 Modules
/
cPanel API 2 Modules - Email
/
cPanel API 2 Functions - Email::get_max_email_quota
Last updated

cPanel API 2 Functions - Email::get_max_email_quota

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function retrieves the system's maximum email quota.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

  • Email::get_max_email_quota — This function retrieves the account's maximum email quota size, in bytes format.
  • Email::get_max_email_quota_mib — This function retrieves the account's maximum email account quota size, in Mebibytes (MiB) format.

Examples

WHM API (JSON)

syntaxhighlighter-pre
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=get_max_email_quota
Note:

For more information, read our Calls from the WHM API documentation.


LiveAPI PHP Class

syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Retrieve the system maximum email quota.
$max_quota = $cpanel->api2(
    'Email', 'get_max_email_quota'
);
Note:

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


LiveAPI Perl Module

syntaxhighlighter-pre
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Retrieve the system maximum email quota.
my $max_quota = $cpliveapi->api2(
    'Email', 'get_max_email_quota',
);
Note:

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


cPanel Tag System (deprecated)

Warnings:
  • cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

syntaxhighlighter-pre
cpapi2 --user=username Email get_max_email_quota
Notes:
  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:
    syntaxhighlighter-pre
    /usr/local/cpanel/bin/cpapi2

Output (JSON)

syntaxhighlighter-pre
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "get_max_email_quota",
    "data": [
      {
        "get_max_email_quota": 2048
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}
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
get_max_email_quotaintegerThe system's maximum email quota.A positive integer that measures the quota in megabytes (MB).2048
reasonstring

A reason for failure.

Note:

This function only returns a reason value if it failed.


A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1
Previous page
Next page