cPanel API 2 Functions - Email::editquota

Warning:

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

Description

This function modifies an email account's disk quota.

Warning:

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

Email::edit_pop_quota — This function changes an email address's quota.

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=editquota&domain=example.com&email=user&quota=500

Note:

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

LiveAPI PHP Class

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

// Update the quota for user@example.com.
$change_email_quota = $cpanel->api2(
    'Email', 'editquota',
    array(
        'domain'          => 'example.com',
        'email'           => 'user',
        'quota'           => '500',
    )
);

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.

# Update the quota for user@example.com.
my $change_email_quota = $cpliveapi->api2(
    'Email', 'editquota',
    {
        'domain'          => 'example.com',
        'email'           => 'user',
        'quota'           => '500',
    }
);

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

cpapi2 --user=username Email editquota domain=example.com email=user quota=500

Note:

For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.

Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "editquota",
    "data": [
      {
        "reason": "",
        "result": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

Note:

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

Parameters

Parameter Type Description Possible values Example

Parameter	Type	Description	Possible values	Example
`domain`	string	Required The email account's domain.	A valid domain on the cPanel account. For example, `example.com` to modify the quota for `user@example.com`.	`example.com`
`email`	string	Required The email account's name.	A valid email account name. For example, `user` to modify the quota for `user@example.com`	`user`
`quota`	integer	Required The maximum amount of disk space that the email account may use.	A positive integer. Note: To grant unlimited disk space, specify `0`.	`500`

domain

string

Required

The email account's domain.

A valid domain on the cPanel account.

For example, example.com to modify the quota for user@example.com.

example.com

email

string

Required

The email account's name.

A valid email account name.

For example, user to modify the quota for user@example.com

user

quota

integer

Required

The maximum amount of disk space that the email account may use.

A positive integer.

Note:

To grant unlimited disk space, specify 0.

500

Returns

Return	Type	Description	Possible values	Example
`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`