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

Description

This function evaluates and validates an Exim configuration file's syntax.


Note:

On servers that run CentOS 7, you may see a named warning about the absence of SPF resource records on DNS.

  • This warning is not relevant on CentOS 7 servers, because RFC 7208 deprecated SPF records. CentOS 7 servers use TXT records instead of SPF records.
  • Red Hat 7.1 and CentOS 7.1 both contain bind-9.9.4-23.el7, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the Red Hat Bugzilla case about SPF record errors.

Examples


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


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. 

 Output (JSON)
{  
   "data":{  
      "exim_caps":{  
         "rewrite_from_remote":0,
         "archive":1,
         "force_command":1,
         "maildir":1,
         "exiscan":1,
         "content_scanning":1,
         "passwd":1,
         "spf":1,
         "boxtrapper":1,
         "no_forward_outbound_spam":1,
         "domainkeys":0,
         "rewrite_from_all":0,
         "notquit":1,
         "add_header":1,
         "dkim":1,
         "dovecot":1,
         "mailman":1,
         "no_forward_outbound_spam_over_int":0,
         "directives":{  
            "prod_requires_admin":1,
            "message_body_visible":1,
            "system_filter_group":1,
            "retry_interval_max":1,
            "smtp_accept_keepalive":1,
            "write_rejectlog":1,
            "queue_list_requires_admin":1,
            "allow_mx_to_ip":1,
            "dns_use_edns0":1,
            "bounce_return_message":1,
            "log_selector":1,
            "acl_smtp_dkim":1,
            "queue_only_load_latch":1,
            "disable_ipv6":1,
            "dns_check_names_pattern":1,
            "strip_excess_angle_brackets":1,
            "unknown_username":1,
            "check_log_space":1,
            "ignore_fromline_hosts":1,
            "unknown_login":1,
            "return_path_remove":1,
            "acl_smtp_starttls":1,
            "pid_file_path":1,
            "tls_on_connect_ports":1,
            "ignore_bounce_errors_after":1,
            "prdr_enable":1,
            "timeout_frozen_after":1,
            "gnutls_allow_auto_pkcs11":1,
            "header_line_maxsize":1,
            "queue_domains":1,
            "tls_advertise_hosts":1,
            "acl_not_smtp":1,
            "message_logs":1,
            "callout_domain_positive_expire":1,
            "acl_not_smtp_start":1,
            "auth_advertise_hosts":1,
            "daemon_startup_sleep":1,
            "process_log_path":1,
            "spf_guess":1,
            "local_from_prefix":1,
            "smtp_max_unknown_commands":1,
            "mua_wrapper":1,
            "hosts_treat_as_local":1,
            "pipelining_advertise_hosts":1,
            "bounce_return_size_limit":1,
            "callout_negative_expire":1,
            "delay_warning_condition":1,
            "helo_accept_junk_hosts":1,
            "warn_message_file":1,
            "bi_command":1,
            "helo_verify_hosts":1,
            "check_log_inodes":1,
            "acl_smtp_expn":1,
            "acl_smtp_data_prdr":1,
            "queue_only_override":1,
            "local_sender_retain":1,
            "acl_smtp_mailauth":1,
            "helo_try_verify_hosts":1,
            "dkim_verify_signers":1,
            "syslog_processname":1,
            "system_filter_pipe_transport":1,
            "tls_verify_hosts":1,
            "bounce_sender_authentication":1,
            "split_spool_directory":1,
            "uucp_from_pattern":1,
            "dns_csa_search_limit":1,
            "acl_smtp_helo":1,
            "srs_hashlength":1,
            "log_file_path":1,
            "queue_only_load":1,
            "local_from_check":1,
            "message_size_limit":1,
            "smtp_ratelimit_rcpt":1,
            "smtp_max_synprot_errors":1,
            "queue_smtp_domains":1,
            "dns_csa_use_reverse":1,
            "preserve_message_logs":1,
            "message_id_header_text":1,
            "srs_config":1,
            "smtp_etrn_serialize":1,
            "max_username_length":1,
            "message_id_header_domain":1,
            "smtp_accept_max_per_host":1,
            "admin_groups":1,
            "log_timezone":1,
            "smtp_load_reserve":1,
            "received_header_text":1,
            "smtp_accept_max_per_connection":1,
            "smtp_connect_backlog":1,
            "print_topbitchars":1,
            "perl_at_start":1,
            "keep_environment":1,
            "trusted_groups":1,
            "dns_retry":1,
            "exim_group":1,
            "system_filter_reply_transport":1,
            "event_action":1,
            "gnutls_compat_mode":1,
            "system_filter_file_transport":1,
            "tls_require_ciphers":1,
            "recipients_max":1,
            "check_rfc2047_length":1,
            "callout_positive_expire":1,
            "untrusted_set_sender":1,
            "smtp_accept_queue_per_connection":1,
            "smtp_enforce_sync":1,
            "perl_startup":1,
            "queue_run_in_order":1,
            "daemon_smtp_ports":1,
            "errors_copy":1,
            "recipient_unqualified_hosts":1,
            "bounce_return_body":1,
            "av_scanner":1,
            "acl_smtp_vrfy":1,
            "sender_unqualified_hosts":1,
            "add_environment":1,
            "accept_8bitmime":1,
            "ignore_fromline_local":1,
            "dsn_advertise_hosts":1,
            "syslog_facility":1,
            "dns_dnssec_ok":1,
            "acl_smtp_rcpt":1,
            "tls_privatekey":1,
            "srs_maxage":1,
            "hosts_connection_nolog":1,
            "smtp_ratelimit_mail":1,
            "allow_domain_literals":1,
            "smtp_etrn_command":1,
            "acl_smtp_etrn":1,
            "acl_smtp_data":1,
            "tls_try_verify_hosts":1,
            "syslog_timestamp":1,
            "srs_usehash":1,
            "primary_hostname":1,
            "qualify_domain":1,
            "acl_smtp_mime":1,
            "strict_acl_vars":1,
            "system_filter_directory_transport":1,
            "headers_charset":1,
            "tls_certificate":1,
            "system_filter":1,
            "lookup_open_max":1,
            "check_spool_inodes":1,
            "check_spool_space":1,
            "bounce_message_text":1,
            "rfc1413_hosts":1,
            "smtp_accept_reserve":1,
            "extract_addresses_remove_arguments":1,
            "dns_trust_aa":1,
            "daemon_startup_retries":1,
            "callout_domain_negative_expire":1,
            "tls_crl":1,
            "bounce_return_linesize_limit":1,
            "freeze_tell":1,
            "auto_thaw":1,
            "smtp_reserve_hosts":1,
            "percent_hack_domains":1,
            "gecos_name":1,
            "acl_smtp_connect":1,
            "never_users":1,
            "received_headers_max":1,
            "tls_ocsp_file":1,
            "acl_smtp_auth":1,
            "smtp_accept_max_nonmail":1,
            "bounce_message_file":1,
            "spool_directory":1,
            "tls_remember_esmtp":1,
            "trusted_users":1,
            "finduser_retries":1,
            "smtp_accept_queue":1,
            "dns_ipv4_lookup":1,
            "keep_malformed":1,
            "acl_smtp_quit":1,
            "local_scan_timeout":1,
            "tcp_nodelay":1,
            "extra_local_interfaces":1,
            "uucp_from_sender":1,
            "acl_smtp_predata":1,
            "exim_user":1,
            "remote_max_parallel":1,
            "sqlite_lock_timeout":1,
            "receive_timeout":1,
            "acl_smtp_mail":1,
            "queue_only":1,
            "dsn_from":1,
            "srs_secrets":1,
            "smtp_accept_max":1,
            "delay_warning":1,
            "host_lookup":1,
            "delivery_date_remove":1,
            "smtp_accept_max_nonmail_hosts":1,
            "tls_dhparam":1,
            "smtp_active_hostname":1,
            "allow_utf8_domains":1,
            "dns_again_means_nonexist":1,
            "local_interfaces":1,
            "tls_dh_max_bits":1,
            "system_filter_user":1,
            "strip_trailing_dot":1,
            "host_reject_connection":1,
            "recipients_max_reject":1,
            "srs_usetimestamp":1,
            "gnutls_require_mac":1,
            "helo_allow_chars":1,
            "tls_verify_certificates":1,
            "helo_lookup_domains":1,
            "drop_cr":1,
            "header_maxsize":1,
            "queue_only_file":1,
            "dns_retrans":1,
            "gecos_pattern":1,
            "qualify_recipient":1,
            "spamd_address":1,
            "smtp_check_spool_space":1,
            "gnutls_require_protocols":1,
            "deliver_queue_load_max":1,
            "rfc1413_query_timeout":1,
            "queue_run_max":1,
            "syslog_duplication":1,
            "gnutls_require_kx":1,
            "errors_reply_to":1,
            "host_lookup_order":1,
            "deliver_drop_privilege":1,
            "smtp_return_error_details":1,
            "localhost_number":1,
            "timezone":1,
            "acl_smtp_notquit":1,
            "srs_hashmin":1,
            "openssl_options":1,
            "callout_random_local_part":1,
            "smtp_ratelimit_hosts":1,
            "remote_sort_domains":1,
            "hold_domains":1,
            "tls_eccurve":1,
            "acl_not_smtp_mime":1,
            "slow_lookup_log":1,
            "exim_path":1,
            "retry_data_expire":1,
            "local_from_suffix":1,
            "envelope_to_remove":1,
            "message_body_newlines":1,
            "smtp_banner":1
         },
         "srs":0
      }
   },
   "metadata":{  
      "version":1,
      "command":"validate_exim_configuration_syntax",
      "result":1,
      "reason":"OK",
      "output":{  
         "raw":"\n"
      }
   }
}
 Output (XML)
