UAPI Functions - SSL::is_mail_sni_supported - Knowledgebase

Description

This function checks whether the sslinstall feature is enabled.

Warning:

Mail SNI is not compatible with Webmail and will not function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/SSL/is_mail_sni_supported

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Is mail SNI supported.

$is_mail_sni_supported = $cpanel->uapi(

'SSL', 'is_mail_sni_supported'

)

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Is mail SNI supported.

my $is_mail_sni_supported = $cpliveapi->uapi(

'SSL', 'is_mail_sni_supported',

);

cPanel Template Toolkit

[% execute('SSL', 'is_mail_sni_supported',) %]

Command Line

uapi --user=username SSL is_mail_sni_supported

Notes:

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

 Output (JSON)

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

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	Boolean	Whether the sslinstall feature is enabled.	1 — Enabled. 0 — Disabled.	1

Knowledgebase

Categories

Categories