Description

This function modifies an email account's disk quota.

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

Examples 


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

$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',
    ) 
);

 

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',
    }
);

 

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

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

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

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
emailstring

Required

The email account's name.

A valid email account name.

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

user
quotainteger

Required

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

A positive integer.

To grant unlimited disk space, specify 0.

500

Returns

ReturnTypeDescriptionPossible valuesExample
reasonstring

A reason for failure.

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