Software Development Kit

cPanel & WHM's API [+] cPanel & WHM's API [-]


Modules and Plugins [+] Modules and Plugins [-]


cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]


cPAddons (Site Software) [+] cPAddons (Site Software) [-]


System Administration [+] System Administration [-]


Developer Software [+] Developer Software [-]


Back to All Documentation

Validate the Current Exim Configuration — validate_current_installed_exim_config

This function validates the system's current Exim configuration.

note Note: This function only validates configuration files used by cPanel users to build exim.conf. It does not validate the actual exim.conf configuration file.

Calling Functions

Using the XML API

To use the XML API to perform the validate_current_installed_exim_config function from within your custom script:

  • Append the /xml-api/validate_current_installed_exim_config function call name, plus the required variables (see below), to a URL which includes the address of your server.

  • For example, on a server whose hostname is example.com, you would include the following string in your script: https://example.com:2087/xml-api/validate_current_installed_exim_config

  • You need to be logged in with the proper permissions in order to call a function. See our document about Authenticating API Function Calls for more information about authenticating APIs from within a script.

  • You can also perform the function by entering the string in your web browser's address bar. This may be useful for testing the function call and viewing its output.

Using the JSON API

To use the JSON API to perform the validate_current_installed_exim_config function from within your custom script:

  • Append the /json-api/validate_current_installed_exim_config function call name, plus the required variables (see below), to a URL which includes the address of your server.

  • For example, on a server whose hostname is example.com, you would include the following string in your script: https://example.com:2087/json-api/validate_current_installed_exim_config

  • You need to be logged in with the proper permissions in order to call a function. See our document about Authenticating API Function Calls for more information about authenticating APIs from within a script.

  • You can also perform the function by entering the string in your web browser's address bar. This may be useful for testing the function call and viewing its output.

Variables

Input

None

Output

  • validate_current_installed_exim_config — The function's results container.
    • html (string) — An HTML-formatted list of Exim's configuration parameters.
    • status (boolean) — A boolean value that indicates success or failure. A value of 1 indicates success.
    • statusmsg (string) — A message of success or reason for failure.

Examples

XML API

Calling the URL https://example.com:2087/xml-api/validate_current_installed_exim_config in WebHost Manager will produce output similar to:

