Description
This function checks whether BlackBerry® FastMail support is enabled.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/check_fastmail
LiveAPI PHP Class
$cpanel
=
new
CPANEL();
$fastmail_enabled
=
$cpanel
->uapi(
'Email'
,
'check_fastmail'
);
LiveAPI Perl Module
my
$cpliveapi
= Cpanel::LiveAPI->new();
my
$fastmail_enabled
=
$cpliveapi
->uapi(
'Email'
,
'check_fastmail'
,
);
cPanel Template Toolkit
[% execute('Email', 'check_fastmail' ) %]
Command Line
uapi --user=username Email check_fastmail
|
Output (JSON)
{
"messages":null,
"errors":null,
"status":1,
"metadata":{
},
"data":"2"
}
Parameters
This function does not accept parameters.
Returns
Return
|
Type
|
Description
|
Possible values
|
Example
|
data
|
string
|
The contents of the server's/var/cpanel/fastmail file.
|
- A positive value that represents a BlackBerry FastMail version number if it is enabled on the server.
- A null value if BlackBerry FastMail is not enabled on the server.
|
2
|