Child pages
  • UAPI Functions - Email::get_default_email_quota_mib

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt
This function retrieves the account's default email quota size, in Mebibytes (MiB) format.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledReceiveMailRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/Email/get_default_email_quota_mib

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Display the default email quota.
$default_quota = $cpanel->uapi(
    'Email', 'get_default_email_quota_mib'
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink
 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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_mib'
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


Code Block
languagexml
<!-- Display the default email quota.
[% execute( 'Email', 'get_default_email_quota_mib' ).data.email %]

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


Code Block
languagebash
uapi --user=username Email get_default_email_quota_mib

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": 32768
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
datainteger

The default email quota, in Mebibytes (MiB).

  • The system's default quota value (32 Gigabytes).
  • The account's quota value, if it is less than the system's default value.

    Note
    titleNote:

    We introduced this possible value in cPanel & WHM version 70.


32768