We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

Description

This function returns the status of the eximstats SQLite Database.

Important:

In cPanel & WHM version 76 and later, when you disable the Receive Mail role, the system disables this function.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/stats_db_status



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 status of the eximstats SQLite Database.
$stats_db_status = $cpanel->uapi(
    'Email', 'stats_db_status',
);


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 status of the eximstats SQLite Database.
my $stats_db_status = $cpliveapi->uapi(
    'Email', 'stats_db_status',
);


Note:

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


 Command Line
uapi --user=username Email stats_db_status


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":"active"
}


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


stringThe disk space that the email account uses.
  • active — The database is available and up-to-date.
  • importing — The database is available, but a data import is currently in progress.
  • upcp — The database is unavailable because cPanel & WHM is updating.

Note:

If the eximstats database is running a cPanel & WHM update, but the database is available, this function will return active, not upcp.

active