<result>
    <data>
        <exim_caps>
            <boxtrapper>1</boxtrapper>
            <spf>1</spf>
            <force_command>1</force_command>
            <domainkeys>0</domainkeys>
            <archive>1</archive>
            <maildir>1</maildir>
            <content_scanning>1</content_scanning>
            <srs>0</srs>
            <rewrite_from_remote>0</rewrite_from_remote>
            <passwd>1</passwd>
            <rewrite_from_all>0</rewrite_from_all>
            <mailman>1</mailman>
            <exiscan>1</exiscan>
            <notquit>1</notquit>
            <directives>
                <freeze_tell>1</freeze_tell>
                <keep_environment>1</keep_environment>
                <accept_8bitmime>1</accept_8bitmime>
                <qualify_recipient>1</qualify_recipient>
                <retry_data_expire>1</retry_data_expire>
                <system_filter_group>1</system_filter_group>
                <unknown_username>1</unknown_username>
                <srs_secrets>1</srs_secrets>
                <helo_try_verify_hosts>1</helo_try_verify_hosts>
                <tls_dh_max_bits>1</tls_dh_max_bits>
                <host_lookup>1</host_lookup>
                <ignore_fromline_hosts>1</ignore_fromline_hosts>
                <hosts_connection_nolog>1</hosts_connection_nolog>
                <envelope_to_remove>1</envelope_to_remove>
                <extract_addresses_remove_arguments>1</extract_addresses_remove_arguments>
                <split_spool_directory>1</split_spool_directory>
                <callout_positive_expire>1</callout_positive_expire>
                <acl_smtp_data_prdr>1</acl_smtp_data_prdr>
                <helo_allow_chars>1</helo_allow_chars>
                <queue_only_load_latch>1</queue_only_load_latch>
                <primary_hostname>1</primary_hostname>
                <helo_lookup_domains>1</helo_lookup_domains>
                <acl_smtp_quit>1</acl_smtp_quit>
                <rfc1413_hosts>1</rfc1413_hosts>
                <pid_file_path>1</pid_file_path>
                <message_body_visible>1</message_body_visible>
                <acl_smtp_predata>1</acl_smtp_predata>
                <tls_verify_certificates>1</tls_verify_certificates>
                <remote_max_parallel>1</remote_max_parallel>
                <auth_advertise_hosts>1</auth_advertise_hosts>
                <check_spool_inodes>1</check_spool_inodes>
                <check_spool_space>1</check_spool_space>
                <bi_command>1</bi_command>
                <rfc1413_query_timeout>1</rfc1413_query_timeout>
                <syslog_processname>1</syslog_processname>
                <dns_dnssec_ok>1</dns_dnssec_ok>
                <smtp_accept_max_nonmail>1</smtp_accept_max_nonmail>
                <openssl_options>1</openssl_options>
                <smtp_connect_backlog>1</smtp_connect_backlog>
                <syslog_timestamp>1</syslog_timestamp>
                <spool_directory>1</spool_directory>
                <local_sender_retain>1</local_sender_retain>
                <recipients_max>1</recipients_max>
                <smtp_active_hostname>1</smtp_active_hostname>
                <bounce_return_linesize_limit>1</bounce_return_linesize_limit>
                <srs_usetimestamp>1</srs_usetimestamp>
                <smtp_reserve_hosts>1</smtp_reserve_hosts>
                <tls_on_connect_ports>1</tls_on_connect_ports>
                <sqlite_lock_timeout>1</sqlite_lock_timeout>
                <gnutls_compat_mode>1</gnutls_compat_mode>
                <acl_smtp_connect>1</acl_smtp_connect>
                <acl_not_smtp>1</acl_not_smtp>
                <queue_run_in_order>1</queue_run_in_order>
                <srs_usehash>1</srs_usehash>
                <return_path_remove>1</return_path_remove>
                <queue_only>1</queue_only>
                <dns_ipv4_lookup>1</dns_ipv4_lookup>
                <tls_require_ciphers>1</tls_require_ciphers>
                <acl_smtp_auth>1</acl_smtp_auth>
                <prod_requires_admin>1</prod_requires_admin>
                <callout_negative_expire>1</callout_negative_expire>
                <queue_domains>1</queue_domains>
                <recipients_max_reject>1</recipients_max_reject>
                <tls_dhparam>1</tls_dhparam>
                <percent_hack_domains>1</percent_hack_domains>
                <dns_csa_search_limit>1</dns_csa_search_limit>
                <add_environment>1</add_environment>
                <admin_groups>1</admin_groups>
                <message_id_header_domain>1</message_id_header_domain>
                <message_id_header_text>1</message_id_header_text>
                <smtp_enforce_sync>1</smtp_enforce_sync>
                <dns_again_means_nonexist>1</dns_again_means_nonexist>
                <log_file_path>1</log_file_path>
                <gnutls_require_kx>1</gnutls_require_kx>
                <acl_smtp_etrn>1</acl_smtp_etrn>
                <extra_local_interfaces>1</extra_local_interfaces>
                <syslog_facility>1</syslog_facility>
                <acl_smtp_data>1</acl_smtp_data>
                <timezone>1</timezone>
                <acl_smtp_starttls>1</acl_smtp_starttls>
                <check_log_inodes>1</check_log_inodes>
                <delay_warning_condition>1</delay_warning_condition>
                <sender_unqualified_hosts>1</sender_unqualified_hosts>
                <allow_utf8_domains>1</allow_utf8_domains>
                <never_users>1</never_users>
                <tls_remember_esmtp>1</tls_remember_esmtp>
                <errors_copy>1</errors_copy>
                <gnutls_require_protocols>1</gnutls_require_protocols>
                <bounce_message_file>1</bounce_message_file>
                <acl_smtp_mailauth>1</acl_smtp_mailauth>
                <process_log_path>1</process_log_path>
                <queue_list_requires_admin>1</queue_list_requires_admin>
                <acl_smtp_mime>1</acl_smtp_mime>
                <prdr_enable>1</prdr_enable>
                <local_from_prefix>1</local_from_prefix>
                <slow_lookup_log>1</slow_lookup_log>
                <drop_cr>1</drop_cr>
                <tls_certificate>1</tls_certificate>
                <queue_only_file>1</queue_only_file>
                <hosts_treat_as_local>1</hosts_treat_as_local>
                <spf_guess>1</spf_guess>
                <remote_sort_domains>1</remote_sort_domains>
                <uucp_from_sender>1</uucp_from_sender>
                <spamd_address>1</spamd_address>
                <dkim_verify_signers>1</dkim_verify_signers>
                <smtp_accept_max_per_host>1</smtp_accept_max_per_host>
                <disable_ipv6>1</disable_ipv6>
                <syslog_duplication>1</syslog_duplication>
                <smtp_accept_reserve>1</smtp_accept_reserve>
                <smtp_accept_keepalive>1</smtp_accept_keepalive>
                <bounce_return_message>1</bounce_return_message>
                <gnutls_allow_auto_pkcs11>1</gnutls_allow_auto_pkcs11>
                <queue_only_override>1</queue_only_override>
                <localhost_number>1</localhost_number>
                <acl_smtp_notquit>1</acl_smtp_notquit>
                <ignore_fromline_local>1</ignore_fromline_local>
                <print_topbitchars>1</print_topbitchars>
                <delay_warning>1</delay_warning>
                <timeout_frozen_after>1</timeout_frozen_after>
                <daemon_smtp_ports>1</daemon_smtp_ports>
                <srs_hashmin>1</srs_hashmin>
                <log_selector>1</log_selector>
                <mua_wrapper>1</mua_wrapper>
                <smtp_etrn_serialize>1</smtp_etrn_serialize>
                <perl_at_start>1</perl_at_start>
                <dsn_from>1</dsn_from>
                <dns_csa_use_reverse>1</dns_csa_use_reverse>
                <daemon_startup_sleep>1</daemon_startup_sleep>
                <tls_try_verify_hosts>1</tls_try_verify_hosts>
                <check_rfc2047_length>1</check_rfc2047_length>
                <smtp_accept_max>1</smtp_accept_max>
                <srs_hashlength>1</srs_hashlength>
                <srs_config>1</srs_config>
                <trusted_users>1</trusted_users>
                <trusted_groups>1</trusted_groups>
                <gnutls_require_mac>1</gnutls_require_mac>
                <system_filter>1</system_filter>
                <smtp_load_reserve>1</smtp_load_reserve>
                <smtp_ratelimit_hosts>1</smtp_ratelimit_hosts>
                <acl_smtp_mail>1</acl_smtp_mail>
                <finduser_retries>1</finduser_retries>
                <dns_check_names_pattern>1</dns_check_names_pattern>
                <allow_domain_literals>1</allow_domain_literals>
                <acl_smtp_dkim>1</acl_smtp_dkim>
                <smtp_accept_queue>1</smtp_accept_queue>
                <smtp_max_unknown_commands>1</smtp_max_unknown_commands>
                <system_filter_file_transport>1</system_filter_file_transport>
                <smtp_ratelimit_mail>1</smtp_ratelimit_mail>
                <dns_trust_aa>1</dns_trust_aa>
                <acl_not_smtp_mime>1</acl_not_smtp_mime>
                <local_from_suffix>1</local_from_suffix>
                <delivery_date_remove>1</delivery_date_remove>
                <srs_maxage>1</srs_maxage>
                <callout_random_local_part>1</callout_random_local_part>
                <local_interfaces>1</local_interfaces>
                <message_logs>1</message_logs>
                <av_scanner>1</av_scanner>
                <recipient_unqualified_hosts>1</recipient_unqualified_hosts>
                <header_line_maxsize>1</header_line_maxsize>
                <tls_crl>1</tls_crl>
                <lookup_open_max>1</lookup_open_max>
                <acl_smtp_rcpt>1</acl_smtp_rcpt>
                <receive_timeout>1</receive_timeout>
                <preserve_message_logs>1</preserve_message_logs>
                <deliver_drop_privilege>1</deliver_drop_privilege>
                <acl_smtp_vrfy>1</acl_smtp_vrfy>
                <callout_domain_negative_expire>1</callout_domain_negative_expire>
                <errors_reply_to>1</errors_reply_to>
                <write_rejectlog>1</write_rejectlog>
                <bounce_message_text>1</bounce_message_text>
                <system_filter_reply_transport>1</system_filter_reply_transport>
                <qualify_domain>1</qualify_domain>
                <headers_charset>1</headers_charset>
                <dns_retry>1</dns_retry>
                <hold_domains>1</hold_domains>
                <host_lookup_order>1</host_lookup_order>
                <gecos_name>1</gecos_name>
                <local_scan_timeout>1</local_scan_timeout>
                <system_filter_directory_transport>1</system_filter_directory_transport>
                <allow_mx_to_ip>1</allow_mx_to_ip>
                <smtp_ratelimit_rcpt>1</smtp_ratelimit_rcpt>
                <message_body_newlines>1</message_body_newlines>
                <smtp_accept_max_nonmail_hosts>1</smtp_accept_max_nonmail_hosts>
                <max_username_length>1</max_username_length>
                <received_headers_max>1</received_headers_max>
                <header_maxsize>1</header_maxsize>
                <retry_interval_max>1</retry_interval_max>
                <system_filter_user>1</system_filter_user>
                <perl_startup>1</perl_startup>
                <helo_accept_junk_hosts>1</helo_accept_junk_hosts>
                <check_log_space>1</check_log_space>
                <tls_advertise_hosts>1</tls_advertise_hosts>
                <system_filter_pipe_transport>1</system_filter_pipe_transport>
                <acl_smtp_helo>1</acl_smtp_helo>
                <smtp_max_synprot_errors>1</smtp_max_synprot_errors>
                <queue_run_max>1</queue_run_max>
                <tls_verify_hosts>1</tls_verify_hosts>
                <helo_verify_hosts>1</helo_verify_hosts>
                <exim_path>1</exim_path>
                <bounce_return_size_limit>1</bounce_return_size_limit>
                <bounce_return_body>1</bounce_return_body>
                <smtp_banner>1</smtp_banner>
                <deliver_queue_load_max>1</deliver_queue_load_max>
                <exim_user>1</exim_user>
                <tls_privatekey>1</tls_privatekey>
                <auto_thaw>1</auto_thaw>
                <event_action>1</event_action>
                <untrusted_set_sender>1</untrusted_set_sender>
                <ignore_bounce_errors_after>1</ignore_bounce_errors_after>
                <smtp_accept_queue_per_connection>1</smtp_accept_queue_per_connection>
                <strip_trailing_dot>1</strip_trailing_dot>
                <tls_ocsp_file>1</tls_ocsp_file>
                <received_header_text>1</received_header_text>
                <smtp_return_error_details>1</smtp_return_error_details>
                <local_from_check>1</local_from_check>
                <tls_eccurve>1</tls_eccurve>
                <strict_acl_vars>1</strict_acl_vars>
                <pipelining_advertise_hosts>1</pipelining_advertise_hosts>
                <dns_use_edns0>1</dns_use_edns0>
                <uucp_from_pattern>1</uucp_from_pattern>
                <daemon_startup_retries>1</daemon_startup_retries>
                <message_size_limit>1</message_size_limit>
                <keep_malformed>1</keep_malformed>
                <dsn_advertise_hosts>1</dsn_advertise_hosts>
                <acl_not_smtp_start>1</acl_not_smtp_start>
                <bounce_sender_authentication>1</bounce_sender_authentication>
                <queue_only_load>1</queue_only_load>
                <tcp_nodelay>1</tcp_nodelay>
                <host_reject_connection>1</host_reject_connection>
                <dns_retrans>1</dns_retrans>
                <callout_domain_positive_expire>1</callout_domain_positive_expire>
                <strip_excess_angle_brackets>1</strip_excess_angle_brackets>
                <log_timezone>1</log_timezone>
                <gecos_pattern>1</gecos_pattern>
                <smtp_etrn_command>1</smtp_etrn_command>
                <exim_group>1</exim_group>
                <unknown_login>1</unknown_login>
                <warn_message_file>1</warn_message_file>
                <queue_smtp_domains>1</queue_smtp_domains>
                <smtp_check_spool_space>1</smtp_check_spool_space>
                <smtp_accept_max_per_connection>1</smtp_accept_max_per_connection>
                <acl_smtp_expn>1</acl_smtp_expn>
            </directives>
            <no_forward_outbound_spam_over_int>0</no_forward_outbound_spam_over_int>
            <dovecot>1</dovecot>
            <add_header>1</add_header>
            <dkim>1</dkim>
            <no_forward_outbound_spam>1</no_forward_outbound_spam>
        </exim_caps>
    </data>
    <metadata>
        <output>
            <raw/>
        </output>
        <result>1</result>
        <version>1</version>
        <command>validate_exim_configuration_syntax</command>
        <reason>OK</reason>
    </metadata>
