Description

This function enables SNI mail services on the specified domains.


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/enable_mail_sni?domains=example.com%7Cexample1.com%7Cexample2.com



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Enable SNI on example.com, example1.com, example2.com domains.
$enable_sni = $cpanel->uapi(
    'SSL', 'enable_mail_sni',
    array(
        'domains'     => 'example.com|example1.com|example2.com',
        )
);



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Enable SNI on example.com, example1.com, example2.com domains.
my $enable_sni = $cpliveapi->uapi(
    'SSL', 'enable_mail_sni',
    {
        'domains'     => 'example.com|example1.com|example2.com',
    }
);



<!-- Enable SNI on example.com, example1.com, example2.com domains. -->
[% execute('SSL', 'enable_mail_sni', { 'domains' => 'example.com|example1.com|example2.com' }) %]



uapi --user=username SSL enable_mail_sni domains=example.com%7Cexample1.com%7Cexample2.com



{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
    
  },
  "data": {
    "updated_domains": {
      "example.com": 1,
      "example1.com": 1
    },
    {
    "failed_domains": {
      "example2.com": 1
    }
  }
}



  Parameters

ParameterTypeDescriptionPossible valuesExample
domainsstring

Required

The account's domain or domains.

A pipe-delimited list of the account's domains.

example.com|example1.com|example2.com

Returns

Return

TypeDescriptionPossible valuesExample
failed_domainshashA hash of the domains that did not enable mail SNI.This hash includes the domain name return. 

domain name

string

The reason the domain failed to enable mail SNI.

The domain name is the return name.

The function returns this value in the failed_domains hash.

A valid string.

Sorry, example.com is not one of the domains on your account.
updated_domainshash

A hash of the domains with disabled mail SNI.

This hash includes the domain name return.

 

domain name

Boolean

Whether the domain's SNI is enabled.

The domain name is the return name.

The function returns this value in the updated_domains hash.

  • 1 — Enabled.
  • 0 — Not enabled.
1