Child pages
  • cPanel API 1 Functions - Email::getpopquota
Skip to end of metadata
Go to start of metadata

 

Description

This function retrieves an email account's disk quota.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$get_disk_quota = $cpanel->api1('Email', 'getpopquota', array('user','example.com') ); // Call the function.


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.
my $get_disk_quota = $cpliveapi->api1('Email', 'getpopquota', ['user','example.com'] ); # Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Email::getpopquota( $FORM('email','domain') )">
 Command Line
cpapi1 --user=username Email getpopquota user example.com


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command. 

 Output (integer or plaintext)
500

Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The email account name.

A valid email account name on the server.

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

user
domainstring

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

Returns

This function returns an integer that represents the quota for the email account.

Note:

A value of unlimited indicates that the account may use unlimited disk space.