</result>


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
cfg_text
string

The Exim configuration file's raw text.

Note:

If you do not use this parameter, the function will analyze Exim's current configuration.

An Exim configuration file.
 Click to view...
#!!# cPanel Exim 4 Config
hostlist loopback = <; 127.0.0.0/8 ; 0.0.0.0 ; ::1 ; 0000:0000:0000:0000:0000:ffff:7f00:0000/8
hostlist senderverifybypass_hosts = net-iplsearch;/etc/senderverifybypasshosts
hostlist skipsmtpcheck_hosts = net-iplsearch;/etc/skipsmtpcheckhosts
hostlist spammeripblocks = net-iplsearch;/etc/spammeripblocks
hostlist backupmx_hosts = lsearch;/etc/backupmxhosts
hostlist trustedmailhosts = lsearch;/etc/trustedmailhosts
hostlist relay_hosts = net-iplsearch;/etc/relayhosts
domainlist user_domains = ${if exists{/etc/userdomains} {lsearch;/etc/userdomains} fail}
smtp_accept_queue_per_connection = 30
remote_max_parallel = 10
smtp_receive_timeout = 165s
ignore_bounce_errors_after = 1d
rfc1413_query_timeout = 0s
timeout_frozen_after = 5d
auto_thaw = 7d
callout_domain_negative_expire = 1h
callout_negative_expire = 1h
acl_not_smtp = acl_not_smtp
acl_smtp_connect = acl_smtp_connect
acl_smtp_data = acl_smtp_data
acl_smtp_mail = acl_smtp_mail
acl_smtp_quit = acl_smtp_quit
acl_smtp_notquit = acl_smtp_notquit
acl_smtp_rcpt = acl_smtp_rcpt
message_body_newlines = true
perl_at_start = true
deliver_queue_load_max = 36
queue_only_load = 72
daemon_smtp_ports = 25 : 465 : 587
tls_on_connect_ports = 465
system_filter_user = cpaneleximfilter
system_filter_group = cpaneleximfilter
tls_require_ciphers = ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:-LOW:-SSLv2:-EXP
spamd_address = 127.0.0.1 783
# +incoming_port, +smtp_connection are needed for cPanel email tracking.
# -retry_defer, +subject, +arguments, +received_recipients are suggested settings that may be disabled.
log_selector = +incoming_port +smtp_connection -retry_defer +subject +arguments +received_recipients
system_filter = /etc/cpanel_exim_system_filter
 
