X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/9bed290e97e67e12c2f56ef06c8f920c0945e432..c2ef5d7e9fc09693770d5d89a6913b47b9d6dbe7:/doc/doc-docbook/spec.xfpt diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt index cf658a46d..7b92a2f21 100644 --- a/doc/doc-docbook/spec.xfpt +++ b/doc/doc-docbook/spec.xfpt @@ -1429,6 +1429,7 @@ check an address given in the SMTP EXPN command (see the &%expn%& option). If the &%domains%& option is set, the domain of the address must be in the set of domains that it defines. .cindex "tainted data" "de-tainting" +.cindex "de-tainting" "using router domains option" A match verifies the variable &$domain$& (which carries tainted data) and assigns an untainted value to the &$domain_data$& variable. Such an untainted value is often needed in the transport. @@ -3707,41 +3708,41 @@ of debugging data, respectively. For example, &%-d+filter%& adds filter debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that no spaces are allowed in the debug setting. The available debugging categories are: -.display -&`acl `& ACL interpretation -&`auth `& authenticators -&`deliver `& general delivery logic -&`dns `& DNS lookups (see also resolver) -&`dnsbl `& DNS black list (aka RBL) code -&`exec `& arguments for &[execv()]& calls -&`expand `& detailed debugging for string expansions -&`filter `& filter handling -&`hints_lookup `& hints data lookups -&`host_lookup `& all types of name-to-IP address handling -&`ident `& ident lookup -&`interface `& lists of local interfaces -&`lists `& matching things in lists -&`load `& system load checks -&`local_scan `& can be used by &[local_scan()]& (see chapter &&& - &<>&) -&`lookup `& general lookup code and all lookups -&`memory `& memory handling -&`noutf8 `& modifier: avoid UTF-8 line-drawing -&`pid `& modifier: add pid to debug output lines -&`process_info `& setting info for the process log -&`queue_run `& queue runs -&`receive `& general message reception logic -&`resolver `& turn on the DNS resolver's debugging output -&`retry `& retry handling -&`rewrite `& address rewriting -&`route `& address routing -&`timestamp `& modifier: add timestamp to debug output lines -&`tls `& TLS logic -&`transport `& transports -&`uid `& changes of uid/gid and looking up uid/gid -&`verify `& address verification logic -&`all `& almost all of the above (see below), and also &%-v%& -.endd +.itable none 0 0 2 1pt left 1pt left +.irow acl "ACL interpretation" +.irow auth "authenticators" +.irow deliver "general delivery logic" +.irow dns "DNS lookups (see also resolver)" +.irow dnsbl "DNS black list (aka RBL) code" +.irow exec "arguments for &[execv()]& calls" +.irow expand "detailed debugging for string expansions" +.irow filter "filter handling" +.irow hints_lookup "hints data lookups" +.irow host_lookup "all types of name-to-IP address handling" +.irow ident "ident lookup" +.irow interface "lists of local interfaces" +.irow lists "matching things in lists" +.irow load "system load checks" +.irow local_scan "can be used by &[local_scan()]& (see chapter &&& + &<>&)" +.irow lookup "general lookup code and all lookups" +.irow memory "memory handling" +.irow noutf8 "modifier: avoid UTF-8 line-drawing" +.irow pid "modifier: add pid to debug output lines" +.irow process_info "setting info for the process log" +.irow queue_run "queue runs" +.irow receive "general message reception logic" +.irow resolver "turn on the DNS resolver's debugging output" +.irow retry "retry handling" +.irow rewrite "address rewriting"" +.irow route "address routing" +.irow timestamp "modifier: add timestamp to debug output lines" +.irow tls "TLS logic" +.irow transport "transports" +.irow uid "changes of uid/gid and looking up uid/gid" +.irow verify "address verification logic" +.irow all "almost all of the above (see below), and also &%-v%&" +.endtable The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it for &`-all`&. The reason for this is that &`+all`& is something that people tend to use when generating debug output for Exim maintainers. If &`+memory`& @@ -6787,6 +6788,7 @@ file that is searched could contain lines like this: When the lookup succeeds, the result of the expansion is a list of domains (and possibly other types of item that are allowed in domain lists). .cindex "tainted data" "de-tainting" +.cindex "de-tainting" "using a lookup expansion"" The result of the expansion is not tainted. In the second example, the lookup is a single item in a domain list. It causes @@ -6843,12 +6845,12 @@ lookup to succeed. The lookup type determines how the file is searched. The file string may not be tainted. .cindex "tainted data" "de-tainting" +.cindex "de-tainting" "using a single-key lookup" All single-key lookups support the option &"ret=key"&. If this is given and the lookup (either underlying implementation or cached value) returns data, the result is replaced with a non-tainted version of the lookup key. -.cindex "tainted data" "de-tainting" .next .cindex "query-style lookup" "definition of" The &'query-style'& type accepts a generalized database query. No particular @@ -7924,16 +7926,16 @@ be preceded by any number of <&'name'&>=<&'value'&> settings, separated by spaces. If a value contains spaces it must be enclosed in double quotes, and when double quotes are used, backslash is interpreted in the usual way inside them. The following names are recognized: -.display -&`DEREFERENCE`& set the dereferencing parameter -&`NETTIME `& set a timeout for a network operation -&`USER `& set the DN, for authenticating the LDAP bind -&`PASS `& set the password, likewise -&`REFERRALS `& set the referrals parameter -&`SERVERS `& set alternate server list for this query only -&`SIZE `& set the limit for the number of entries returned -&`TIME `& set the maximum waiting time for a query -.endd +.itable none 0 0 2 1pt left 1pt left +.irow DEREFERENCE "set the dereferencing parameter" +.irow NETTIME "set a timeout for a network operation" +.irow USER "set the DN, for authenticating the LDAP bind" +.irow PASS "set the password, likewise" +.irow REFERRALS "set the referrals parameter" +.irow SERVERS "set alternate server list for this query only" +.irow SIZE "set the limit for the number of entries returned" +.irow TIME "set the maximum waiting time for a query" +.endtable The value of the DEREFERENCE parameter must be one of the words &"never"&, &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP @@ -8848,6 +8850,7 @@ or a &%domains%& condition in an ACL statement, the value is preserved in the &$domain_data$& variable and can be referred to in other router options or other statements in the same ACL. .cindex "tainted data" "de-tainting" +.cindex "de-tainting" "using ACL domains condition" The value will be untainted. &*Note*&: If the data result of the lookup (as opposed to the key) @@ -8889,6 +8892,7 @@ whether or not the query succeeds. However, when a lookup is used for the &%domains%& option on a router, the value is preserved in the &$domain_data$& variable and can be referred to in other options. .cindex "tainted data" "de-tainting" +.cindex "de-tainting" "using router domains option" The value will be untainted. .next @@ -11630,14 +11634,14 @@ condition. .cindex "expansion" "numeric comparison" There are a number of symbolic operators for doing numeric comparisons. They are: -.display -&`= `& equal -&`== `& equal -&`> `& greater -&`>= `& greater or equal -&`< `& less -&`<= `& less or equal -.endd +.itable none 0 0 2 1pt left 1pt left +.irow "= " "equal" +.irow "== " "equal" +.irow "> " "greater" +.irow ">= " "greater or equal" +.irow "< " "less" +.irow "<= " "less or equal" +.endtable For example: .code ${if >{$message_size}{10M} ... @@ -11940,6 +11944,7 @@ ${if inlisti{Needle}{fOo:NeeDLE:bAr}} The variable &$value$& will be set for a successful match and can be used in the success clause of an &%if%& expansion item using the condition. .cindex "tainted data" "de-tainting" +.cindex "de-tainting" "using an inlist expansion condition" It will have the same taint status as the list; expansions such as .code ${if inlist {$h_mycode:} {0 : 1 : 42} {$value}} @@ -12149,6 +12154,7 @@ caselessly. The variable &$value$& will be set for a successful match and can be used in the success clause of an &%if%& expansion item using the condition. .cindex "tainted data" "de-tainting" +.cindex "de-tainting" "using a match_local_part expansion condition" It will have the same taint status as the list; expansions such as .code ${if match_local_part {$local_part} {alice : bill : charlotte : dave} {$value}} @@ -12530,9 +12536,10 @@ command that does not succeed. Otherwise it is set to &"0"&. This makes it possible to distinguish between &"did not try to authenticate"& (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$& -is empty and &$authentication_failed$& is set to &"1"&). Failure includes any -negative response to an AUTH command, including (for example) an attempt to use -an undefined mechanism. +is empty and &$authentication_failed$& is set to &"1"&). +Failure includes cancellation of a authentication attempt, +and any negative response to an AUTH command, +(including, for example, an attempt to use an undefined mechanism). .vitem &$av_failed$& .cindex "content scanning" "AV scanner failure" @@ -14891,6 +14898,7 @@ listed in more than one group. .row &%gnutls_compat_mode%& "use GnuTLS compatibility mode" .row &%gnutls_allow_auto_pkcs11%& "allow GnuTLS to autoload PKCS11 modules" .row &%hosts_require_alpn%& "mandatory ALPN" +.row &%hosts_require_helo%& "mandatory HELO/EHLO" .row &%openssl_options%& "adjust OpenSSL compatibility options" .row &%tls_advertise_hosts%& "advertise TLS to these hosts" .row &%tls_alpn%& "acceptable protocol names" @@ -16394,6 +16402,12 @@ See also the &%tls_alpn%& option. managed by this option, and should be done separately. +.option hosts_require_helo main "host list&!!" * +.cindex "HELO/EHLO" requiring +Exim will require an accepted HELO or EHLO command from a host matching +this list, before accepting a MAIL command. + + .option hosts_proxy main "host list&!!" unset .cindex proxy "proxy protocol" This option enables use of Proxy Protocol proxies for incoming @@ -17122,9 +17136,9 @@ not count as protocol errors (see &%smtp_max_synprot_errors%&). .option pipelining_connect_advertise_hosts main "host list&!!" * .cindex "pipelining" "early connection" -.cindex "pipelining" PIPE_CONNECT -.cindex "ESMTP extensions" PIPE_CONNECT -If Exim is built with the SUPPORT_PIPE_CONNECT build option +.cindex "pipelining" PIPECONNECT +.cindex "ESMTP extensions" PIPECONNECT +If Exim is built without the DISABLE_PIPE_CONNECT build option this option controls which hosts the facility is advertised to and from which pipeline early-connection (before MAIL) SMTP commands are acceptable. @@ -17132,7 +17146,11 @@ When used, the pipelining saves on roundtrip times. See also the &%hosts_pipe_connect%& smtp transport option. -The SMTP service extension keyword advertised is &"PIPE_CONNECT"&. +The SMTP service extension keyword advertised is &"PIPECONNECT"&; +it permits the client to pipeline +TCP connection and hello command (inclear phase), +or TLS-establishment and hello command (encrypted phase), +on later connections to the same host. .option prdr_enable main boolean false @@ -19033,6 +19051,7 @@ than trying to read &_/etc/passwd_& directly. This means that other methods of holding password data (such as NIS) are supported. If the local part is a local user, .cindex "tainted data" "de-tainting" +.cindex "de-tainting" "using router check_local_user option" &$local_part_data$& is set to an untainted version of the local part and &$home$& is set from the password data. The latter can be tested in other preconditions that are evaluated after this one (the order of evaluation is @@ -23305,6 +23324,7 @@ The value is used for checking instead of a home directory; checking is done in "belowhome" mode. .cindex "tainted data" "de-tainting" +.cindex "de-tainting" "using appendfile create_file option" If "belowhome" checking is used, the file or directory path becomes de-tainted. @@ -25633,7 +25653,7 @@ that matches this list, even if the server host advertises PIPELINING support. .option hosts_pipe_connect smtp "host list&!!" unset .cindex "pipelining" "early connection" -.cindex "pipelining" PIPE_CONNECT +.cindex "pipelining" PIPECONNECT If Exim is built with the SUPPORT_PIPE_CONNECT build option this option controls which to hosts the facility watched for and recorded, and used for subsequent connections. @@ -25783,11 +25803,6 @@ There will be no fallback to in-clear communication. See the &%dnssec_request_domains%& router and transport options. See section &<>&. -.option hosts_require_helo smtp "host list&!!" * -.cindex "HELO/EHLO" requiring -Exim will require an accepted HELO or EHLO command from a host matching -this list, before accepting a MAIL command. - .option hosts_require_ocsp smtp "host list&!!" unset .cindex "TLS" "requiring for certain servers" Exim will request, and check for a valid Certificate Status being given, on a @@ -31708,6 +31723,8 @@ with &`-d`&, with the output going to a new logfile in the usual logs directory, by default called &'debuglog'&. .new +Logging set up by the control will be maintained across spool residency. + Options are a slash-separated list. If an option takes an argument, the option name and argument are separated by an equals character. @@ -32649,11 +32666,11 @@ This is usually the required action when &%dnslists%& is used with &%deny%& (which is the most common usage), because it prevents a DNS failure from blocking mail. However, you can change this behaviour by putting one of the following special items in the list: -.display -&`+include_unknown `& behave as if the item is on the list -&`+exclude_unknown `& behave as if the item is not on the list (default) -&`+defer_unknown `& give a temporary error -.endd +.itable none 0 0 2 1pt left 1pt left +.irow "+include_unknown" "behave as if the item is on the list" +.irow "+exclude_unknown" "behave as if the item is not on the list (default)" +.irow "+defer_unknown " "give a temporary error" +.endtable .cindex "&`+include_unknown`&" .cindex "&`+exclude_unknown`&" .cindex "&`+defer_unknown`&" @@ -32802,15 +32819,15 @@ DNS lists are constructed using address records in the DNS. The original RBL just used the address 127.0.0.1 on the right hand side of each record, but the RBL+ list and some other lists use a number of values with different meanings. The values used on the RBL+ list are: -.display -127.1.0.1 RBL -127.1.0.2 DUL -127.1.0.3 DUL and RBL -127.1.0.4 RSS -127.1.0.5 RSS and RBL -127.1.0.6 RSS and DUL -127.1.0.7 RSS and DUL and RBL -.endd +.itable none 0 0 2 1pt left 1pt left +.irow 127.1.0.1 "RBL" +.irow 127.1.0.2 "DUL" +.irow 127.1.0.3 "DUL and RBL" +.irow 127.1.0.4 "RSS" +.irow 127.1.0.5 "RSS and RBL" +.irow 127.1.0.6 "RSS and DUL" +.irow 127.1.0.7 "RSS and DUL and RBL" +.endtable Section &<>& below describes how you can distinguish between different values. Some DNS lists may return more than one address record; see section &<>& for details of how they are checked. @@ -33612,6 +33629,15 @@ output before performing a callout in an ACL, to avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in use. The flushing can be disabled by using a &%control%& modifier to set &%no_callout_flush%&. +.new +.cindex "tainted data" "de-tainting" +.cindex "de-tainting" "using receipient verify" +A recipient callout which gets a 2&'xx'& code +will assign untainted values to the +&$domain_data$& and &$local_part_data$& variables, +corresponding to the domain and local parts of the recipient address. +.wen + @@ -35725,11 +35751,11 @@ added zero byte is not included in the returned count. .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*& This function checks for a match in a domain list. Domains are always matched caselessly. The return value is one of the following: -.display -&`OK `& match succeeded -&`FAIL `& match failed -&`DEFER `& match deferred -.endd +.itable none 0 0 2 1pt left 1pt left +.irow &`OK`& "match succeeded" +.irow &`FAIL`& "match failed" +.irow &`DEFER`& "match deferred" +.endtable DEFER is usually caused by some kind of lookup defer, such as the inability to contact a database. @@ -38436,7 +38462,7 @@ LOG_FILE_PATH, and uses the first item it finds that is neither empty nor &"syslog"&. This means that an empty item in &%log_file_path%& can be used to mean &"use the path specified at build time"&. If no such item exists, log files are written in the &_log_& subdirectory of the spool directory. This is -equivalent to the setting: +equivalent to the configuration file setting: .code log_file_path = $spool_directory/log/%slog .endd @@ -38447,7 +38473,7 @@ that is where the logs are written. A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames are in use &-- see section &<>& below. -Here are some examples of possible settings: +Here are some examples of possible Makefile settings: .display &`LOG_FILE_PATH=syslog `& syslog only &`LOG_FILE_PATH=:syslog `& syslog and default path @@ -38622,16 +38648,16 @@ One line is written to the main log for each message received, and for each successful, unsuccessful, and delayed delivery. These lines can readily be picked out by the distinctive two-character flags that immediately follow the timestamp. The flags are: -.display -&`<=`& message arrival -&`(=`& message fakereject -&`=>`& normal message delivery -&`->`& additional address in same delivery -&`>>`& cutthrough message delivery -&`*>`& delivery suppressed by &%-N%& -&`**`& delivery failed; address bounced -&`==`& delivery deferred; temporary problem -.endd +.itable none 0 0 2 1pt left 1pt left +.irow &%<=%& "message arrival" +.irow &%(=%& "message fakereject" +.irow &%=>%& "normal message delivery" +.irow &%->%& "additional address in same delivery" +.irow &%>>%& "cutthrough message delivery" +.irow &%*>%& "delivery suppressed by &%-N%&" +.irow &%**%& "delivery failed; address bounced" +.irow &%==%& "delivery deferred; temporary problem" +.endtable .section "Logging message reception" "SECID251" @@ -38950,65 +38976,64 @@ log_selector = +arguments -retry_defer .endd The list of optional log items is in the following table, with the default selection marked by asterisks: -.display -&` 8bitmime `& received 8BITMIME status -&`*acl_warn_skipped `& skipped &%warn%& statement in ACL -&` address_rewrite `& address rewriting -&` all_parents `& all parents in => lines -&` arguments `& command line arguments -&`*connection_reject `& connection rejections -&`*delay_delivery `& immediate delivery delayed -&` deliver_time `& time taken to attempt delivery -&` delivery_size `& add &`S=`&&'nnn'& to => lines -&`*dkim `& DKIM verified domain on <= lines -&` dkim_verbose `& separate full DKIM verification result line, per signature -&`*dnslist_defer `& defers of DNS list (aka RBL) lookups -&` dnssec `& DNSSEC secured lookups -&`*etrn `& ETRN commands -&`*host_lookup_failed `& as it says -&` ident_timeout `& timeout for ident connection -&` incoming_interface `& local interface on <= and => lines -&` incoming_port `& remote port on <= lines -&`*lost_incoming_connection `& as it says (includes timeouts) -&` millisec `& millisecond timestamps and RT,QT,DT,D times -&`*msg_id `& on <= lines, Message-ID: header value -&` msg_id_created `& on <= lines, Message-ID: header value when one had to be added -&` outgoing_interface `& local interface on => lines -&` outgoing_port `& add remote port to => lines -&`*queue_run `& start and end queue runs -&` queue_time `& time on queue for one recipient -&`*queue_time_exclusive `& exclude recieve time from QT times -&` queue_time_overall `& time on queue for whole message -&` pid `& Exim process id -&` pipelining `& PIPELINING use, on <= and => lines -&` proxy `& proxy address on <= and => lines -&` receive_time `& time taken to receive message -&` received_recipients `& recipients on <= lines -&` received_sender `& sender on <= lines -&`*rejected_header `& header contents on reject log -&`*retry_defer `& &"retry time not reached"& -&` return_path_on_delivery `& put return path on => and ** lines -&` sender_on_delivery `& add sender to => lines -&`*sender_verify_fail `& sender verification failures -&`*size_reject `& rejection because too big -&`*skip_delivery `& delivery skipped in a queue run -&`*smtp_confirmation `& SMTP confirmation on => lines -&` 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 -&`*tls_certificate_verified `& certificate verification status -&`*tls_cipher `& TLS cipher suite on <= and => lines -&` tls_peerdn `& TLS peer DN on <= and => lines -&` tls_resumption `& append * to cipher field -&` tls_sni `& TLS SNI on <= lines -&` unknown_in_list `& DNS lookup failed in list match - -&` all `& all of the above -.endd +.itable none 0 0 3 1pt left 10pt center 1pt left +.irow &`8bitmime`&   "received 8BITMIME status" +.irow &`acl_warn_skipped`& * "skipped &%warn%& statement in ACL" +.irow &`address_rewrite`&   "address rewriting" +.irow &`all_parents`&   "all parents in => lines" +.irow &`arguments`&   "command line arguments" +.irow &`connection_reject`& * "connection rejections" +.irow &`delay_delivery`& * "immediate delivery delayed" +.irow &`deliver_time`&   "time taken to attempt delivery" +.irow &`delivery_size`&   "add &`S=`&&'nnn'& to => lines" +.irow &`dkim`& * "DKIM verified domain on <= lines" +.irow &`dkim_verbose`&   "separate full DKIM verification result line, per signature" +.irow &`dnslist_defer`& * "defers of DNS list (aka RBL) lookups" +.irow &`dnssec`&   "DNSSEC secured lookups" +.irow &`etrn`& * "ETRN commands" +.irow &`host_lookup_failed`& * "as it says" +.irow &`ident_timeout`&   "timeout for ident connection" +.irow &`incoming_interface`&   "local interface on <= and => lines" +.irow &`incoming_port`&   "remote port on <= lines" +.irow &`lost_incoming_connection`& * "as it says (includes timeouts)" +.irow &`millisec`&   "millisecond timestamps and RT,QT,DT,D times" +.irow &`msg_id`& * "on <= lines, Message-ID: header value" +.irow &`msg_id_created`&   "on <= lines, Message-ID: header value when one had to be added" +.irow &`outgoing_interface`&   "local interface on => lines" +.irow &`outgoing_port`&   "add remote port to => lines" +.irow &`queue_run`& * "start and end queue runs" +.irow &`queue_time`&   "time on queue for one recipient" +.irow &`queue_time_exclusive`&   "exclude recieve time from QT times" +.irow &`queue_time_overall`&   "time on queue for whole message" +.irow &`pid`&   "Exim process id" +.irow &`pipelining`&   "PIPELINING use, on <= and => lines" +.irow &`proxy`&   "proxy address on <= and => lines" +.irow &`receive_time`&   "time taken to receive message" +.irow &`received_recipients`&   "recipients on <= lines" +.irow &`received_sender`&   "sender on <= lines" +.irow &`rejected_header`& * "header contents on reject log" +.irow &`retry_defer`& * "&&retry time not reached&&" +.irow &`return_path_on_delivery`&   "put return path on => and ** lines" +.irow &`sender_on_delivery`&   "add sender to => lines" +.irow &`sender_verify_fail`& * "sender verification failures" +.irow &`size_reject`& * "rejection because too big" +.irow &`skip_delivery`& * "delivery skipped in a queue run" +.irow &`smtp_confirmation`& * "SMTP confirmation on => lines" +.irow &`smtp_connection`&   "incoming SMTP connections" +.irow &`smtp_incomplete_transaction`&   "incomplete SMTP transactions" +.irow &`smtp_mailauth`&   "AUTH argument to MAIL commands" +.irow &`smtp_no_mail`&   "session with no MAIL commands" +.irow &`smtp_protocol_error`&   "SMTP protocol errors" +.irow &`smtp_syntax_error`&   "SMTP syntax errors" +.irow &`subject`&   "contents of &'Subject:'& on <= lines" +.irow &`tls_certificate_verified`& * "certificate verification status" +.irow &`tls_cipher`& * "TLS cipher suite on <= and => lines" +.irow &`tls_peerdn`&   "TLS peer DN on <= and => lines" +.irow &`tls_resumption`&   "append * to cipher field" +.irow &`tls_sni`&   "TLS SNI on <= lines" +.irow &`unknown_in_list`&   "DNS lookup failed in list match" +.irow &`all`&   "&*all of the above*&" +.endtable See also the &%slow_lookup_log%& main configuration option, section &<>& @@ -39204,7 +39229,7 @@ On accept lines, where PIPELINING was offered but not used by the client, the field has a minus appended. .cindex "pipelining" "early connection" -If Exim is built with the SUPPORT_PIPE_CONNECT build option +If Exim is built without the DISABLE_PIPE_CONNECT build option accept "L" fields have a period appended if the feature was offered but not used, or an asterisk appended if used. Delivery "L" fields have an asterisk appended if used. @@ -39506,12 +39531,12 @@ but the format of the output is different. For this reason, there are some system configuration options that configure exactly how &'exiwhat'& works. If it doesn't seem to be working for you, check the following compile-time options: -.display -&`EXIWHAT_PS_CMD `& the command for running &'ps'& -&`EXIWHAT_PS_ARG `& the argument for &'ps'& -&`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output -&`EXIWHAT_KILL_ARG `& the argument for the &'kill'& command -.endd +.itable none 0 0 2 1pt left 1pt left +.irow &`EXIWHAT_PS_CMD`& "the command for running &'ps'&" +.irow &`EXIWHAT_PS_ARG`& "the argument for &'ps'&" +.irow &`EXIWHAT_EGREP_ARG`& "the argument for &'egrep'& to select from &'ps'& output" +.irow &`EXIWHAT_KILL_ARG`& "the argument for the &'kill'& command" +.endtable An example of typical output from &'exiwhat'& is .code 164 daemon: -q1h, listening on port 25 @@ -42146,6 +42171,9 @@ There is no need to periodically change this key; a timestamp is also encoded. The second argument should be given as the envelope sender address before this encoding operation. +.new +If this value is empty the the expansion result will be empty. +.wen The third argument should be the recipient domain of the message when it arrived at this system. .endlist @@ -42319,16 +42347,16 @@ The &"dmarc_status"& condition takes a list of strings on its right-hand side. These strings describe recommended action based on the DMARC check. To understand what the policy recommendations mean, refer to the DMARC website above. Valid strings are: -.display -&'accept '& The DMARC check passed and the library recommends accepting the email. -&'reject '& The DMARC check failed and the library recommends rejecting the email. -&'quarantine '& The DMARC check failed and the library recommends keeping it for further inspection. -&'none '& The DMARC check passed and the library recommends no specific action, neutral. -&'norecord '& No policy section in the DMARC record for this RFC5322.From field -&'nofrom '& Unable to determine the domain of the sender. -&'temperror '& Library error or dns error. -&'off '& The DMARC check was disabled for this email. -.endd +.itable none 0 0 2 1pt left 1pt left +.irow &'accept'& "The DMARC check passed and the library recommends accepting the email" +.irow &'reject'& "The DMARC check failed and the library recommends rejecting the email" +.irow &'quarantine'& "The DMARC check failed and the library recommends keeping it for further inspection" +.irow &'none'& "The DMARC check passed and the library recommends no specific action, neutral" +.irow &'norecord'& "No policy section in the DMARC record for this RFC5322.From field" +.irow &'nofrom'& "Unable to determine the domain of the sender" +.irow &'temperror'& "Library error or dns error" +.irow &'off'& "The DMARC check was disabled for this email" +.endtable You can prefix each string with an exclamation mark to invert its meaning, for example "!accept" will match all results but "accept". The string list is evaluated left-to-right in a @@ -42494,13 +42522,13 @@ within &%proxy_protocol_timeout%&, which defaults to 3s. The following expansion variables are usable (&"internal"& and &"external"& here refer to the interfaces of the proxy): -.display -&'proxy_external_address '& IP of host being proxied or IP of remote interface of proxy -&'proxy_external_port '& Port of host being proxied or Port on remote interface of proxy -&'proxy_local_address '& IP of proxy server inbound or IP of local interface of proxy -&'proxy_local_port '& Port of proxy server inbound or Port on local interface of proxy -&'proxy_session '& boolean: SMTP connection via proxy -.endd +.itable none 0 0 2 1pt left 1pt left +.irow $proxy_external_address "IP of host being proxied or IP of remote interface of proxy" +.irow $proxy_external_port "Port of host being proxied or Port on remote interface of proxy" +.irow $proxy_local_address "IP of proxy server inbound or IP of local interface of proxy" +.irow $proxy_local_port "Port of proxy server inbound or Port on local interface of proxy" +.irow $proxy_session "boolean: SMTP connection via proxy" +.endtable If &$proxy_session$& is set but &$proxy_external_address$& is empty there was a protocol error. The variables &$sender_host_address$& and &$sender_host_port$& @@ -42547,15 +42575,15 @@ is an IP address and any subsequent elements are options. Options are a string =. The list of options is in the following table: -.display -&'auth '& authentication method -&'name '& authentication username -&'pass '& authentication password -&'port '& tcp port -&'tmo '& connection timeout -&'pri '& priority -&'weight '& selection bias -.endd +.itable none 0 0 2 1pt left 1pt left +.irow &'auth'& "authentication method" +.irow &'name'& "authentication username" +.irow &'pass'& "authentication password" +.irow &'port'& "tcp port" +.irow &'tmo'& "connection timeout" +.irow &'pri'& "priority" +.irow &'weight'& "selection bias" +.endtable More details on each of these options follows: @@ -42671,11 +42699,11 @@ This is usually for use in a Message Submission Agent context, but could be used for any message. If a value is appended it may be: -.display -&`1 `& mandatory downconversion -&`0 `& no downconversion -&`-1 `& if SMTPUTF8 not supported by destination host -.endd +.itable none 0 0 2 1pt right 1pt left +.irow &`1`& "mandatory downconversion" +.irow &`0`& "no downconversion" +.irow &`-1`& "if SMTPUTF8 not supported by destination host" +.endtable If no value is given, 1 is used. If mua_wrapper is set, the utf8_downconvert control @@ -42777,23 +42805,23 @@ expansion must check this, as it will be called for every possible event type. .new The current list of events is: -.display -&`dane:fail after transport `& per connection -&`msg:complete after main `& per message -&`msg:defer after transport `& per message per delivery try -&`msg:delivery after transport `& per recipient -&`msg:rcpt:host:defer after transport `& per recipient per host -&`msg:rcpt:defer after transport `& per recipient -&`msg:host:defer after transport `& per host per delivery try; host errors -&`msg:fail:delivery after transport `& per recipient -&`msg:fail:internal after main `& per recipient -&`tcp:connect before transport `& per connection -&`tcp:close after transport `& per connection -&`tls:cert before both `& per certificate in verification chain -&`tls:fail:connect after main `& per connection -&`smtp:connect after transport `& per connection -&`smtp:ehlo after transport `& per connection -.endd +.itable all 0 0 4 1pt left 1pt center 1pt center 1pt left +.irow dane:fail after transport "per connection" +.irow msg:complete after main "per message" +.irow msg:defer after transport "per message per delivery try" +.irow msg:delivery after transport "per recipient" +.irow msg:rcpt:host:defer after transport "per recipient per host" +.irow msg:rcpt:defer after transport "per recipient" +.irow msg:host:defer after transport "per host per delivery try; host errors" +.irow msg:fail:delivery after transport "per recipient" +.irow msg:fail:internal after main "per recipient" +.irow tcp:connect before transport "per connection" +.irow tcp:close after transport "per connection" +.irow tls:cert before both "per certificate in verification chain" +.irow tls:fail:connect after main "per connection" +.irow smtp:connect after transport "per connection" +.irow smtp:ehlo after transport "per connection" +.endtable .wen New event types may be added in future. @@ -42810,24 +42838,24 @@ should define the event action. An additional variable, &$event_data$&, is filled with information varying with the event type: -.display -&`dane:fail `& failure reason -&`msg:defer `& error string -&`msg:delivery `& smtp confirmation message -&`msg:fail:internal `& failure reason -&`msg:fail:delivery `& smtp error message -&`msg:host:defer `& error string -&`msg:rcpt:host:defer `& error string -&`msg:rcpt:defer `& error string -&`tls:cert `& verification chain depth -&`tls:fail:connect `& error string -&`smtp:connect `& smtp banner -&`smtp:ehlo `& smtp ehlo response -.endd +.itable all 0 0 2 1pt left 1pt left +.irow dane:fail "failure reason" +.irow msg:defer "error string" +.irow msg:delivery "smtp confirmation message" +.irow msg:fail:internal "failure reason" +.irow msg:fail:delivery "smtp error message" +.irow msg:host:defer "error string" +.irow msg:rcpt:host:defer "error string" +.irow msg:rcpt:defer "error string" +.irow tls:cert "verification chain depth" +.irow tls:fail:connect "error string" +.irow smtp:connect "smtp banner" +.irow smtp:ehlo "smtp ehlo response" +.endtable The :defer events populate one extra variable: &$event_defer_errno$&. -For complex operations an ACL expansion can be used in &%event_action%& +For complex operations an ACL expansion can be used in &%event_action%&, however due to the multiple contexts that Exim operates in during the course of its processing: .ilist @@ -42843,11 +42871,11 @@ a useful way of writing to the main log. The expansion of the event_action option should normally return an empty string. Should it return anything else the following will be forced: -.display -&`tcp:connect `& do not connect -&`tls:cert `& refuse verification -&`smtp:connect `& close connection -.endd +.itable all 0 0 2 1pt left 1pt left +.irow tcp:connect "do not connect" +.irow tls:cert "refuse verification" +.irow smtp:connect "close connection" +.endtable All other message types ignore the result string, and no other use is made of it.