UAPI Functions - SSL::enable_mail_sni - Knowledgebase

Description

This function enables SNI mail services on the specified domains.

Warning:

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

Notes:

After you change the SNI status, you must run UAPI's rebuild_mail_sni_config function.
SNI for Mail Services is only available for Dovecot and Exim. If your server uses Courier for incoming mail services, the domain's certificate secures the outgoing mail and the server's default certificate secures the incoming mail.

Warning:

We removed the Courier mail server in cPanel & WHM version 54. The Courier mail server only exists for cPanel & WHM version 11.52 and earlier.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/SSL/enable_mail_sni?domains=example.com%7Cexample1.com%7Cexample2.com

 LiveAPI PHP Class

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

 LiveAPI Perl Module

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

cPanel Template Toolkit

[% execute('SSL', 'enable_mail_sni', { 'domains' => 'example.com|example1.com|example2.com' }) %]

Command Line

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

Notes:

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

 Output (JSON)

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

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
domains	string	Required The account's domain or domains.	A pipe-delimited list of the account's domains.	example.com\|example1.com\|example2.com

Parameter

Type

Description

Possible values

Example

domains

string

Required

The account's domain or domains.

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

example.com|example1.com|example2.com

Returns

Return	Type	Description	Possible values	Example
failed_domains	hash	A hash of the domains that did not enable mail SNI.	This hash includes thedomain name return.
domain name	string	The reason the domain failed to enable mail SNI. Note: 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_domains	hash	A hash of the domains with disabled mail SNI.	This hash includes thedomain name return.
domain name	Boolean	Whether the domain's SNI is enabled. Note: The domain name is the return name. The function returns this value in the updated_domains hash.	1 — Enabled. 0 — Not enabled.	1

Knowledgebase

Categories

Categories