Child pages
  • cPanel API 1 Functions - Email::editquota

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function modifies an email account's quota.

Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended)Email::edit_pop_quota
    Excerpt Include
    UAPI Functions - Email::edit_pop_quota
    UAPI Functions - Email::edit_pop_quota
    nopaneltrue
  • cPanel API 2Email::editquota
    Excerpt Include
    cPanel API 2 Functions - Email::editquota
    cPanel API 2 Functions - Email::editquota
    nopaneltrue
Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$change_email_quota = $cpanel->api1('Email', 'editquota', array('user', 'example.com', '500') ); // Call the function.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $change_email_quota = $cpliveapi->api1('Email', 'editquota', ['user', 'example.com', '500'] ); # Call the function.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="Email::editquota( $FORM('email','domain','quota') )">
Expand
titleCommand Line
Code Block
cpapi1 --user=username Email editquota user example.com 500

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote

Expand
titleOutput (string)

This function does not return output.

Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The email account name.

A valid email account name.

For example, user if the email address is user@example.com.

user
domain string

Required

The email account's domain.

The domain that corresponds to the email account.

For example, example.com if the email address is user@example.com.

example.com
quotainteger

Required

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

An integer value.

Note
titleNote:

To grant the account unlimited disk space, specify 0 for this parameter. 

500

Returns

This function does not return output.