cPanel API 1 Functions - Email::mainacctdiskused - Knowledgebase

Knowledgebase

Description

This function returns the amount of disk space that the main mail account uses.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — Email::get_main_account_disk_usage — This function returns the disk space that the main account uses.
cPanel API 2 — None.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

$main_mail_space = $cpanel->api1('Email', 'mainacctdiskused') ); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

my $main_mail_space = $cpliveapi->api1('Email', 'mainacctdiskused'); # Call the function.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Email::mainacctdiskused() )">

Parameters

This function does not accept parameters.

Returns

This function returns the amount of disk space that the main mail account currently uses, in Megabytes (MB), as an integer value.

Knowledgebase

Categories

Categories