Child pages
  • WHM API 1 Functions - exim_configuration_check
Skip to end of metadata
Go to start of metadata

Description

This function scans the Exim configuration file for errors, and if it finds errors attempts to repair them.

Important:

In cPanel & WHM version 76 and later, when you disable the MailSend role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/exim_configuration_check?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/exim_configuration_check?api.version=1
 Command Line
whmapi1 exim_configuration_check


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

 Output (JSON)
{
  "data": {
    "message":
 "cPanel was unable to automatically merge your Exim configuration with 
the new settings that shipped \nwith the build you have installed 
(11.38.0 (build 9999)) because you have a custom or broken configuration
 which \ncannot be automatically configured.  \n    Since this 
configuration update is not critical, we left your previous 
configuration intact until \nthe new configuration can be properly 
installed.  In order to complete this configuration update, you will 
\nneed to manually merge your configuration with the new configuration 
settings.  \n\n \nPlease follow the steps below to complete this 
update:\n\n\t1. <a href='javascript:select_exim_backup();'>Backup 
your existing configuration<\/a>\n\t2. <a 
href='javascript:select_exim_advanced();'>Notate any custom changes 
you have made in the ACL section in the 'Advanced Editor 
Tab'.<\/a>\n\t3. <a 
href='javascript:select_exim_reset();'>Choose 'Reset cPanel &amp;
 WHM Exim configuration files, one option at a time, until the installed
 Exim configuration is valid' under the 'Reset Tab'.<\/a>\n\t4. 
<a href='javascript:select_exim_advanced();'>Reinstall your 
customizations in the 'Advanced Editor Tab'.<\/a>\n\n\nCurrent 
Config Version: 10.320000\nNew Config Version: 10.330000"
  },
  "metadata": {
    "version": 1,
    "reason": "Configuration Update Failed",
    "result": 0,
    "command": "exim_configuration_check"
  }
}

 Output (XML)
<result>
    <data>
        <message>
            cPanel
 was unable to automatically merge your Exim configuration with the new 
settings that shipped with the build you have installed (11.38.0 (build 
9999)) because you have a custom or broken configuration which cannot be
 automatically configured. Since this configuration update is not 
critical, we left your previous configuration intact until the new 
configuration can be properly installed. In order to complete this 
configuration update, you will need to manually merge your configuration
 with the new configuration settings. Please follow the steps below to 
complete this update: 1. <a 
href="javascript:select_exim_backup();">Backup your existing 
configuration</a> 2. <a 
href="javascript:select_exim_advanced();">Notate any custom changes 
you have made in the ACL section in the 'Advanced Editor Tab'.</a>
 3. <a href="javascript:select_exim_reset();">Choose 'Reset cPanel
 &amp; WHM Exim configuration files, one option at a time, until the
 installed Exim configuration is valid' under the 'Reset Tab'.</a>
 4. <a href="javascript:select_exim_advanced();">Reinstall your 
customizations in the 'Advanced Editor Tab'.</a> Current Config 
Version: 10.320000 New Config Version: 10.330000
        </message>
    </data>
    <metadata>
        <version>1</version>
        <reason>Configuration Update Failed</reason>
        <result>0</result>
        <command>exim_configuration_check</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
messagestring

The reason why the configuration check failed.

Note:

The function only returns this parameter if the configuration file contains errors.

A valid string.

 

 Click to view...
<result>
     <data>
         <message>
             cPanel was unable to automatically merge your Exim configuration with the new settings that shipped with the build you have installed (11.38.0 (build 9999)) because you have a custom or broken configuration which cannot be automatically configured. Since this configuration update is not critical, we left your previous configuration intact until the new configuration can be properly installed. In order to complete this configuration update, you will need to manually merge your configuration with the new configuration settings. Please follow the steps below to complete this update: 1. <a href="javascript:select_exim_backup();">Backup your existing configuration</a> 2. <a href="javascript:select_exim_advanced();">Notate any custom changes you have made in the ACL section in the 'Advanced Editor Tab'.</a> 3. <a href="javascript:select_exim_reset();">Choose 'Reset cPanel &amp; WHM Exim configuration files, one option at a time, until the installed Exim configuration is valid' under the 'Reset Tab'.</a> 4. <a href="javascript:select_exim_advanced();">Reinstall your customizations in the 'Advanced Editor Tab'.</a> Current Config Version: 10.320000 New Config Version: 10.330000
         </message>
     </data>
     <metadata>
         <version>1</version>
         <reason>Configuration Update Failed</reason>
         <result>0</result>
         <command>exim_configuration_check</command>
     </metadata>
</result>