#!!# These options specify the Access Control Lists (ACLs) that
#!!# are used for incoming SMTP messages - after the RCPT and DATA
#!!# commands, respectively.
 
#!!# This setting defines a named domain list called
#!!# local_domains, created from the old options that
#!!# referred to local domains. It will be referenced
#!!# later on by the syntax "+local_domains".
#!!# Other domain and host lists may follow.
 
domainlist local_domains = lsearch;/etc/locDOComains
domainlist outside_jail_domains = lsearch;/etc/outside_jail_domains
 
domainlist relay_domains = lsearch;/etc/locDOComains : \
     lsearch;/etc/secondarymx
hostlist auth_relay_hosts = *
 
######################################################################
#                  Runtime configuration file for Exim               #
######################################################################
 
# This is a default configuration file which will operate correctly in
# uncomplicated installations. Please see the manual for a complete list
# of all the runtime configuration options that can be included in a
# configuration file. There are many more than are mentioned here. The
# manual is in the file doc/spec.txt in the Exim distribution as a plain
# ASCII file. Other formats (PostScript, Texinfo, HTML) are available from
# the Exim ftp sites. The manual is also online via the Exim web sites.
 
 
# This file is divided into several parts, all but the last of which are
# terminated by a line containing the word "end". The parts must appear
# in the correct order, and all must be present (even if some of them are
# in fact empty). Blank lines, and lines starting with # are ignored.
 