<validate_current_installed_exim_config>
	<html>
		<pre>Doing Dry Run Dry Run ok Enabled system filter options: attachments|fail_spam_score_over_int|spam_rewrite Enabled ACL options in block ACL_MAIL_PRE_BLOCK: default_mail_pre Enabled ACL options in block ACL_RBL_BLOCK: primary_hostname_bl Enabled ACL options in block ACL_RECIPIENT_POST_BLOCK: default_recipient_post Enabled ACL options in block ACL_SPAM_SCAN_CHECK_BLOCK: default_spam_scan_check Enabled ACL options in block ACL_CHECK_MESSAGE_PRE_BLOCK: default_check_message_pre Enabled ACL options in block ACL_CONNECT_POST_BLOCK: default_connect_post Enabled ACL options in block ACL_CONNECT_BLOCK: ratelimit|spammerlist Enabled ACL options in block ACL_POST_RECP_VERIFY_BLOCK: dictionary_attack Enabled ACL options in block ACL_IDENTIFY_SENDER_BLOCK: default_identify_sender Enabled ACL options in block ACL_MAIL_BLOCK: requirehelo|requirehelonoforge|requirehelosyntax Enabled ACL options in block ACL_RATELIMIT_SPAM_BLOCK: ratelimit_spam_score_over_int Enabled ACL options in block ACL_CHECK_MESSAGE_POST_BLOCK: default_check_message_post Enabled ACL options in block ACL_POST_SPAM_SCAN_CHECK_BLOCK: mailproviders Enabled ACL options in block ACL_SPAM_SCAN_BLOCK: default_spam_scan Enabled ACL options in block ACL_RATELIMIT_BLOCK: 0tracksenders Enabled ACL options in block ACL_NOTQUIT_BLOCK: ratelimit Enabled ACL options in block ACL_RECP_VERIFY_BLOCK: default_recp_verify Enabled ACL options in block ACL_PRE_SPAM_SCAN: mailproviders Enabled ACL options in block ACL_SPAM_BLOCK: deny_spam_score_over_int Enabled ACL options in block ACL_EXISCAN_BLOCK: default_exiscan Enabled ACL options in block ACL_RECIPIENT_BLOCK: default_recipient Enabled ACL options in block ACL_MAIL_POST_BLOCK: default_mail_post Detected spam handling in acls, disabling spamassassin in routers & transports!. SpamAssassin method remains unchanged Configured options list is: ACL: acl_smtp_connect is active ACL: acl_smtp_data is active ACL: acl_smtp_mail is active ACL: acl_smtp_notquit is active ACL: acl_smtp_rcpt is active Provided options list is: daemon_smtp_ports|tls_on_connect_ports|system_filter_user|system_filter_group|tls_require_ciphers|hostlist loopback|hostlist senderverifybypass_hosts|hostlist skipsmtpcheck_hosts|hostlist spammeripblocks|hostlist backupmx_hosts|hostlist trustedmailhosts|hostlist relay_hosts|domainlist user_domains|remote_max_parallel|smtp_receive_timeout|ignore_bounce_errors_after|rfc1413_query_timeout|timeout_frozen_after|auto_thaw|callout_domain_negative_expire|callout_negative_expire|acl_smtp_connect|acl_smtp_data|acl_smtp_mail|acl_smtp_notquit|acl_smtp_rcpt|perl_at_start|daemon_smtp_ports|tls_on_connect_ports|system_filter_user|system_filter_group|tls_require_ciphers|spamd_address Exim Insert Regex is: virtual_userdelivery|virtual_aliases|lookuphost|virtual_user|address_pipe|virtual_sa_user|localuser Exim Replace Regex is: virtual_sa_user|sa_localuser|virtual_sa_userdelivery|local_sa_delivery|central_filter|central_user_filter|democheck|fail_remote_domains|fixed_login|fixed_plain|has_alias_but_no_mailbox_discarded_to_prevent_loop|literal|local_delivery|local_delivery_spam|localuser|localuser_spam|lookuphost|remote_smtp|secure_login|secure_plain|userforward|virtual_aliases|virtual_aliases_nostar|virtual_user|virtual_user_spam|virtual_userdelivery|virtual_userdelivery_spam Exim Match Insert Regex is: quota_directory|maildir_format Exim version 4.76 #1 built 16-Aug-2011 11:41:07 Copyright (c) University of Cambridge, 1995 - 2007 Berkeley DB: Sleepycat Software: Berkeley DB 4.3.29: (July 12, 2010) Support for: crypteq iconv() IPv6 PAM Perl OpenSSL Content_Scanning DKIM Old_Demime Experimental_SPF Experimental_SRS Lookups (built-in): lsearch wildlsearch nwildlsearch iplsearch dbm dbmnz passwd Authenticators: cram_md5 dovecot plaintext spa Routers: accept dnslookup ipliteral manualroute queryprogram redirect Transports: appendfile/maildir autoreply pipe smtp Size of off_t: 8 </pre>
	</html>
	<status>1</status>
	<statusmsg>Your configuration is currently valid.</statusmsg>
</validate_current_installed_exim_config>



JSON API

Calling the URL https://example.com:2087/json-api/validate_current_installed_exim_config in WebHost Manager will produce output similar to:

