- Created by Documentation, last modified on Apr 09, 2018
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
Description
This function retrieves the status of the domain's SNI mail services.
Note:
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:2087/cpsess##########/json-api/mail_sni_status?api.version=1&domain=example.com
https://hostname.example.com:2087/cpsess##########/xml-api/mail_sni_status?api.version=1&domain=example.com
whmapi1 mail_sni_status domain=example.com
Notes:
- You must URI-encode values.
- For more information and additional output options, read our Guide to WHM API 1 documentation or run the
whmapi1 --help
command. If you run CloudLinux™, you must use the full path of the
whmapi1
command:/usr/local/cpanel/bin/whmapi1
{ "data": { "enabled": 1 }, "metadata": { "version": 1, "reason": "OK", "result": "1", "command": "mail_sni_status" } }
<result> <data> <enabled>1</enabled> </data> <metadata> <version>1</version> <reason>OK</reason> <result>1</result> <command>mail_sni_status</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
domain | string | Required The account's domain. | A valid cPanel account on the server. | example.com |
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
| Boolean | Whether SNI for mail is enabled. |
| 1 |
Function information
API Version:
Available in:
WHM 11.48+
Methods:
GET, POST
Required Parameters:
domain
Return Formats:
About WHM API 1
WHM API 1 performs functions and accesses data in WHM.
Notes:
- Some functions and parameters may require that you authenticate as the
root
user. - You must use the appropriate WHM ports (
2086
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Functions - disable_mail_sni — This function disables mail SNI for an account.
-
Page:WHM API 1 Functions - enable_mail_sni — This function enables mail SNI for an account.
-
Page:WHM API 1 Functions - mail_sni_status — This function retrieves the status of the domain's SNI mail services.
-
Page:WHM API 1 Functions - rebuild_mail_sni_config — This function rebuilds the mail SNI configuration files.