######################################################################
#                    MAIN CONFIGURATION SETTINGS                     #
######################################################################
 
perl_startup = do '/etc/exim.pl'
.....
sectionstring

The Exim configuration file's section to check.

Note:

If you use this parameter, pass only the desired section to validate as the cfg_text value.

A valid Exim configuration file section.

acl


Returns

ReturnTypeDescriptionPossible valuesExample
exim_capshash

A hash of the Exim configuration file results.

Note:

The function only returns this hash and its contents for valid configurations. 

This hash includes the exiscan, notquit, add_header, boxtrapper, couriermaildirrewrite_from_all, mailman, spf, dovecot, rewrite_from_remote, srs, no_forward_outbound_spam_over_int, dkim, no_forward_outbound_spam, content_scanning, force_command, archive, passwd, and domainkeys returns and the directives hash.

 

exiscan

Boolean

Whether the server contains exiscan, which scans messages from authenticated senders for malware.

The function returns this value in the exim_caps hash.

  • 1 — Contains exiscan.
  • 0 — Does not contain exiscan.
0

notquit

Boolean

Whether the server supports the acl_smtp_notquit ACL, which runs when an SMTP session ends without a QUIT.

The function returns this value in the exim_caps hash.

  • 1 — Supports.
  • 0 — Does not support.
