Description

This function returns the status of the eximstats SQLite Database.

Examples 




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




$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',
);

 



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',
);

 



[% execute('Email', 'stats_db_status', {} ) %]

 



uapi --user=username Email stats_db_status



{  

   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  
   },
   "data":"active"
}



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.

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


active