Description

This function checks whether BlackBerry® FastMail support is enabled.

Examples 




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




$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Check whether BlackBerry FastMail is enabled.  
$fastmail_enabled = $cpanel->uapi(
    'Email', 'check_fastmail'
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Check whether BlackBerry FastMail is enabled.
my $fastmail_enabled = $cpliveapi->uapi(
    'Email', 'check_fastmail',
);

 



<!-- Check whether BlackBerry FastMail is enabled. -->
[% execute('Email', 'check_fastmail' ) %]

 



uapi --user=username Email check_fastmail



{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":"2"
}



Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
datastringThe 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