Child pages
  • UAPI Functions - SSL::is_mail_sni_supported
Skip to end of metadata
Go to start of metadata

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. 

Note:

In cPanel & WHM version 60 and later, Mail SNI is always enabled.

  • Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.
  • Functions that disable Mail SNI fail and make no changes.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/SSL/is_mail_sni_supported


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

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


Note:

For more information, read our Guide to the LiveAPI System.

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


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Template Toolkit
<!-- Is mail SNI supported. -->
[% execute('SSL', 'is_mail_sni_supported',) %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username SSL is_mail_sni_supported


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
    
  },
  "data": 1
}


Note:

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

Parameters

This function does not accept parameters.

Returns

Return

TypeDescriptionPossible valuesExample
dataBooleanWhether the sslinstall feature is enabled.
  • 1 — Enabled.
  • 0 — Disabled.
1