Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function retrieves the status of the domain's SNI mail services.

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/mail_sni_status?domain=example.com

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.
 
// Mail SNI status on example.com domain.
$mail_sni_status = $cpanel->uapi(
    'SSL', 'mail_sni_status',
    array(
        'domain'     => 'example.com',
        )
);

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.
 
# Mail SNI status on example.com domain.
my $mail_sni_status = $cpliveapi->uapi(
    'SSL', 'mail_sni_status',
    {
        'domain'     => 'example.com',
    }
);

Note:

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

 cPanel Template Toolkit
<!-- Mail SNI status on example.com domain. -->
[% execute('SSL', 'mail_sni_status', { 'domain' => 'example.com' }) %]

Note:

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

 Command Line
uapi --user=username SSL mail_sni_status domain=example.com

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. 
  • We introduced this functionality in cPanel & WHM version 56.

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

Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The account's domain.

A valid account on the server.

example.com

Returns

Return

TypeDescriptionPossible valuesExample
enabledBooleanWhether SNI for mail is enabled.
  • 1 — SNI is enabled.
  • 0 — SNI is not enabled.
1