Description

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

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 




https://hostname.example.com:2083/cpsess##########/execute/SSL/mail_sni_status?domain=example.com



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



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



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



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



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



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