Child pages
  • WHM API 1 Functions - mail_sni_status

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

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

Note
titleNote:

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.
Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/mail_sni_status?api.version=1&domain=example.com
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/mail_sni_status?api.version=1&domain=example.com
Expand
titleCommand Line
Code Block
languagebash
whmapi1 mail_sni_status domain=example.com 

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
    "data": {
        "enabled": 1
    },
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": "1",
        "command": "mail_sni_status"
    }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<result>
    <data>
        <enabled>1</enabled>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>mail_sni_status</command>
    </metadata>
</result>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The account's domain.

A valid cPanel account on the server.example.com

 

Returns

ReturnTypeDescriptionPossible valuesExample

enabled

BooleanWhether SNI for mail is enabled.
  • 1 — Enabled.
  • 0 — Disabled.
1