Child pages
  • UAPI Functions - SSL::rebuild_mail_sni_config
Skip to end of metadata
Go to start of metadata

Description

This function rebuilds the SNI configuration files.

Note:

  • You must run this function after you change the SNI status through the UAPI's enable_mail_sni or disable_mail_sni functions.
  • 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.

Important:

In cPanel & WHM version 84 and later, when you disable the CalendarContact, MailReceiveWebDiskWebmail, and WebServer roles, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/SSL/rebuild_mail_sni_config?reload_dovecot=1


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Rebuild mail SNI configuration files 
$rebuild_mail_sni_config = $cpanel->uapi(
    'SSL', 'rebuild_mail_sni_config',
    array(
        'reload_dovecot'     => '1',
        )
);


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Rebuild mail SNI configuration files 
my $rebuild_mail_sni_config = $cpliveapi->uapi(
    'SSL', 'rebuild_mail_sni_config',
    {
        'reload_dovecot'     => '1',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 Command Line
uapi --user=username SSL rebuild_mail_sni_config reload_dovecot=1


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
    
  },
  "data": {
    "success": 1
  }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
reload_dovecotBoolean

Whether to reload the Dovecot® service after the system rebuilds the configuration files.

This parameter defaults to 1.

  • 1 — Reload Dovecot.
  • 0 — Do not reload Dovecot.
1

Returns

Return

TypeDescriptionPossible valuesExample
successBooleanWhether the system rebuilt the configuration files.
  • 1 — Configuration files rebuilt.
  • 0 — Configuration files not rebuilt.
1