UAPI Functions - Email::get_default_email_quota

Description

This function retrieves the system's default email quota.

Examples 


 cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Email/get_default_email_quota

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Display the default email quota.
$default_quota $cpanel->uapi(
    'Email''get_default_email_quota'
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Display the default email quota.
my $display_quota $cpliveapi->uapi(
    'Email''get_default_email_quota'
);

 cPanel Template Toolkit

<!-- Display the default email quota.
[% execute( 'Email', 'get_default_email_quota' ).data.email %]

 Command Line

uapi --user=username Email get_default_email_quota

 

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": 256
}

 

Note:

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

 

Parameters

This function does not accept parameters.

Returns

 Return 

Type

Description

Possible values

 Example 

data

 string 

 The system's default email quota. 

 A positive value that measures the quota, measured in Megabytes (MB). 

256

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....