1

add_header

Boolean

Whether the server supports the add_header directive.

The function returns this value in the exim_caps hash.

  • 1 — Supports.
  • 0 — Does not support.

 

1

boxtrapper

Boolean

Whether the server supports BoxTrapper functionality.

The function returns this value in the exim_caps hash.

  • 1 — Supports.
  • 0 — Does not support.

 

1

courier

Boolean

Whether the server supports Courier.

Warning:

We removed the Courier mail server in cPanel & WHM version 54. The Courier mail server only exists for cPanel & WHM version 11.52 and earlier.

The function returns this value in the exim_caps hash.

  • 1 — Supports.
  • 0 — Does not support.

 

1

maildir

Boolean

Whether the server supports the Maildir format.

The function returns this value in the exim_caps hash.

  • 1 — Supports.
  • 0 — Does not support.

 

1

rewrite_from_all

Boolean

Whether the server supports the rewrite function on all incoming mail.

The function returns this value in the exim_caps hash.

  • 1 — Supports.
  • 0 — Does not support.

 

0

mailman

Boolean

Whether the server supports the Mailman feature.

The function returns this value in the exim_caps hash.

  • 1 — Supports.
  • 0 — Does not support.
0

spf

Boolean

Whether the server supports SPF checks.

The function returns this value in the exim_caps hash.

  • 1 — Supports.
  • 0 — Does not support.

 

1

srs

Boolean

Whether the server supports the Sender Rewriting Scheme (SRS).

The function returns this value in the  exim_caps hash.

  • 1 — Supports.
  • 0 — Does not support.
1

dkim

Boolean

Whether the server supports DomainKeys Identified Mail (DKIM).

The function returns this value in the  exim_caps hash.

  • 1 — Supports.
  • 0 — Does not support.
1

no_forward_outbound_spam

Boolean

Whether the server will refuse to forward outbound spam if it matches the Apache SpamAssassin internal spam_score setting.

The function returns this value in the  exim_caps hash.

  • 1 — Server refuses to forward.
  • 0 — Server allows.
1

no_forward_outbound_spam_over_int

Boolean

Whether the server will refuse to forward outbound spam if it matches a defined Apache SpamAssassin score.

The function returns this value in the exim_caps hash.

  • 1 — Server refuses to forward.
  • 0 — Server allows.
1

dovecot

Boolean

Whether the server supports Dovecot authentication.

The function returns this value in the exim_caps hash.

  • 1 — Supports.
  • 0 — Does not support.

 

1

rewrite_from_remote

Boolean

Whether the server can rewrite the outgoing From: header to the actual sender.

The function returns this value in the exim_caps hash.

  • 1 — Can rewrite.
  • 0Cannot rewrite.
