UAPI Functions - Email::get_pop_quota - Knowledgebase

Description

This function retrieves an email account's quota.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Email/get_pop_quota?email=user&domain=example.com&as_bytes=1

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Get user@example.com's quota in bytes.
$email_quota = $cpanel->uapi(
    'Email', 'get_pop_quota',
    array(
        'email'           => 'user',
        'domain'          => 'example.com',
        'as_bytes'        => '1',
        )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Get user@example.com's quota in bytes.
my $email_quota = $cpliveapi->uapi(
    'Email', 'get_pop_quota',
    {
        'email'           => 'user',
        'domain'          => 'example.com',
        'as_bytes'        => '1',
    }
);

cPanel Template Toolkit

[% execute('Email', 'get_pop_quota', { 'email' => 'user', 'domain' => 'example.com', 'as_bytes' => '1' } ) %]

Command Line

uapi --user=username Email get_pop_quota email=user

Notes:

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

 Output (JSON)

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

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	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
as_bytes	Boolean	Whether to return the quota as bytes. This parameter defaults to 0.	1 — Return the quota as bytes. 0 — Return the quota as Megabytes (MB).	1

Returns

Return	Type	Description	Possible values	Example
data	integer	The email account's quota.	An integer that represents the email account's quota. Note: This value's unit of measure depends on the as_bytes input parameter's value.	262144000

Return

Type

Description

Possible values

Example

data

integer

The email account's quota.

An integer that represents the email account's quota.

Note:

This value's unit of measure depends on the as_bytes input parameter's value.

262144000

Knowledgebase

Categories

Categories