cPanel API 1 Functions - Email::getpopquota - Knowledgebase

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:

UAPI (recommended) — Email::get_pop_quota — This function retrieves an email account's quota.
cPanel API 2 — None.

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.

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.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Email::getpopquota( $FORM('email','domain') )">

Output (integer or plaintext)

500

Parameters

Parameter	Type	Description	Possible values	Example
email	string	Required The email account name.	A valid email account name on the server. For example, user if the email address isuser@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 isuser@example.com .	example.com

Parameter

Type

Description

Possible values

Example

string

Required

The email account name.

A valid email account name on the server.

For example, user if the email address isuser@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 isuser@example.com .

example.com

Returns

This function returns the quota for the email account, as an integer.

Note:

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

Knowledgebase

Categories

Categories