Enable SNI mail services for domain

This function enables SNI mail services on the specified domains.

Warning:

Mail SNI is always enabled.

  • Mail SNI is not compatible with Webmail and will not function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.
  • 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.

Important:

When you disable the Calendars and Contacts, Mail Receive, Web Disk, Webmail, and Web Server roles, the system disables this function.

SecurityBasicAuth
Request
query Parameters
domains
required
string

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

Example: domains=example.com|example1.com|example2.com
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/SSL/enable_mail_sni
Request samples
uapi --output=jsonpretty \
  --user=username \
  SSL \
  enable_mail_sni \
  domains='example.com|example1.com|example2.com'
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "enable_mail_sni",
  • "module": "SSL",
  • "result": {
    • "data": {
      • "failed_domains": {
        • "example2.com": "Sorry, example.com is not one of the domains on your account."
        },
      • "updated_domains": {
        • "example.com": 1,
        • "example1.com": 1
        }
      },
    • "errors": null,
    • "messages": [
      • "cPanel & WHM always enables mail SNI from now on."
      ],
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}