{
   "status":1,
   "statusmsg":"Your configuration is currently valid.",
   "html":"<pre>Doing Dry Run\nDry Run ok\nEnabled system filter options: attachments|fail_spam_score_over_int|spam_rewrite\nEnabled ACL options in block ACL_MAIL_PRE_BLOCK: default_mail_pre\nEnabled ACL options in block ACL_RBL_BLOCK: primary_hostname_bl\nEnabled ACL options in block ACL_RECIPIENT_POST_BLOCK: default_recipient_post\nEnabled ACL options in block ACL_SPAM_SCAN_CHECK_BLOCK: default_spam_scan_check\nEnabled ACL options in block ACL_CHECK_MESSAGE_PRE_BLOCK: default_check_message_pre\nEnabled ACL options in block ACL_CONNECT_POST_BLOCK: default_connect_post\nEnabled ACL options in block ACL_CONNECT_BLOCK: ratelimit|spammerlist\nEnabled ACL options in block ACL_POST_RECP_VERIFY_BLOCK: dictionary_attack\nEnabled ACL options in block ACL_IDENTIFY_SENDER_BLOCK: default_identify_sender\nEnabled ACL options in block ACL_MAIL_BLOCK: requirehelo|requirehelonoforge|requirehelosyntax\nEnabled ACL options in block ACL_RATELIMIT_SPAM_BLOCK: ratelimit_spam_score_over_int\nEnabled ACL options in block ACL_CHECK_MESSAGE_POST_BLOCK: default_check_message_post\nEnabled ACL options in block ACL_POST_SPAM_SCAN_CHECK_BLOCK: mailproviders\nEnabled ACL options in block ACL_SPAM_SCAN_BLOCK: default_spam_scan\nEnabled ACL options in block ACL_RATELIMIT_BLOCK: 0tracksenders\nEnabled ACL options in block ACL_NOTQUIT_BLOCK: ratelimit\nEnabled ACL options in block ACL_RECP_VERIFY_BLOCK: default_recp_verify\nEnabled ACL options in block ACL_PRE_SPAM_SCAN: mailproviders\nEnabled ACL options in block ACL_SPAM_BLOCK: deny_spam_score_over_int\nEnabled ACL options in block ACL_EXISCAN_BLOCK: default_exiscan\nEnabled ACL options in block ACL_RECIPIENT_BLOCK: default_recipient\nEnabled ACL options in block ACL_MAIL_POST_BLOCK: default_mail_post\nDetected spam handling in acls, disabling spamassassin in routers & transports!.\nSpamAssassin method remains unchanged\nConfigured options list is: \nACL: acl_smtp_connect is active\nACL: acl_smtp_data is active\nACL: acl_smtp_mail is active\nACL: acl_smtp_notquit is active\nACL: acl_smtp_rcpt is active\nProvided options list is: daemon_smtp_ports|tls_on_connect_ports|system_filter_user|system_filter_group|tls_require_ciphers|hostlist loopback|hostlist senderverifybypass_hosts|hostlist skipsmtpcheck_hosts|hostlist spammeripblocks|hostlist backupmx_hosts|hostlist trustedmailhosts|hostlist relay_hosts|domainlist user_domains|remote_max_parallel|smtp_receive_timeout|ignore_bounce_errors_after|rfc1413_query_timeout|timeout_frozen_after|auto_thaw|callout_domain_negative_expire|callout_negative_expire|acl_smtp_connect|acl_smtp_data|acl_smtp_mail|acl_smtp_notquit|acl_smtp_rcpt|perl_at_start|daemon_smtp_ports|tls_on_connect_ports|system_filter_user|system_filter_group|tls_require_ciphers|spamd_address\nExim Insert Regex is: virtual_userdelivery|virtual_aliases|lookuphost|virtual_user|address_pipe|virtual_sa_user|localuser\nExim Replace Regex is: virtual_sa_user|sa_localuser|virtual_sa_userdelivery|local_sa_delivery|central_filter|central_user_filter|democheck|fail_remote_domains|fixed_login|fixed_plain|has_alias_but_no_mailbox_discarded_to_prevent_loop|literal|local_delivery|local_delivery_spam|localuser|localuser_spam|lookuphost|remote_smtp|secure_login|secure_plain|userforward|virtual_aliases|virtual_aliases_nostar|virtual_user|virtual_user_spam|virtual_userdelivery|virtual_userdelivery_spam\nExim Match Insert Regex is: quota_directory|maildir_format\nExim version 4.76 #1 built 16-Aug-2011 11:41:07\nCopyright (c) University of Cambridge, 1995 - 2007\nBerkeley DB: Sleepycat Software: Berkeley DB 4.3.29: (July 12, 2010)\nSupport for: crypteq iconv() IPv6 PAM Perl OpenSSL Content_Scanning DKIM Old_Demime Experimental_SPF Experimental_SRS\nLookups (built-in): lsearch wildlsearch nwildlsearch iplsearch dbm dbmnz passwd\nAuthenticators: cram_md5 dovecot plaintext spa\nRouters: accept dnslookup ipliteral manualroute queryprogram redirect\nTransports: appendfile/maildir autoreply pipe smtp\nSize of off_t: 8\n\n</pre>"
}

Topic revision: r1 - 14 Feb 2012 - 21:49:00 - Main.JustinSchaefer