UAPI Functions - Email::edit_pop_quota - Knowledgebase

Description

This function changes an email address's quota.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Email/edit_pop_quota?email=user&quota=0&domain=example.com

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Update user@example.com's quota.
$change_quota = $cpanel->uapi(
    'Email', 'edit_pop_quota',
    array(
        'email'           => 'user',
        'quota'           => '0',
        'domain'          => 'example.com',
        )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Update user@example.com's quota.
my $change_quota = $cpliveapi->uapi(
    'Email', 'edit_pop_quota',
    {
        'email'           => 'user',
        'quota'           => '0',
        'domain'          => 'example.com',
    }
);

cPanel Template Toolkit

[% execute('Email', 'edit_pop_quota', { 'email' => 'user', 'quota' => '0', 'domain' => 'example.com', } ) %]

Command Line

uapi --user=username Email edit_pop_quota email=user quota=0 domain=example.com

Notes:

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

 Output (JSON)

{ 
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
 
   },
   "data":null,
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
email	string	Required The email account username.	A valid email account username. For example, user if the email address isuser@example.com.	user
domain	string	Required The email account's domain. This parameter defaults to the cPanel account's main domain.	A valid domain on the cPanel account. For example, example.com if the email address isuser@example.com.	example.com
quota	string	The maximum amount of disk space that the new email account may use. This parameter defaults tounlimited.	A positive integer that is less than 2048 which represents the maximum amount of disk space in Megabytes (MB). 0 or unlimited, to grant unlimited disk space.	500

Returns

This function only returns metadata.

Knowledgebase

Categories

Categories