X-Git-Url: https://git.exim.org/users/heiko/exim.git/blobdiff_plain/c6325f903e41289f9b418cfc7535533ade2d1cc9..dc211a517b7ba61089518376c27a3087c72fb143:/doc/doc-docbook/spec.xfpt diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt index 4f2052c87..c023ca4c4 100644 --- a/doc/doc-docbook/spec.xfpt +++ b/doc/doc-docbook/spec.xfpt @@ -45,7 +45,7 @@ . Update the Copyright year (only) when changing content. . ///////////////////////////////////////////////////////////////////////////// -.set previousversion "4.85" +.set previousversion "4.86" .include ./local_params .set ACL "access control lists (ACLs)" @@ -1986,11 +1986,9 @@ defined. AAAA records (analogous to A records for IPv4) are in use, and are currently seen as the mainstream. Another record type called A6 was proposed as better than AAAA because it had more flexibility. However, it was felt to be over-complex, and its status was reduced to &"experimental"&. -.new Exim used to have a compile option for including A6 record support but this has now been withdrawn. -.wen @@ -2034,9 +2032,6 @@ For example, on a Sun system running Solaris 8, the directory .cindex "symbolic link" "to source files" Symbolic links to relevant source files are installed in the build directory. -&*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the -building process fails if it is set. - If this is the first time &'make'& has been run, it calls a script that builds a make file inside the build directory, using the configuration files from the &_Local_& directory. The new make file is then passed to another instance of @@ -3813,13 +3808,11 @@ This option is not intended for use by external callers. It is used internally by Exim in conjunction with the &%-MC%& option. It signifies that the connection to the remote host has been authenticated. -.new .vitem &%-MCD%& .oindex "&%-MCD%&" This option is not intended for use by external callers. It is used internally by Exim in conjunction with the &%-MC%& option. It signifies that the remote host supports the ESMTP &_DSN_& extension. -.wen .vitem &%-MCP%& .oindex "&%-MCP%&" @@ -4651,14 +4644,12 @@ this option. This option is interpreted by Sendmail to cause debug information to be sent to the named file. It is ignored by Exim. -.new .vitem &%-z%&&~<&'log-line'&> .oindex "&%-z%&" This option writes its argument to Exim's logfile. Use is restricted to administrators; the intent is for operational notes. Quotes should be used to maintain a multi-word item as a single argument, under most shells. -.wen .endlist .ecindex IIDclo1 @@ -5604,14 +5595,12 @@ find that they send unqualified addresses. The two commented-out options: show how you can specify hosts that are permitted to send unqualified sender and recipient addresses, respectively. -.new The &%log_selector%& option is used to increase the detail of logging over the default: .code log_selector = +smtp_protocol_error +smtp_syntax_error \ +tls_certificate_verified .endd -.wen The &%percent_hack_domains%& option is also commented out: .code @@ -6071,8 +6060,8 @@ address_pipe: .endd This transport is used for handling deliveries to pipes that are generated by redirection (aliasing or users' &_.forward_& files). The &%return_output%& -option specifies that any output generated by the pipe is to be returned to the -sender. +option specifies that any output on stdout or stderr generated by the pipe is to +be returned to the sender. .code address_file: driver = appendfile @@ -6254,12 +6243,14 @@ cause parts of the string to be replaced by data that is obtained from the lookup. Lookups of this type are conditional expansion items. Different results can be defined for the cases of lookup success and failure. See chapter &<>&, where string expansions are described in detail. +The key for the lookup is specified as part of the string expansion. .next Lists of domains, hosts, and email addresses can contain lookup requests as a way of avoiding excessively long linear lists. In this case, the data that is returned by the lookup is often (but not always) discarded; whether the lookup succeeds or fails is what really counts. These kinds of list are described in chapter &<>&. +The key for the lookup is given by the context in which the list is expanded. .endlist String expansions, lists, and lookups interact with each other in such a way @@ -6893,11 +6884,9 @@ is used on its own as the result. If the lookup does not succeed, the &`fail`& keyword causes a &'forced expansion failure'& &-- see section &<>& for an explanation of what this means. -.new The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA and TXT, and, when Exim is compiled with IPv6 support, AAAA. If no type is given, TXT is assumed. -.wen For any record type, if multiple records are found, the data is returned as a concatenation, with newline as the default separator. The order, of course, @@ -6945,7 +6934,6 @@ ${lookup dnsdb{spf=example.org}} It is permitted to specify a space as the separator character. Further white space is ignored. -.new .cindex "SOA record" "in &(dnsdb)& lookup" For an SOA lookup, while no result is obtained the lookup is redone with successively more leading components dropped from the given domain. @@ -6954,13 +6942,12 @@ specified. .code ${lookup dnsdb{>:,; soa=a.b.example.com}} .endd -.wen .section "Dnsdb lookup modifiers" "SECTdnsdb_mod" .cindex "dnsdb modifiers" .cindex "modifiers" "dnsdb" .cindex "options" "dnsdb" -Modifiers for &(dnsdb)& lookups are givien by optional keywords, +Modifiers for &(dnsdb)& lookups are given by optional keywords, each followed by a comma, that may appear before the record type. @@ -6995,18 +6982,16 @@ The default is &"never"&. See also the &$lookup_dnssec_authenticated$& variable. -.new .cindex timeout "dns lookup" .cindex "DNS" timeout Timeout for the dnsdb lookup can be controlled by a retrans modifier. The form is &"retrans_VAL"& where VAL is an Exim time specification -(eg &"5s"&). +(e.g. &"5s"&). The default value is set by the main configuration option &%dns_retrans%&. Retries for the dnsdb lookup can be controlled by a retry modifier. The form if &"retry_VAL"& where VAL is an integer. The default count is set by the main configuration option &%dns_retry%&. -.wen .section "Pseudo dnsdb record types" "SECID66" @@ -7682,11 +7667,9 @@ host, email address, or local part, respectively. In the sections below, the different types of pattern for each case are described, but first we cover some general facilities that apply to all four kinds of list. -.new Note that other parts of Exim use a &'string list'& which does not -support all the complexity availible in +support all the complexity available in domain, host, address and local part lists. -.wen @@ -8470,7 +8453,7 @@ this section. .cindex "&`+ignore_defer`&" A temporary DNS lookup failure normally causes a defer action (except when &%dns_again_means_nonexist%& converts it into a permanent error). However, -host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to +host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous section. These options should be used with care, probably only in non-critical host lists such as whitelists. @@ -8961,7 +8944,7 @@ If the ACL returns defer the result is a forced-fail. Otherwise the expansion f .cindex "&%certextract%&" "certificate fields" .cindex "certificate" "extracting fields" The <&'certificate'&> must be a variable of type certificate. -The field name is expanded and used to retrive the relevant field from +The field name is expanded and used to retrieve the relevant field from the certificate. Supported fields are: .display &`version `& @@ -8996,7 +8979,7 @@ parseable by Exim as a comma-separated tagged list RDN elements of a single type may be selected by a modifier of the type label; if so the expansion result is a list (newline-separated by default). -The separator may be changed by another modifer of +The separator may be changed by another modifier of a right angle-bracket followed immediately by the new separator. Recognised RDN type labels include "CN", "O", "OU" and "DC". @@ -9016,7 +8999,7 @@ The field selectors marked as "tagged" above prefix each list element with a type string and an equals sign. Elements of only one type may be selected by a modifier which is one of "dns", "uri" or "mail"; -if so the elenment tags are omitted. +if so the element tags are omitted. If not otherwise noted field values are presented in human-readable form. @@ -9059,7 +9042,6 @@ you need to add &%-shared%& to the gcc command. Also, in the Exim build-time configuration, you must add &%-export-dynamic%& to EXTRALIBS. -.new .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&" .cindex "expansion" "extracting value from environment" .cindex "environment" "value from" @@ -9081,7 +9063,6 @@ If {<&'string2'&>} is omitted an empty string is substituted on search failure. If {<&'string1'&>} is omitted the search result is substituted on search success. -.wen .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&& @@ -9283,10 +9264,11 @@ by earlier ACLs are visible. Upper case and lower case letters are synonymous in header names. If the following character is white space, the terminating colon may be omitted, but this is not recommended, because you may then forget it when it is needed. When -white space terminates the header name, it is included in the expanded string. -If the message does not contain the given header, the expansion item is -replaced by an empty string. (See the &%def%& condition in section -&<>& for a means of testing for the existence of a header.) +white space terminates the header name, this white space is included in the +expanded string. If the message does not contain the given header, the +expansion item is replaced by an empty string. (See the &%def%& condition in +section &<>& for a means of testing for the existence of a +header.) If there is more than one header with the same name, they are all concatenated to form the substitution string, up to a maximum length of 64K. Unless @@ -9933,7 +9915,7 @@ processing lists. To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows a strict interpretation of header line formatting. Exim parses the bare, unquoted portion of an email address and if it finds a comma, treats it as an -email address seperator. For the example header line: +email address separator. For the example header line: .code From: =?iso-8859-2?Q?Last=2C_First?= .endd @@ -10279,7 +10261,7 @@ random(). .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*& .cindex "expansion" "IP address" This operator reverses an IP address; for IPv4 addresses, the result is in -dotted-quad decimal form, while for IPv6 addreses the result is in +dotted-quad decimal form, while for IPv6 addresses the result is in dotted-nibble hexadecimal form. In both cases, this is the "natural" form for DNS. For example, .code @@ -11128,7 +11110,8 @@ support for TLS or the content scanning extension. When a &%match%& expansion condition succeeds, these variables contain the captured substrings identified by the regular expression during subsequent processing of the success string of the containing &%if%& expansion item. -However, they do not retain their values afterwards; in fact, their previous +In the expansion condition case +they do not retain their values afterwards; in fact, their previous values are restored at the end of processing an &%if%& item. The numerical variables may also be set externally by some other matching process which precedes the expansion of the string. For example, the commands available in @@ -11346,7 +11329,6 @@ The building process for Exim keeps a count of the number of times it has been compiled. This serves to distinguish different compilations of the same version of the program. -.new .vitem &$config_dir$& .vindex "&$config_dir$&" The directory name of the main configuration file. That is, the content of @@ -11357,7 +11339,6 @@ contain the trailing slash. If &$config_file$& does not contain a slash, .vitem &$config_file$& .vindex "&$config_file$&" The name of the main configuration file Exim is using. -.wen .vitem &$demime_errorlevel$& .vindex "&$demime_errorlevel$&" @@ -11371,7 +11352,6 @@ This variable is available when Exim is compiled with the content-scanning extension and the obsolete &%demime%& condition. For details, see section &<>&. -.new .vitem &$dkim_cur_signer$& &&& &$dkim_verify_status$& &&& &$dkim_verify_reason$& &&& @@ -11399,7 +11379,6 @@ For details see chapter &<>&. When a message has been received this variable contains a colon-separated list of signer domains and identities for the message. For details see chapter &<>&. -.wen .vitem &$dnslist_domain$& &&& &$dnslist_matched$& &&& @@ -11496,14 +11475,12 @@ This variable contains the path to the Exim binary. .vindex "&$exim_uid$&" This variable contains the numerical value of the Exim user id. -.new .vitem &$exim_version$& .vindex "&$exim_version$&" This variable contains the version string of the Exim build. The first character is a major version number, currently 4. Then after a dot, the next group of digits is a minor version number. There may be other characters following the minor version. -.wen .vitem &$found_extension$& .vindex "&$found_extension$&" @@ -11768,11 +11745,9 @@ a dnsdb lookup expansion, dnslookup router or smtp transport. It will be empty if &(DNSSEC)& was not requested, &"no"& if the result was not labelled as authenticated data and &"yes"& if it was. -.new -Results that are labelled as authoritive answer that match +Results that are labelled as authoritative answer that match the &%dns_trust_aa%& configuration variable count also as authenticated data. -.wen .vitem &$mailstore_basename$& .vindex "&$mailstore_basename$&" @@ -12183,6 +12158,12 @@ increases for each accepted recipient. It can be referenced in an ACL. This variable is set to contain the matching regular expression after a &%regex%& ACL condition has matched (see section &<>&). +.vitem "&$regex1$&, &$regex2$&, etc" +.cindex "regex submatch variables (&$1regex$& &$2regex$& etc)" +When a &%regex%& or &%mime_regex%& ACL condition succeeds, +these variables contain the +captured substrings identified by the regular expression. + .vitem &$reply_address$& .vindex "&$reply_address$&" @@ -12287,13 +12268,11 @@ verification either failed or was not requested. A host name in parentheses is the argument of a HELO or EHLO command. This is omitted if it is identical to the verified host name or to the host's IP address in square brackets. -.new .vitem &$sender_helo_dnssec$& .vindex "&$sender_helo_dnssec$&" This boolean variable is true if a successful HELO verification was .cindex "DNS" "DNSSEC" -done using DNS information the resolver library stated was authenticatied data. -.wen +done using DNS information the resolver library stated was authenticated data. .vitem &$sender_helo_name$& .vindex "&$sender_helo_name$&" @@ -12332,7 +12311,7 @@ dns_dnssec_ok = 1 .endd Exim does not perform DNSSEC validation itself, instead leaving that to a -validating resolver (eg, unbound, or bind with suitable configuration). +validating resolver (e.g. unbound, or bind with suitable configuration). If you have changed &%host_lookup_order%& so that &`bydns`& is not the first mechanism in the list, then this variable will be false. @@ -12571,10 +12550,8 @@ inbound connection when the message was received. It is only useful as the argument of a &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator, or a &%def%& condition. -.new If certificate verification fails it may refer to a failing chain element which is not the leaf. -.wen .vitem &$tls_out_ourcert$& .vindex "&$tls_out_ourcert$&" @@ -12589,17 +12566,15 @@ This variable refers to the certificate presented by the peer of an outbound connection. It is only useful as the argument of a &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator, or a &%def%& condition. -.new If certificate verification fails it may refer to a failing chain element which is not the leaf. -.wen .vitem &$tls_in_certificate_verified$& .vindex "&$tls_in_certificate_verified$&" This variable is set to &"1"& if a TLS certificate was verified when the message was received, and &"0"& otherwise. -The deprecated &$tls_certificate_verfied$& variable refers to the inbound side +The deprecated &$tls_certificate_verified$& variable refers to the inbound side except when used in the context of an outbound SMTP delivery, when it refers to the outbound. @@ -12656,10 +12631,8 @@ When a message is received from a remote host over an encrypted SMTP connection, and Exim is configured to request a certificate from the client, the value of the Distinguished Name of the certificate is made available in the &$tls_in_peerdn$& during subsequent processing. -.new If certificate verification fails it may refer to a failing chain element which is not the leaf. -.wen The deprecated &$tls_peerdn$& variable refers to the inbound side except when used in the context of an outbound SMTP delivery, when it refers to @@ -12671,10 +12644,8 @@ When a message is being delivered to a remote host over an encrypted SMTP connection, and Exim is configured to request a certificate from the server, the value of the Distinguished Name of the certificate is made available in the &$tls_out_peerdn$& during subsequent processing. -.new If certificate verification fails it may refer to a failing chain element which is not the leaf. -.wen .vitem &$tls_in_sni$& .vindex "&$tls_in_sni$&" @@ -13725,26 +13696,22 @@ This option defines the ACL that is run after an SMTP DATA command has been processed and the message itself has been received, but before the final acknowledgment is sent. See chapter &<>& for further details. -.new .option acl_smtp_data_prdr main string&!! accept .cindex "PRDR" "ACL for" .cindex "DATA" "PRDR ACL for" .cindex "&ACL;" "PRDR-related" .cindex "&ACL;" "per-user data processing" -.wen This option defines the ACL that, if the PRDR feature has been negotiated, is run for each recipient after an SMTP DATA command has been processed and the message itself has been received, but before the acknowledgment is sent. See chapter &<>& for further details. -.new .option acl_smtp_dkim main string&!! unset .cindex DKIM "ACL for" This option defines the ACL that is run for each DKIM signature of a received message. See chapter &<>& for further details. -.wen .option acl_smtp_etrn main string&!! unset .cindex "ETRN" "ACL for" @@ -13780,13 +13747,11 @@ This option is available when Exim is built with the content-scanning extension. It defines the ACL that is run for each MIME part in a message. See section &<>& for details. -.new .option acl_smtp_notquit main string&!! unset .cindex "not-QUIT, ACL for" This option defines the ACL that is run when an SMTP session ends without a QUIT command being received. See chapter &<>& for further details. -.wen .option acl_smtp_predata main string&!! unset This option defines the ACL that is run when an SMTP DATA command is @@ -13844,7 +13809,7 @@ the local host's IP addresses. It appears that more and more DNS zone administrators are breaking the rules and putting domain names that look like IP addresses on the right hand side of MX records. Exim follows the rules and rejects this, giving an error message -that explains the mis-configuration. However, some other MTAs support this +that explains the misconfiguration. However, some other MTAs support this practice, so to avoid &"Why can't Exim do this?"& complaints, &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not recommended, except when you have no other choice. @@ -14223,14 +14188,12 @@ etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines to handle IPv6 literal addresses. -.new .option dkim_verify_signers main "domain list&!!" $dkim_signers .cindex DKIM "controlling calls to the ACL" This option gives a list of DKIM domains for which the DKIM ACL is run. It is expanded after the message is received; by default it runs the ACL once for each signature in the message. See chapter &<>&. -.wen .option dns_again_means_nonexist main "domain list&!!" unset @@ -14319,16 +14282,13 @@ take. I haven't found any documentation about timeouts on DNS lookups; these parameter values are available in the external resolver interface structure, but nowhere does it seem to describe how they are used or what you might want to set in them. -.new See also the &%slow_lookup_log%& option. -.wen .option dns_retry main integer 0 See &%dns_retrans%& above. -.new .option dns_trust_aa main "domain list&!!" unset .cindex "DNS" "resolver options" .cindex "DNS" "DNSSEC" @@ -14338,22 +14298,21 @@ DNSSEC-verified. The authority section's name of the answer must match with this expanded domain list. Use this option only if you talk directly to a resolver that is -authoritive for some zones and does not set the AD (Authentic Data) +authoritative for some zones and does not set the AD (Authentic Data) bit in the answer. Some DNS servers may have an configuration option to mark the answers from their own zones as verified (they set the AD bit). Others do not have this option. It is considered as poor practice using -a resolver that is an authoritive server for some zones. +a resolver that is an authoritative server for some zones. Use this option only if you really have to (e.g. if you want to use DANE for remote delivery to a server that is listed in the DNS -zones that your resolver is authoritive for). +zones that your resolver is authoritative for). If the DNS answer packet has the AA bit set and contains resource record in the answer section, the name of the first NS record appearing in the authority section is compared against the list. If the answer packet is -authoritive but the answer section is empty, the name of the first SOA -record in the authoritive section is used instead. -.wen +authoritative but the answer section is empty, the name of the first SOA +record in the authoritative section is used instead. .cindex "DNS" "resolver options" .option dns_use_edns0 main integer -1 @@ -14372,7 +14331,6 @@ This is an obsolete option that is now a no-op. It used to affect the way Exim handled CR and LF characters in incoming messages. What happens now is described in section &<>&. -.new .option dsn_advertise_hosts main "host list&!!" unset .cindex "bounce messages" "success" .cindex "DSN" "success" @@ -14384,7 +14342,6 @@ and RET and ORCPT options on MAIL FROM commands. A NOTIFY=SUCCESS option requests success-DSN messages. A NOTIFY= option with no argument requests that no delay or failure DSNs are sent. -.wen .option dsn_from main "string&!!" "see below" .cindex "&'From:'& header line" "in bounces" @@ -14403,7 +14360,7 @@ panic is logged, and the default value is used. Exim's transports have an option for adding an &'Envelope-to:'& header to a message when it is delivered, in exactly the same way as &'Return-path:'& is handled. &'Envelope-to:'& records the original recipient address from the -messages's envelope that caused the delivery to happen. Such headers should not +message's envelope that caused the delivery to happen. Such headers should not be present in incoming messages, and this option causes them to be removed at the time the message is received, to avoid any problems that might occur when a delivered message is subsequently sent on to some other recipient. @@ -14510,7 +14467,7 @@ routing, but which are not used for listening by the daemon. See section . Allow this long option name to split; give it unsplit as a fifth argument . for the automatic .oindex that is generated by .option. -.option "extract_addresses_remove_ &~&~arguments" main boolean true &&& +.option "extract_addresses_remove_arguments" main boolean true &&& extract_addresses_remove_arguments .oindex "&%-t%&" .cindex "command line" "addresses with &%-t%&" @@ -15227,7 +15184,7 @@ If you use a virus-scanner and set this option to to a value larger than the maximum size that your virus-scanner is configured to support, you may get failures triggered by large mails. The right size to configure for the virus-scanner depends upon what data is passed and the options in use but it's -probably safest to just set it to a little larger than this value. Eg, with a +probably safest to just set it to a little larger than this value. E.g., with a default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M, some problems may result. @@ -15469,7 +15426,7 @@ to SMTP, defined by Eric Hall. If the option is set, PRDR is advertised by Exim when operating as a server. If the client requests PRDR, and more than one recipient, for a message an additional ACL is called for each recipient after the message content -is recieved. See section &<>&. +is received. See section &<>&. .option preserve_message_logs main boolean false .cindex "message logs" "preserving" @@ -15882,7 +15839,6 @@ the time of delivery. They are normally used only for final local deliveries. This option is an obsolete synonym for &%bounce_return_size_limit%&. -.new .option rfc1413_hosts main "host list&!!" @[] .cindex "RFC 1413" .cindex "host" "for RFC 1413 calls" @@ -15890,11 +15846,8 @@ RFC 1413 identification calls are made to any client host which matches an item in the list. The default value specifies just this host, being any local interface for the system. -.wen -.new .option rfc1413_query_timeout main time 0s -.wen .cindex "RFC 1413" "query timeout" .cindex "timeout" "for RFC 1413 call" This sets the timeout on RFC 1413 identification calls. If it is set to zero, @@ -15913,7 +15866,6 @@ it qualifies them only if the message came from a host that matches using TCP/IP), and the &%-bnq%& option was not set. -.new .option slow_lookup_log main integer 0 .cindex "logging" "slow lookups" .cindex "dns" "logging slow lookups" @@ -15921,7 +15873,6 @@ This option controls logging of slow lookups. If the value is nonzero it is taken as a number of milliseconds and lookups taking longer than this are logged. Currently this applies only to DNS lookups. -.wen @@ -16315,11 +16266,9 @@ SMTP data timeout on connection from... The former means that Exim was expecting to read an SMTP command; the latter means that it was in the DATA phase, reading the contents of a message. -.new If the first character of the option is a &"$"& the option is expanded before use and may depend on &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&. -.wen .oindex "&%-os%&" @@ -16706,7 +16655,6 @@ prior to the 4.80 release, as Debian used to patch Exim to raise the minimum acceptable bound from 1024 to 2048. -.new .option tls_eccurve main string&!! prime256v1 .cindex TLS "EC cryptography" If built with a recent-enough version of OpenSSL, @@ -16718,7 +16666,6 @@ are also accepted, plus the special value &'auto'& which tell the library to choose. If the option is set to an empty string, no EC curves will be enabled. -.wen .option tls_ocsp_file main string&!! unset @@ -16729,6 +16676,10 @@ must if set expand to the absolute path to a file which contains a current status proof for the server's certificate, as obtained from the Certificate Authority. +.new +Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later). +.wen + .option tls_on_connect_ports main "string list" unset .cindex SSMTP @@ -16779,7 +16730,6 @@ preference order of the available ciphers. Details are given in sections See &%tls_verify_hosts%& below. -.new .option tls_verify_certificates main string&!! system .cindex "TLS" "client certificate verification" .cindex "certificate" "verification of client" @@ -16795,14 +16745,13 @@ This is not available for GnuTLS versions preceding 3.0.20, and will be taken as empty; an explicit location must be specified. -The use of a directory for the option value is not avilable for GnuTLS versions +The use of a directory for the option value is not available for GnuTLS versions preceding 3.3.6 and a single file must be used. With OpenSSL the certificates specified explicitly either by file or directory are added to those given by the system default location. -.wen These certificates should be for the certificate authorities trusted, rather than the public cert of individual clients. With both OpenSSL and GnuTLS, if @@ -17242,7 +17191,6 @@ or for any deliveries caused by this router. You should not set this option unless you really, really know what you are doing. See also the generic transport option of the same name. -.new .option dnssec_request_domains routers "domain list&!!" unset .cindex "MX record" "security" .cindex "DNSSEC" "MX lookup" @@ -17261,7 +17209,6 @@ DNS lookups for domains matching &%dnssec_request_domains%& will be done with the dnssec request bit set. Any returns not having the Authenticated Data bit (AD bit) set will be ignored and logged as a host-lookup failure. This applies to all of the SRV, MX, AAAA, A lookup sequence. -.wen .option domains routers&!? "domain list&!!" unset @@ -17280,7 +17227,6 @@ This option must always be set. It specifies which of the available routers is to be used. -.new .option dsn_lasthop routers boolean false .cindex "DSN" "success" .cindex "Delivery Status Notification" "success" @@ -17288,7 +17234,6 @@ If this option is set true, and extended DSN (RFC3461) processing is in effect, Exim will not pass on DSN requests to downstream DSN-aware hosts but will instead send a success DSN as if the next hop does not support DSN. Not effective on redirect routers. -.wen @@ -17413,9 +17358,7 @@ and the discussion in chapter &<>&. .cindex "header lines" "adding" .cindex "router" "adding header lines" This option specifies a list of text headers, -.new newline-separated (by default, changeable in the usual way), -.wen that is associated with any addresses that are accepted by the router. Each item is separately expanded, at routing time. However, this option has no effect when an address is just being verified. The way in which @@ -17453,9 +17396,7 @@ avoided. The &%repeat_use%& option of the &%redirect%& router may be of help. .cindex "header lines" "removing" .cindex "router" "removing header lines" This option specifies a list of text headers, -.new colon-separated (by default, changeable in the usual way), -.wen that is associated with any addresses that are accepted by the router. Each item is separately expanded, at routing time. However, this option has no effect when an address is just being verified. The way in which @@ -17481,11 +17422,9 @@ removal requests are deleted when the address is passed on to subsequent routers, and this can lead to problems with duplicates -- see the similar warning for &%headers_add%& above. -.new &*Warning 3*&: Because of the separate expansion of the list items, items that contain a list separator must have it doubled. To avoid this, change the list separator (&<>&). -.wen @@ -18219,7 +18158,7 @@ happens is controlled by the generic &%self%& option. .section "Problems with DNS lookups" "SECTprowitdnsloo" There have been problems with DNS servers when SRV records are looked up. -Some mis-behaving servers return a DNS error or timeout when a non-existent +Some misbehaving servers return a DNS error or timeout when a non-existent SRV record is sought. Similar problems have in the past been reported for MX records. The global &%dns_again_means_nonexist%& option can help with this problem, but it is heavy-handed because it is a global option. @@ -18241,10 +18180,8 @@ There are a few cases where a &(dnslookup)& router will decline to accept an address; if such a router is expected to handle "all remaining non-local domains", then it is important to set &%no_more%&. -.new The router will defer rather than decline if the domain is found in the &%fail_defer_domains%& router option. -.wen Reasons for a &(dnslookup)& router to decline currently include: .ilist @@ -18325,7 +18262,6 @@ when there is a DNS lookup error. -.new .option fail_defer_domains dnslookup "domain list&!!" unset .cindex "MX record" "not found" DNS lookups for domains matching &%fail_defer_domains%& @@ -18335,7 +18271,6 @@ This maybe be useful for queueing messages for a newly created domain while the DNS configuration is not ready. However, it will result in any message with mistyped domains also being queued. -.wen .option mx_domains dnslookup "domain list&!!" unset @@ -19306,12 +19241,10 @@ However, there are some private options which define transports for delivery to files and pipes, and for generating autoreplies. See the &%file_transport%&, &%pipe_transport%& and &%reply_transport%& descriptions below. -.new If success DSNs have been requested .cindex "DSN" "success" .cindex "Delivery Status Notification" "success" redirection triggers one and the DSN options are not passed any further. -.wen @@ -19579,7 +19512,7 @@ the router to decline. Instead, the alias item .cindex "black hole" .cindex "abandoning mail" &':blackhole:'& can be used. It does what its name implies. No delivery is -done, and no error message is generated. This has the same effect as specifing +done, and no error message is generated. This has the same effect as specifying &_/dev/null_& as a destination, but it can be independently disabled. &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no @@ -20506,9 +20439,7 @@ value that the router supplies, and also overriding any value associated with .cindex "header lines" "adding in transport" .cindex "transport" "header lines; adding" This option specifies a list of text headers, -.new newline-separated (by default, changeable in the usual way), -.wen which are (separately) expanded and added to the header portion of a message as it is transported, as described in section &<>&. Additional header lines can also be specified by @@ -20534,9 +20465,7 @@ checked, since this option does not automatically suppress them. .cindex "header lines" "removing" .cindex "transport" "header lines; removing" This option specifies a list of header names, -.new colon-separated (by default, changeable in the usual way); -.wen these headers are omitted from the message as it is transported, as described in section &<>&. Header removal can also be specified by routers. @@ -22761,6 +22690,7 @@ Note that &$address_pipe$& is handled specially in &%command%& when &%force_command%& is set, expanding out to the original argument vector as separate items, similarly to a Unix shell &`"$@"`& construct. + .option ignore_status pipe boolean false If this option is true, the status returned by the subprocess that is set up to run the command is ignored, and Exim behaves as if zero had been returned. @@ -22771,27 +22701,29 @@ from the transport unless the status value is one of those listed in &*Note*&: This option does not apply to timeouts, which do not return a status. See the &%timeout_defer%& option for how timeouts are handled. + .option log_defer_output pipe boolean false .cindex "&(pipe)& transport" "logging output" If this option is set, and the status returned by the command is one of the codes listed in &%temp_errors%& (that is, delivery was deferred), -and any output was produced, the first line of it is written to the main log. +and any output was produced on stdout or stderr, the first line of it is +written to the main log. .option log_fail_output pipe boolean false -If this option is set, and the command returns any output, and also ends with a -return code that is neither zero nor one of the return codes listed in -&%temp_errors%& (that is, the delivery failed), the first line of output is -written to the main log. This option and &%log_output%& are mutually exclusive. -Only one of them may be set. - +If this option is set, and the command returns any output on stdout or +stderr, and also ends with a return code that is neither zero nor one of +the return codes listed in &%temp_errors%& (that is, the delivery +failed), the first line of output is written to the main log. This +option and &%log_output%& are mutually exclusive. Only one of them may +be set. .option log_output pipe boolean false -If this option is set and the command returns any output, the first line of -output is written to the main log, whatever the return code. This option and -&%log_fail_output%& are mutually exclusive. Only one of them may be set. - +If this option is set and the command returns any output on stdout or +stderr, the first line of output is written to the main log, whatever +the return code. This option and &%log_fail_output%& are mutually +exclusive. Only one of them may be set. .option max_output pipe integer 20K @@ -23276,7 +23208,7 @@ This applies to all of the SRV, MX, AAAA, A lookup sequence. .cindex "DNS" "DNSSEC" DNS lookups for domains matching &%dnssec_request_domains%& will be done with the dnssec request bit set. Any returns not having the Authenticated Data bit -(AD bit) set wil be ignored and logged as a host-lookup failure. +(AD bit) set will be ignored and logged as a host-lookup failure. This applies to all of the SRV, MX, AAAA, A lookup sequence. @@ -23428,13 +23360,11 @@ that matches this list, even if the server host advertises PIPELINING support. Exim will not try to start a TLS session when delivering to any host that matches this list. See chapter &<>& for details of TLS. -.new .option hosts_verify_avoid_tls smtp "host list&!!" unset .cindex "TLS" "avoiding for certain hosts" Exim will not try to start a TLS session for a verify callout, or when delivering in cutthrough mode, to any host that matches this list. -.wen .option hosts_max_try smtp integer 5 @@ -23531,14 +23461,12 @@ connects. If authentication fails, Exim will try to transfer the message unauthenticated. See also &%hosts_require_auth%&, and chapter &<>& for details of authentication. -.new .option hosts_try_prdr smtp "host list&!!" * .cindex "PRDR" "enabling, optional in client" This option provides a list of servers to which, provided they announce PRDR support, Exim will attempt to negotiate PRDR for multi-recipient messages. The option can usually be left as default. -.wen .option interface smtp "string list&!!" unset .cindex "bind IP address" @@ -23605,11 +23533,9 @@ handling only one domain at a time. This is useful if you want to use &$domain$& in an expansion for the transport, because it is set only when there is a single domain involved in a remote delivery. -.new It is expanded per-address and can depend on any of &$address_data$&, &$domain_data$&, &$local_part_data$&, &$host$&, &$host_address$& and &$host_port$&. -.wen .option port smtp string&!! "see below" .cindex "port" "sending TCP/IP" @@ -23639,7 +23565,7 @@ protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local deliveries into closed message stores. Exim also has support for running LMTP over a pipe to a local process &-- see chapter &<>&. -If this option is set to &"smtps"&, the default vaule for the &%port%& option +If this option is set to &"smtps"&, the default value for the &%port%& option changes to &"smtps"&, and the transport initiates TLS immediately after connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade. The Internet standards bodies strongly discourage use of this mode. @@ -23656,9 +23582,7 @@ However, in some dialup environments hosts are assigned a different IP address each time they connect. In this situation the use of the IP address as part of the retry key leads to undesirable behaviour. Setting this option false causes Exim to use only the host name. -.new Since it is expanded it can be made to depend on the host or domain. -.wen .option serialize_hosts smtp "host list&!!" unset @@ -23796,9 +23720,7 @@ unknown state), opens a new one to the same host, and then tries the delivery in clear. -.new .option tls_try_verify_hosts smtp "host list&!!" * -.wen .cindex "TLS" "server certificate verification" .cindex "certificate" "verification of server" This option gives a list of hosts for which, on encrypted connections, @@ -23811,7 +23733,6 @@ The &$tls_out_certificate_verified$& variable is set when certificate verification succeeds. -.new .option tls_verify_cert_hostnames smtp "host list&!!" * .cindex "TLS" "server certificate hostname verification" .cindex "certificate" "verification of server" @@ -23823,10 +23744,8 @@ versus Subject and Subject-Alternate-Name fields. Wildcard names are permitted limited to being the initial component of a 3-or-more component FQDN. There is no equivalent checking on client certificates. -.wen -.new .option tls_verify_certificates smtp string&!! system .cindex "TLS" "server certificate verification" .cindex "certificate" "verification of server" @@ -23843,9 +23762,8 @@ This is not available for GnuTLS versions preceding 3.0.20; a value of "system" is taken as empty and an explicit location must be specified. -The use of a directory for the option value is not avilable for GnuTLS versions +The use of a directory for the option value is not available for GnuTLS versions preceding 3.3.6 and a single file must be used. -.wen With OpenSSL the certificates specified explicitly @@ -23856,7 +23774,7 @@ The values of &$host$& and &$host_address$& are set to the name and address of the server during the expansion of this option. See chapter &<>& for details of TLS. -For back-compatability, +For back-compatibility, if neither tls_verify_hosts nor tls_try_verify_hosts are set (a single-colon empty list counts as being set) and certificate verification fails the TLS connection is closed. @@ -24613,14 +24531,12 @@ A server unexpectedly closed the SMTP connection. There may, of course, legitimate reasons for this (host died, network died), but if it repeats a lot for the same host, it indicates something odd. -.new .vitem &%lookup%& A DNS lookup for a host failed. Note that a &%dnslookup%& router will need to have matched its &%fail_defer_domains%& option for this retry type to be usable. Also note that a &%manualroute%& router will probably need its &%host_find_failed%& option set to &%defer%&. -.wen .vitem &%refused_MX%& A connection to a host obtained from an MX record was refused. @@ -25048,10 +24964,8 @@ The sixth can be configured to support the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is not formally documented, but used by several MUAs. The seventh authenticator supports Microsoft's &'Secure Password Authentication'& mechanism. -.new The eighth is an Exim authenticator but not an SMTP one; instead it can use information from a TLS negotiation. -.wen The authenticators are configured using the same syntax as other drivers (see section &<>&). If no authenticators are required, no @@ -25123,7 +25037,7 @@ client_condition = ${if !eq{$tls_out_cipher}{}} .option client_set_id authenticators string&!! unset When client authentication succeeds, this condition is expanded; the -result is used in the log lines for outbound messasges. +result is used in the log lines for outbound messages. Typically it will be the user name used for authentication. @@ -26141,7 +26055,7 @@ The value should be a pathname, with no &"file:"& prefix. .option server_service heimdal_gssapi string&!! "smtp" This option specifies the service identifier used, in conjunction with -&%server_hostname%&, for building the identifer for finding credentials +&%server_hostname%&, for building the identifier for finding credentials from the keytab. @@ -26261,7 +26175,6 @@ msn: . //////////////////////////////////////////////////////////////////////////// . //////////////////////////////////////////////////////////////////////////// -.new .chapter "The tls authenticator" "CHAPtlsauth" .scindex IIDtlsauth1 "&(tls)& authenticator" .scindex IIDtlsauth2 "authenticators" "&(tls)&" @@ -26286,7 +26199,7 @@ for which it must have been requested via the If an authenticator of this type is configured it is run before any SMTP-level communication is done, and can authenticate the connection. -If it does, SMTP suthentication is not offered. +If it does, SMTP authentication is not offered. A maximum of one authenticator of this type may be present. @@ -26324,7 +26237,6 @@ tls: .endd .ecindex IIDtlsauth1 .ecindex IIDtlsauth2 -.wen Note that because authentication is traditionally an SMTP operation, @@ -26778,9 +26690,7 @@ apply to all TLS connections. For any host that matches one of these options, Exim requests a certificate as part of the setup of the TLS session. The contents of the certificate are verified by comparing it with a list of expected certificates. -.new These may be the system default set (depending on library version), -.wen an explicit file or, depending on library version, a directory, identified by &%tls_verify_certificates%&. @@ -26856,7 +26766,9 @@ starts retrying to fetch an OCSP proof some time before its current proof expires. The downside is that it requires server support. Unless Exim is built with the support disabled, -or with GnuTLS earlier than version 3.1.3, +.new +or with GnuTLS earlier than version 3.3.16 / 3.4.8 +.wen support for OCSP stapling is included. There is a global option called &%tls_ocsp_file%&. @@ -26943,11 +26855,9 @@ if it requests it. If the server is Exim, it will request a certificate only if If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it specifies a collection of expected server certificates. -.new These may be the system default set (depending on library version), -.wen a file or, -depnding on liibrary version, a directory, +depending on library version, a directory, must name a file or, for OpenSSL only (not GnuTLS), a directory. The client verifies the server's certificate @@ -27017,7 +26927,7 @@ client in the initial handshake, so that the server can examine the servername within and possibly choose to use different certificates and keys (and more) for this session. -This is analagous to HTTP's &"Host:"& header, and is the main mechanism by +This is analogous to HTTP's &"Host:"& header, and is the main mechanism by which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP address. @@ -27071,7 +26981,7 @@ arbitrary unverified data provided prior to authentication. The Exim developers are proceeding cautiously and so far no other TLS options are re-expanded. -When Exim is built againt OpenSSL, OpenSSL must have been built with support +When Exim is built against OpenSSL, OpenSSL must have been built with support for TLS Extensions. This holds true for OpenSSL 1.0.0+ and 0.9.8+ with enable-tlsext in EXTRACONFIGURE. If you invoke &(openssl s_client -h)& and see &`-servername`& in the output, then OpenSSL has support. @@ -27429,10 +27339,10 @@ It becomes active only when the PRDR feature is negotiated between client and server for a message, and more than one recipient has been accepted. -The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message -has been recieved, and is executed once for each recipient of the message +The ACL test specified by &%acl_smtp_data_prdr%& happens after a message +has been received, and is executed once for each recipient of the message with &$local_part$& and &$domain$& valid. -The test may accept, defer or deny for inividual recipients. +The test may accept, defer or deny for individual recipients. The &%acl_smtp_data%& will still be called after this ACL and can reject the message overall, even if this ACL has accepted it for some or all recipients. @@ -27443,7 +27353,7 @@ content-filter configuration. With PRDR, the RCPT-time check for this can be disabled when the MAIL-time $smtp_command included "PRDR". Any required difference in behaviour of the main DATA-time ACL should however depend on the PRDR-time ACL having run, as Exim -will avoid doing so in some situations (eg. single-recipient mails). +will avoid doing so in some situations (e.g. single-recipient mails). See also the &%prdr_enable%& global option and the &%hosts_try_prdr%& smtp transport option. @@ -27457,10 +27367,8 @@ the feature was not requested by the client. The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL does not affect the response code to QUIT, which is always 221. Thus, the ACL does not in fact control any access. -.new For this reason, it may only accept or warn as its final result. -.wen This ACL can be used for tasks such as custom logging at the end of an SMTP session. For example, you can use ACL variables in other ACLs to count @@ -28376,11 +28284,9 @@ is what is wanted for subsequent tests. This option requests delivery be attempted while the item is being received. The option is usable in the RCPT ACL. -If enabled for a message recieved via smtp and routed to an smtp transport, -.new +If enabled for a message received via smtp and routed to an smtp transport, and only one transport, interface, destination host and port combination is used for all recipients of the message, -.wen then the delivery connection is made while the receiving connection is open and data is copied from one to the other. @@ -28388,9 +28294,7 @@ An attempt to set this option for any recipient but the first for a mail will be quietly ignored. If a recipient-verify callout connection is subsequently requested in the same ACL it is held open and used for -.new -any subsequent receipients and the data, -.wen +any subsequent recipients and the data, otherwise one is made after the initial RCPT ACL completes. Note that routers are used in verify mode, @@ -28402,9 +28306,7 @@ Headers may be modified by routers (subject to the above) and transports. Cutthrough delivery is not supported via transport-filters or when DKIM signing of outgoing messages is done, because it sends data to the ultimate destination before the entire message has been received from the source. -.new -It is not supported for messages recieved with the SMTP PRDR option in use. -.wen +It is not supported for messages received with the SMTP PRDR option in use. Should the ultimate destination system positively accept or reject the mail, a corresponding indication is given to the source system and nothing is queued. @@ -29142,7 +29044,8 @@ This condition is relevant only in an ACL that is run after a message has been received, that is, in an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&. It checks the syntax of all header lines that can contain lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&, -and &'Bcc:'&). Unqualified addresses (local parts without domains) are +and &'Bcc:'&), returning true if there are no problems. +Unqualified addresses (local parts without domains) are permitted only in locally generated messages and from hosts that match &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as appropriate. @@ -29213,10 +29116,8 @@ Verification ensures that the host name obtained from a reverse DNS lookup, or one of its aliases, does, when it is itself looked up in the DNS, yield the original IP address. -.new There is one possible option, &`defer_ok`&. If this is present and a DNS operation returns a temporary error, the verify condition succeeds. -.wen If this condition is used for a locally generated message (that is, when there is no client host involved), it always succeeds. @@ -30765,10 +30666,8 @@ It supports a &"generic"& interface to scanners called via the shell, and specialized interfaces for &"daemon"& type virus scanners, which are resident in memory and thus are much faster. -.new A timeout of 2 minutes is applied to a scanner call (by default); if it expires then a defer action is taken. -.wen .oindex "&%av_scanner%&" You can set the &%av_scanner%& option in the main part of the configuration @@ -30787,11 +30686,10 @@ The usual list-parsing of the content (see &<>&) applies. The following scanner types are supported in this release: .vlist -.new .vitem &%avast%& .cindex "virus scanners" "avast" This is the scanner daemon of Avast. It has been tested with Avast Core -Security (currenty at version 1.1.7). +Security (currently at version 1.1.7). You can get a trial version at &url(http://www.avast.com) or for Linux at &url(http://www.avast.com/linux-server-antivirus). This scanner type takes one option, @@ -30819,7 +30717,6 @@ $ socat UNIX:/var/run/avast/scan.sock STDIO: SENSITIVITY PACK .endd -.wen .vitem &%aveserver%& @@ -30996,7 +30893,7 @@ You can safely omit this option (the default value is 1). This is a general-purpose way of talking to simple scanner daemons running on the local machine. There are four options: -an address (which may be an IP addres and port, or the path of a Unix socket), +an address (which may be an IP address and port, or the path of a Unix socket), a commandline to send (may include a single %s which will be replaced with the path to the mail file to be scanned), an RE to trigger on from the returned data, @@ -31035,9 +30932,7 @@ which case each use of the &%malware%& condition causes a new scan of the message. The &%malware%& condition takes a right-hand argument that is expanded before -.new use and taken as a list, slash-separated by default. -.wen The first element can then be one of .ilist @@ -31051,17 +30946,14 @@ the condition fails immediately. A regular expression, in which case the message is scanned for viruses. The condition succeeds if a virus is found and its name matches the regular expression. This allows you to take special actions on certain types of virus. -.new Note that &"/"& characters in the RE must be doubled due to the list-processing, unless the separator is changed (in the usual way). -.wen .endlist You can append a &`defer_ok`& element to the &%malware%& argument list to accept messages even if there is a problem with the virus scanner. Otherwise, such a problem causes the ACL to defer. -.new You can append a &`tmo=`& element to the &%malware%& argument list to specify a non-default timeout. The default is two minutes. For example: @@ -31069,7 +30961,6 @@ For example: malware = * / defer_ok / tmo=10s .endd A timeout causes the ACL to defer. -.wen .vindex "&$malware_name$&" When a virus is found, the condition sets up an expansion variable called @@ -31120,13 +31011,11 @@ deny message = This message contains malware ($malware_name) .cindex "Rspamd" The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam score and a report for the message. -.new Support is also provided for Rspamd. For more information about installation and configuration of SpamAssassin or Rspamd refer to their respective websites at &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com) -.wen SpamAssassin can be installed with CPAN by running: .code @@ -31146,14 +31035,12 @@ configuration as follows (example): spamd_address = 192.168.99.45 387 .endd -.new To use Rspamd (which by default listens on all local addresses on TCP port 11333) you should add &%variant=rspamd%& after the address/port pair, for example: .code spamd_address = 127.0.0.1 11333 variant=rspamd .endd -.wen As of version 2.60, &%SpamAssassin%& also supports communication over UNIX sockets. If you want to us these, supply &%spamd_address%& with an absolute @@ -31175,7 +31062,6 @@ When a server fails to respond to the connection attempt, all other servers are tried until one succeeds. If no server responds, the &%spam%& condition defers. -.new Unix and TCP socket specifications may be mixed in any order. Each element of the list is a list itself, space-separated by default and changeable in the usual way. @@ -31199,7 +31085,7 @@ variant=rspamd Use Rspamd rather than SpamAssassin protocol The &`pri`& option specifies a priority for the server within the list, higher values being tried first. -The deafult priority is 1. +The default priority is 1. The &`weight`& option specifies a selection bias. Within a priority set @@ -31212,7 +31098,7 @@ Either the seconds or both minutes and seconds, plus the leading &`.`& characters, may be omitted and will be taken as zero. Timeout specifications for the &`retry`& and &`tmo`& options -are the usual Exim time interval standard, eg. &`20s`& or &`1m`&. +are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&. The &`tmo`& option specifies an overall timeout for communication. The default value is two minutes. @@ -31220,7 +31106,6 @@ The default value is two minutes. The &`retry`& option specifies a time after which a single retry for a failed connect is made. The default is to not retry. -.wen The &%spamd_address%& variable is expanded before use if it starts with a dollar sign. In this case, the expansion may return a string that is @@ -31237,10 +31122,8 @@ The right-hand side of the &%spam%& condition specifies a name. This is relevant if you have set up multiple SpamAssassin profiles. If you do not want to scan using a specific profile, but rather use the SpamAssassin system-wide default profile, you can scan for an unknown name, or simply use &"nobody"&. -.new Rspamd does not use this setting. However, you must put something on the right-hand side. -.wen The name allows you to use per-domain or per-user antispam profiles in principle, but this is not straightforward in practice, because a message may @@ -31248,14 +31131,12 @@ have multiple recipients, not necessarily all in the same domain. Because the &%spam%& condition has to be called from a DATA-time ACL in order to be able to read the contents of the message, the variables &$local_part$& and &$domain$& are not set. -.new Careful enforcement of single-recipient messages -(eg. by responding with defer in the recipient ACL for all recipients +(e.g. by responding with defer in the recipient ACL for all recipients after the first), or the use of PRDR, .cindex "PRDR" "use for per-user SpamAssassin profiles" are needed to use this feature. -.wen The right-hand side of the &%spam%& condition is expanded before being used, so you can put lookups or conditions there. When the right-hand side evaluates to @@ -31280,9 +31161,7 @@ it always return &"true"& by appending &`:true`& to the username. .cindex "spam scanning" "returned variables" When the &%spam%& condition is run, it sets up a number of expansion variables. -.new Except for &$spam_report$&, -.wen these variables are saved with the received message so are available for use at delivery time. @@ -31301,21 +31180,18 @@ The integer value is useful for numeric comparisons in conditions. A string consisting of a number of &"+"& or &"-"& characters, representing the integer part of the spam score value. A spam score of 4.4 would have a &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning -headers, since MUAs can match on such strings. +headers, since MUAs can match on such strings. The maximum length of the +spam bar is 50 characters. .vitem &$spam_report$& A multiline text table, containing the full SpamAssassin report for the message. Useful for inclusion in headers or reject messages. -.new This variable is only usable in a DATA-time ACL. -.wen -.new .vitem &$spam_action$& For SpamAssassin either 'reject' or 'no action' depending on the spam score versus threshold. For Rspamd, the recommended action. -.wen .endlist @@ -31503,9 +31379,7 @@ This is perhaps the most important of the MIME variables. It contains a proposed filename for an attachment, if one was found in either the &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be RFC2047 -.new or RFC2231 -.wen decoded, but no additional sanity checks are done. If no filename was found, this variable contains the empty string. @@ -31596,6 +31470,8 @@ deny message = contains blacklisted regex ($regex_match_string) The conditions returns true if any one of the regular expressions matches. The &$regex_match_string$& expansion variable is then set up and contains the matching regular expression. +The expansion variables &$regex1$& &$regex2$& etc +are set to any substrings captured by the regular expression. &*Warning*&: With large messages, these conditions can be fairly CPU-intensive. @@ -34105,10 +33981,8 @@ failing addresses with their error messages. The third item is used to introduce any text from pipe transports that is to be returned to the sender. It is omitted if there is no such text. .next -.new The fourth, fifth and sixth items will be ignored and may be empty. The fields exist for back-compatibility -.wen .endlist The default state (&%bounce_message_file%& unset) is equivalent to the @@ -35447,11 +35321,12 @@ selection marked by asterisks: &`*etrn `& ETRN commands &`*host_lookup_failed `& as it says &` ident_timeout `& timeout for ident connection -.new &` incoming_interface `& local interface on <= and => lines -.wen &` incoming_port `& remote port on <= lines &`*lost_incoming_connection `& as it says (includes timeouts) +.new +&` outgoing_interface `& local interface on => lines +.wen &` outgoing_port `& add remote port to => lines &`*queue_run `& start and end queue runs &` queue_time `& time on queue for one recipient @@ -35467,16 +35342,14 @@ selection marked by asterisks: &`*size_reject `& rejection because too big &`*skip_delivery `& delivery skipped in a queue run &`*smtp_confirmation `& SMTP confirmation on => lines -&` smtp_connection `& SMTP connections +&` smtp_connection `& incoming SMTP connections &` smtp_incomplete_transaction`& incomplete SMTP transactions &` smtp_mailauth `& AUTH argument to MAIL commands &` smtp_no_mail `& session with no MAIL commands &` smtp_protocol_error `& SMTP protocol errors &` smtp_syntax_error `& SMTP syntax errors &` subject `& contents of &'Subject:'& on <= lines -.new &`*tls_certificate_verified `& certificate verification status -.wen &`*tls_cipher `& TLS cipher suite on <= and => lines &` tls_peerdn `& TLS peer DN on <= and => lines &` tls_sni `& TLS SNI on <= lines @@ -35484,6 +35357,9 @@ selection marked by asterisks: &` all `& all of the above .endd +See also the &%slow_lookup_log%& main configuration option, +section &<>& + More details on each of these items follows: .ilist @@ -35576,10 +35452,10 @@ client's ident port times out. &%incoming_interface%&: The interface on which a message was received is added to the &"<="& line as an IP address in square brackets, tagged by I= and followed by a colon and the port number. The local interface and port are also -added to other SMTP log lines, for example &"SMTP connection from"& and to -rejection lines +added to other SMTP log lines, for example &"SMTP connection from"&, to +rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines. .new -and (despite the name) the local interface is added to &"=>"& lines.. +The latter can be disabled by turning off the &%outgoing_interface%& option. .wen .next .cindex "log" "incoming remote port" @@ -35598,13 +35474,30 @@ important with the widening use of NAT (see RFC 2505). &%lost_incoming_connection%&: A log line is written when an incoming SMTP connection is unexpectedly dropped. .next +.cindex "log" "outgoing interface" +.cindex "log" "local interface" +.cindex "log" "local address and port" +.cindex "TCP/IP" "logging local address and port" +.cindex "interface" "logging" +.new +&%outgoing_interface%&: If &%incoming_interface%& is turned on, then the +interface on which a message was sent is added to delivery lines as an I= tag +followed by IP address in square brackets. You can disable this by turning +off the &%outgoing_interface%& option. +.wen +.next .cindex "log" "outgoing remote port" .cindex "port" "logging outgoint remote" .cindex "TCP/IP" "logging ougtoing remote port" &%outgoing_port%&: The remote port number is added to delivery log lines (those -containing => tags) following the IP address. This option is not included in -the default setting, because for most ordinary configurations, the remote port -number is always 25 (the SMTP port). +containing => tags) following the IP address. +.new +The local port is also added if &%incoming_interface%& and +&%outgoing_interface%& are both enabled. +.wen +This option is not included in the default setting, because for most ordinary +configurations, the remote port number is always 25 (the SMTP port), and the +local port is a random ephemeral port. .next .cindex "log" "process ids in" .cindex "pid (process id)" "in log lines" @@ -35695,7 +35588,7 @@ response. .next .cindex "log" "SMTP connections" .cindex "SMTP" "logging connections" -&%smtp_connection%&: A log line is written whenever an SMTP connection is +&%smtp_connection%&: A log line is written whenever an incoming SMTP connection is established or closed, unless the connection is from a host that matches &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies only when the closure is unexpected.) This applies to connections from local @@ -35744,7 +35637,7 @@ C=EHLO,QUIT shows that the client issued QUIT straight after EHLO. If there were fewer than 20 commands, they are all listed. If there were more than 20 commands, the last 20 are listed, preceded by &"..."&. However, with the default -setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case +setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case have been aborted before 20 non-mail commands are processed. .next &%smtp_mailauth%&: A third subfield with the authenticated sender, @@ -35935,7 +35828,7 @@ tested is enclosed in angle brackets, so you can test for bounce messages with exiqgrep -f '^<>$' .endd .vitem &*-r*&&~<&'regex'&> -Match a recipient address using a case-insensitve search. The field that is +Match a recipient address using a case-insensitive search. The field that is tested is not enclosed in angle brackets. .vitem &*-s*&&~<&'regex'&> @@ -37208,7 +37101,7 @@ Such invocations should be viewed with prejudicial suspicion. Administrators who use embedded Perl are advised to explore how Perl's taint checking might apply to their usage. .next -Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and +Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and administrators are well advised to view its use with suspicion, in case (for instance) it allows a local-part to contain embedded Exim directives. .next @@ -37823,7 +37716,7 @@ Verification of DKIM signatures in incoming email is implemented via the &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each syntactically(!) correct signature in the incoming message. A missing ACL definition defaults to accept. -If any ACL call does not acccept, the message is not accepted. +If any ACL call does not accept, the message is not accepted. If a cutthrough delivery was in progress for the message it is summarily dropped (having wasted the transmission effort). @@ -37887,7 +37780,7 @@ available in &%$dkim_verify_reason%&. &%pass%&: The signature passed verification. It is valid. .endlist .vitem &%$dkim_verify_reason%& -A string giving a litte bit more detail when &%$dkim_verify_status%& is either +A string giving a little bit more detail when &%$dkim_verify_status%& is either "fail" or "invalid". One of .ilist &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public