Child pages
  • UAPI Functions - Email::get_pop_quota
Skip to end of metadata
Go to start of metadata

Description

This function retrieves an email account's quota.

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

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



Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 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',
        )
);


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.
 
# 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',
    }
);


Note:

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

 

 cPanel Template Toolkit
<!-- Get user@example.com's quota in bytes. -->
[% execute('Email', 'get_pop_quota', { 'email' => 'user', 'domain' => 'example.com', 'as_bytes' => '1' } ) %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Email get_pop_quota email=user domain=example.com as_bytes=1


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":"262144000"
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The email account username.

A valid email account username.

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

user
domainstring

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 is user@example.com.

example.com
as_bytesBoolean

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

ReturnTypeDescriptionPossible valuesExample
dataintegerThe email account's quota.

A value that represents the email account's quota.

Note:

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

262144000