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

Description

This function returns the total disk usage for the mailing lists of a cPanel account.

Important:

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_lists_total_disk_usage


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.
 
// Return the total disk usage for the mailing lists of a cPanel account.
$variable = $cpanel->uapi(
    'Email', 'get_lists_total_disk_usage'
);


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.
 
# Return the total disk usage for the mailing lists of a cPanel account.
my $variable = $cpliveapi->uapi(
    'Email', 'get_lists_total_disk_usage'
);


Note:

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

 cPanel Template Toolkit
<!-- Return the total disk usage for the mailing lists of a cPanel account. -->
[% execute('Email', 'get_lists_total_disk_usage') %]


Note:

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

 Command Line
uapi --user=username Email get_lists_total_disk_usage


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)
{
  "data": 1024,
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
    "transformed": 1
  }
}


Note:

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

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
datainteger

The total disk usage for the mailing lists of a cPanel account, in bytes.

  • 0
  • A positive integer.
1024