Page tree
Skip to end of metadata
Go to start of metadata

 

Description

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

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/exim_configuration_check
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/exim_configuration_check
 Command Line
whmapi0 exim_configuration_check

Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 0 documentation or run the whmapi0 --help command. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{
   "message" : null,
   "status" : 1,
   "statusmsg" : "Configuration OK"
}
 Output (XML)
<exim_configuration_check>
    <message/>
    <status>1</status>
    <statusmsg>Configuration OK</statusmsg>
</exim_configuration_check>

   

Parameters

This function does not accept parameters. 

Returns

ReturnTypeDescriptionPossible valuesExample
exim_configuration_check
 hash

A hash of the configuration return information.

This hash includes the message, status, and statusmsg returns. 

message

string

The reason why the configuration check failed.

Note:

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

The function returns this value in the exim_configuration_check hash.

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>

statusmsg

string

An Exim configuration file status message.

The function returns this value in the exim_configuration_check hash.

A valid string.
Configuration OK

status

Boolean

Whether the function failed.

The function returns this value in the exim_configuration_check hash.

  • 1 — Success.
  • 0 — Failure.
 1