cPanel API 2 Functions - Email::get_max_email_quota - Knowledgebase

Description

This function retrieves the system's maximum email quota.

Warning:

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

Email::get_max_email_quota — This function retrieves the system's maximum email quota.
Email::get_max_email_quota_mib — This function retrieves the system's maximum email quota in mebibytes.

Examples

WHM API (JSON)

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

LiveAPI PHP Class

$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'

);

LiveAPI Perl Module

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',

);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --user=username Email get_max_email_quota

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
get_max_email_quota	integer	The system's maximum email quota.	A positive integer that measures the quota in Megabytes (MB).	2048
reason	string	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.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories