---
title: "Validate Exim configure file syntax"
method: GET
path: "/validate_exim_configuration_syntax"
tags: ["Mail", "Mail Server Settings"]
---

# Validate Exim configure file syntax

`GET /validate_exim_configuration_syntax`

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](https://tools.ietf.org/html/rfc7208).
  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](https://bugzilla.redhat.com/show_bug.cgi?id=1215164).

## Query parameters

- `cfg_text` string, HTML
- `section` string

## Response `200`

HTTP Request was successful.

- object
  - `data` union — An object containing a valid or invalid Exim configuration information.
    - object — The function returns this object for an invalid Exim configuration.
      - `broken_cfg_html` string, HTML — The line with the broken configuration, in HTML format.
      - `broken_cfg_text` string, HTML — The line that includes the broken configuration.
      - `error_line` integer — The first line in the Exim configuration file that contains an error.
      - `error_msg` string — Any error messages that the validation script encountered.
    - object
      - `exim_caps` object — The function returns this object for a valid Exim configuration.
        - `add_header` 1 | 0 — Whether the server supports the `add_header` directive. * `1` — Supports. * `0` — Does **not** support.
        - `archive` 1 | 0 — Whether the server supports system-wide archives. * `1` — Supports. * `0` — Does **not** support.
        - `boxtrapper` 1 | 0 — Whether the server supports BoxTrapper functionality. * `1` — Supports. * `0` — Does **not** support.
        - `content_scanning` 1 | 0 — Whether the server supports content scanning functionality. * `1` — Supports. * `0` — Does **not** support.
        - `directives` object — A list of individual Exim directives.
        - `dkim` 1 | 0 — Whether the server supports DomainKeys Identified Mail (DKIM). * `1` — Supports. * `0` — Does **not** support.
        - `domainkeys` 1 | 0 — Whether the server supports DKIM. * `1` — Supports. * `0` — Does **not** support.
        - `dovecot` 1 | 0 — Whether the server supports Dovecot authentication. * `1` — Supports. * `0` — Does **not** support.
        - `exiscan` 1 | 0 — Whether the server contains exiscan, which scans messages from authenticated senders for malware. * `1` — Contains exiscan. * `0` — Does **not** contain exiscan.
        - `force_command` 1 | 0 — Whether the server supports the `force_command` directive for pipe transports. * `1` — Supports. * `0` — Does **not** support.
        - `maildir` 1 | 0 — Whether the server supports the Maildir format. * `1` — Supports. * `0` — Does **not** support.
        - `mailman` 1 | 0 — Whether the server supports the Mailman feature. * `1` — Supports. * `0` — Does **not** support.
        - `no_forward_outbound_spam` 1 | 0 — Whether the server will refuse to forward outbound spam if it matches the Apache SpamAssassin™ internal `spam_score` setting. * `1` — Server refuses to forward. * `0` — Server allows.
        - `no_forward_outbound_spam_over_int` 1 | 0 — Whether the server will refuse to forward outbound spam if it matches a defined Apache SpamAssassin score. * `1` — Server refuses to forward. * `0` — Server allows.
        - `notquit` 1 | 0 — Whether the server supports the `acl_smtp_notquit` ACL, which runs when an SMTP session ends without a `QUIT`. * `1` — Supports. * `0` — Does **not** support.
        - `passwd` 1 | 0 — Whether the server supports password authentication. * `1` — Supports. * `0` — Does **not** support.
        - `rewrite_from_all` 1 | 0 — Whether the server supports the rewrite function on all incoming mail. * `1` — Supports. * `0` — Does **not** support.
        - `rewrite_from_remote` 1 | 0 — Whether the server can rewrite the outgoing `From:` header to the actual sender. * `1` — Can rewrite. * `0` — **Cannot** rewrite.
        - `spf` 1 | 0 — Whether the server supports SPF checks. * `1` — Supports. * `0` — Does **not** support.
        - `srs` 1 | 0 — Whether the server supports the Sender Rewriting Scheme (SRS). * `1` — Supports. * `0` — Does **not** support.
  - `metadata` object
    - `command` string — The method name called.
    - `output` string, HTML — The function's raw HTML output, if any exists.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 1 | 0 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)