UAPI Functions - SSL::mail_sni_status - Knowledgebase

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.

Examples

cPanel or Webmail Session URL

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

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

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

cPanel Template Toolkit

[% execute('SSL', 'mail_sni_status', { 'domain' => 'example.com' }) %]

Command Line

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

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
  "data": {
    "enabled": 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
domain	string	Required The account's domain.	A valid account on the server.	example.com

Parameter

Type

Description

Possible values

Example

domain

string

Required

The account's domain.

A valid account on the server.

example.com

Returns

Return	Type	Description	Possible values	Example
enabled	Boolean	Whether SNI for mail is enabled.	1 — SNI is enabled. 0 — SNI is not enabled.	1

Knowledgebase

Categories

Categories