UAPI Functions - SSL::rebuild_mail_sni_config - Knowledgebase

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.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/SSL/rebuild_mail_sni_config?reload_dovecot=1

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

)

);

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

cPanel Template Toolkit

[% execute('SSL', 'rebuild_mail_sni_config', { 'reload_dovecot' => '1' }) %]

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.

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
  "data": {
    "success": 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
reload_dovecot	Boolean	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

Parameter

Type

Description

Possible values

Example

reload_dovecot

Boolean

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.

Returns

Return	Type	Description	Possible values	Example
success	Boolean	Whether the system rebuilt the configuration files.	1 — Configuration files rebuilt. 0 — Configuration files not rebuilt.	1

Knowledgebase

Categories

Categories