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

 

Description

This function validates the system's current Exim configuration.

Examples 


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

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)
{
   "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\n
Enabled 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\nThe system detected spam handling in acls and will 
now disable Apache SpamAssassin™ in routers and transports!\nThe Apache 
SpamAssassin™ 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>" 
}
 Output (XML)
<validate_current_installed_exim_config>
<html>
<pre>Doing
 Dry Run Dry Run ok Enabled system filter options: 
attachments|spam_rewrite Enabled ACL options in block 
ACL_MAIL_PRE_BLOCK: default_mail_pre 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_OUTGOING_NOTSMTP_CHECKALL_BLOCK: 
resolve_vhost_owner|end_default_outgoing_notsmtp_checkall Enabled ACL 
options in block ACL_CONNECT_BLOCK: 
ratelimit|slow_fail_block|spammerlist Enabled ACL options in block 
ACL_POST_RECP_VERIFY_BLOCK: dictionary_attack Enabled ACL options in 
block ACL_TRUSTEDLIST_BLOCK: trustedmailhosts Enabled ACL options in 
block ACL_IDENTIFY_SENDER_BLOCK: 
default_identify_sender|default_message_submission Enabled ACL options 
in block ACL_MAIL_BLOCK: 
requirehelo|requirehelonoforge|requirehelosyntax Enabled ACL options in 
block ACL_PRE_RECIPIENT_BLOCK: dkim_disable 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_SMTP_QUIT_BLOCK: slow_fail_block Enabled ACL 
options in block ACL_SPAM_SCAN_BLOCK: default_spam_scan Enabled ACL 
options in block ACL_RECP_VERIFY_BLOCK: default_recp_verify Enabled ACL 
options in block ACL_NOTQUIT_BLOCK: ratelimit Enabled ACL options in 
block ACL_PRE_SPAM_SCAN: mailproviders 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 spamaThe system detected spam handling in acls and will now 
disable Apache SpamAssassin™ in routers and transports! The Apache 
SpamAssassin™ method remains unchanged. Configured options list is: ACL:
 acl_not_smtp is active ACL: acl_smtp_connect is active ACL: 
acl_smtp_data is active ACL: acl_smtp_mail is active ACL: acl_smtp_quit 
is active ACL: acl_smtp_notquit is active ACL: acl_smtp_rcpt is active 
Provided options list is: 
deliver_queue_load_max|queue_only_load|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|smtp_accept_queue_per_connection|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_not_smtp|acl_smtp_connect|acl_smtp_data|acl_smtp_mail|acl_smtp_quit|acl_smtp_notquit|acl_smtp_rcpt|message_body_newlines|perl_at_start|deliver_queue_load_max|queue_only_load|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|democheck|check_mail_permissions|remote_smtp|address_pipe|virtual_user|localuser|virtual_sa_user
 Exim Replace Regex is: 
virtual_sa_user|sa_localuser|virtual_sa_userdelivery|local_sa_delivery|cpanel_archiver|cpanel_archiver_transport|discover_sender_information|fixed_login|fixed_plain|lookuphost|remote_smtp|secure_login|secure_plain
 Exim Match Insert Regex is: Exim version 4.80.1 #2 built 01-Apr-2013 
22:15:52 Copyright (c) University of Cambridge, 1995 - 2012 (c) The Exim
 Maintainers and contributors in ACKNOWLEDGMENTS file, 2007 - 2012 
Berkeley DB: Berkeley DB 4.7.25: (November 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 dbmjz 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>

   

Parameters

This function does not accept parameters. 

Returns

ReturnTypeDescriptionPossible valuesExample
validate_current_installed_exim_confighash

A hash of configuration information.

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

html

string

A list of Exim configuration parameters.

The function returns this value in the validate_current_installed_exim_config hash.

A valid string in HTML format.
 Click to view...
<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\n
Enabled 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\nThe system detected spam handling in acls and will 
now disable Apache SpamAssassin™ in routers and transports!\nThe Apache 
SpamAssassin™ 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>

status

Boolean

Whether the function failed.

The function returns this value in the validate_current_installed_exim_config hash.

  • 1 — Success.
  • 0 — Failure.
 1

statusmsg

string

A message of success or reason for failure.

The function returns this value in the validate_current_installed_exim_config hash.

A valid string.Your configuration is currently valid.