1

content_scanning

Boolean

Whether the server supports content scanning functionality.

The function returns this value in the exim_caps hash.

  • 1 — Supports.
  • 0 — Does not support.

 

1

force_command

Boolean

Whether the server supports the force_command directive for pipe transports.

The function returns this value in the exim_caps hash.

  • 1 — Supports.
  • 0 — Does not support.

 

1

archive

Boolean

Whether the server supports system-wide archives.

The function returns this value in the exim_caps hash.

  • 1 — Supports.
  • 0 — Does not support.

 

1

passwd

Boolean

Whether the server supports password authentication.

The function returns this value in the exim_caps hash.

  • 1 — Supports.
  • 0 — Does not support.

 

1

domainkeys

Boolean

Whether the server supports Domain Keys.

The function returns this value in the exim_caps hash.

  • 1 — Supports.
  • 0 — Does not support.

 

0

directives

hash

A hash of individual Exim directives.

The function returns this hash in the  exim_caps hash.

This hash includes the directive name return. 

 directive name

Boolean

Whether the directive is active or inactive on the server.

Note:

The return's name is the directive's name.

The function returns this value in the  directives hash.

  • 1 — Active.
  • 0 — Inactive.
1

error_msg

string

Any error messages that the validation script encountered.

Note:

The function only returns this value for invalid configurations.

A valid string. This is an error message.

error_line

string

The first line in the Exim configuration file that contains an error.

Note:

The function only returns this value for invalid configurations.

A positive integer. 1

broken_cfg_html

string

The line with the broken configuration.

Note:

The function only returns this value for invalid configurations.

A valid string in HTML format. RAW_CONFIGURATION_TEXT\n

broken_cfg_text

string

The line that includes the broken configuration.

Note:

The function only returns this value for invalid configurations.

A valid string in text format.

==>RAW_CONFIGURATION_TEXT<==\n