UAPI Functions - Email::check_fastmail

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(); // Connect to cPanel - only do this once.
  
// Check whether BlackBerry FastMail is enabled. 
$fastmail_enabled $cpanel->uapi(
    'Email''check_fastmail'
);

 LiveAPI Perl Module

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

 cPanel Template Toolkit

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

 Command Line

uapi --user=username Email check_fastmail

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

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

 

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

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

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....