Routers: named variables

[users/jgh/exim.git] / doc / doc-docbook / spec.xfpt

diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt
index bfacdef81e69f5e311acdc2249bc12d05c3aba0d..a073730c61e99427d4b613128c5244fe206c4c5c 100644 (file)
--- a/doc/doc-docbook/spec.xfpt
+++ b/doc/doc-docbook/spec.xfpt
@@ -2626,6 +2626,7 @@ supplementary group is one of those listed in the &%trusted_groups%&
 configuration option. Note that the Exim group is not automatically trusted.
 
 .cindex '&"From"& line'
+.cindex "envelope from"
 .cindex "envelope sender"
 Trusted users are always permitted to use the &%-f%& option or a leading
 &"From&~"& line to specify the envelope sender of a message that is passed to
@@ -2877,6 +2878,7 @@ separate document entitled &'Exim's interfaces to mail filtering'&.
 
 When testing a filter file,
 .cindex "&""From""& line"
+.cindex "envelope from"
 .cindex "envelope sender"
 .oindex "&%-f%&" "for filter testing"
 the envelope sender can be set by the &%-f%& option,
@@ -3717,6 +3719,7 @@ between &%-F%& and the <&'string'&> is optional.
 .cindex "sender" "address"
 .cindex "address" "sender"
 .cindex "trusted users"
+.cindex "envelope from"
 .cindex "envelope sender"
 .cindex "user" "trusted"
 This option sets the address of the envelope sender of a locally-generated
@@ -12756,6 +12759,16 @@ or if not set, the value of &$qualify_domain$&.
 .cindex queues named
 The name of the spool queue in use; empty for the default queue.
 
+.new
+.vitem &$r_...$&
+.vindex &$r_...$&
+.cindex router variables
+Values can be placed in these variables by the &%set%& option of a router.
+They can be given any name that starts with &$r_$&.
+The values persist for the address being handled through subsequent routers
+and the eventual transport.
+.wen
+
 .vitem &$rcpt_count$&
 .vindex "&$rcpt_count$&"
 When a message is being received by SMTP, this variable contains the number of
@@ -14368,6 +14381,7 @@ See also the &'Policy controls'& section above.
 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
+.row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
@@ -15158,6 +15172,11 @@ domain matches this list.
 This is a fudge to help with name servers that give big delays or otherwise do
 not work for the AAAA record type. In due course, when the world's name
 servers have all been upgraded, there should be no need for this option.
+.new
+Note that all lookups, including those done for verification, are affected;
+this will result in verify failure for IPv6 connections or ones using names
+only valid for IPv6 addresses.
+.wen
 
 
 .option dns_retrans main time 0s
@@ -15887,6 +15906,7 @@ and no &'Sender:'& header is ever added. If, in addition, you want to retain
 &'Sender:'& header lines supplied by untrusted users, you must also set
 &%local_sender_retain%& to be true.
 
+.cindex "envelope from"
 .cindex "envelope sender"
 These options affect only the header lines in the message. The envelope sender
 is still forced to be the login id at the qualify domain unless
@@ -16373,6 +16393,19 @@ for each SMTP command and response. When PIPELINING is advertised, Exim assumes
 that clients will use it; &"out of order"& commands that are &"expected"& do
 not count as protocol errors (see &%smtp_max_synprot_errors%&).
 
+.new
+.option pipelining_connect_advertise_hosts main "host list&!!" *
+.cindex "pipelining" "early connection"
+.cindex "pipelining" PIPE_CONNECT
+If Exim is built with the SUPPORT_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.
+When used, the pipelining saves on roundtrip times.
+
+Currently the option name &"X_PIPE_CONNECT"& is used.
+.wen
+
 
 .option prdr_enable main boolean false
 .cindex "PRDR" "enabling on server"
@@ -17904,6 +17937,7 @@ See &%unknown_login%&.
 .cindex "sender" "setting by untrusted user"
 .cindex "untrusted user setting sender"
 .cindex "user" "untrusted setting sender"
+.cindex "envelope from"
 .cindex "envelope sender"
 When an untrusted user submits a message to Exim using the standard input, Exim
 normally creates an envelope sender address from the user's login and the
@@ -18054,6 +18088,10 @@ file = ${extract{mailbox}{$address_data}}
 This makes the configuration file less messy, and also reduces the number of
 lookups (though Exim does cache lookups).
 
+.new
+See also the &%set%& option below.
+.wen
+
 .vindex "&$sender_address_data$&"
 .vindex "&$address_data$&"
 The &%address_data%& facility is also useful as a means of passing information
@@ -18306,6 +18344,7 @@ Not effective on redirect routers.
 
 
 .option errors_to routers string&!! unset
+.cindex "envelope from"
 .cindex "envelope sender"
 .cindex "router" "changing address for errors"
 If a router successfully handles an address, it may assign the address to a
@@ -18967,6 +19006,27 @@ SMTP VRFY command is enabled, it must be used after MAIL if the sender address
 matters.
 
 
+.new
+.option set routers string unset
+.cindex router variables
+This option may be used multiple times on a router.
+Each string given must be of the form $"name = value"$
+and the names used must start with the string &"r_"&.
+Strings are accumulated for each router which is run.
+When a router runs, the strings are evaluated in order,
+to create variables.
+The variable is set with the expansion of the value.
+The variables can be used by the router options
+(not including any preconditions)
+and by the transport.
+Later definitions of a given named variable will override former ones.
+Varible use is via the usual &$r_...$& syntax.
+
+This is similar to the &%address_data%& option, except that
+many independent variables can be used, with choice of naming.
+.wen
+
+
 .option translate_ip_address routers string&!! unset
 .cindex "IP address" "translating"
 .cindex "packet radio"
@@ -21752,6 +21812,7 @@ on a remote transport in the current implementation.
 
 .option return_path transports string&!! unset
 .cindex "envelope sender"
+.cindex "envelope from"
 .cindex "transport" "return path; changing"
 .cindex "return path" "changing in transport"
 If this option is set, the string is expanded at transport time and replaces
@@ -22798,6 +22859,7 @@ percentage.
 
 
 .option use_bsmtp appendfile boolean false
+.cindex "envelope from"
 .cindex "envelope sender"
 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
 format, with the envelope sender and recipient(s) included as SMTP commands. If
@@ -23682,7 +23744,7 @@ inserted in the argument list at that point &'as a separate argument'&. This
 avoids any problems with spaces or shell metacharacters, and is of use when a
 &(pipe)& transport is handling groups of addresses in a batch.
 
-If &%force_command%& is enabled on the transport, Special handling takes place
+If &%force_command%& is enabled on the transport, special handling takes place
 for an argument that consists of precisely the text &`$address_pipe`&.  It
 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
 argument is inserted in the argument list at that point
@@ -24553,6 +24615,30 @@ facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
 Exim will not use the SMTP PIPELINING extension when delivering to any host
 that matches this list, even if the server host advertises PIPELINING support.
 
+.new
+.option hosts_pipe_connect smtp "host list&!!" unset
+.cindex "pipelining" "early connection"
+.cindex "pipelining" PIPE_CONNECT
+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.
+
+The retry hints database is used for the record,
+and records are subject to the &%retry_data_expire%& option.
+When used, the pipelining saves on roundtrip times.
+It also turns SMTP into a client-first protocol
+so combines well with TCP Fast Open.
+
+Note:
+When the facility is used, the transport &%helo_data%& option
+will be expanded before the &$sending_ip_address$& variable
+is filled in.
+A check is made for the use of that variable, without the
+presence of a &"def:"& test on it, but suitably complex coding
+can avoid the check and produce unexpected results.
+You have been warned.
+.wen
+
 
 .option hosts_avoid_tls smtp "host list&!!" unset
 .cindex "TLS" "avoiding for certain hosts"
@@ -25269,6 +25355,7 @@ When an address is being routed, either for delivery or for verification,
 rewriting is applied immediately to child addresses that are generated by
 redirection, unless &%no_rewrite%& is set on the router.
 
+.cindex "envelope from"
 .cindex "envelope sender" "rewriting at transport time"
 .cindex "rewriting" "at transport time"
 .cindex "header lines" "rewriting at transport time"
@@ -30864,7 +30951,7 @@ client host, and its contents have been verified. If there has been no previous
 attempt to verify the HELO/EHLO contents, it is carried out when this
 condition is encountered. See the description of the &%helo_verify_hosts%& and
 &%helo_try_verify_hosts%& options for details of how to request verification
-independently of this condition.
+independently of this condition, and for detail of the verification.
 
 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
 option), this condition is always true.
@@ -34372,6 +34459,7 @@ headers remove "Old-Subject"
 
 
 .section "Setting an errors address in a system filter" "SECID217"
+.cindex "envelope from"
 .cindex "envelope sender"
 In a system filter, if a &%deliver%& command is followed by
 .code
@@ -34605,6 +34693,7 @@ other words, such qualification is also controlled by
 .cindex "sender" "address"
 .oindex "&%uucp_from_pattern%&"
 .oindex "&%uucp_from_sender%&"
+.cindex "envelope from"
 .cindex "envelope sender"
 .cindex "Sendmail compatibility" "&""From""& line"
 Messages that have come from UUCP (and some other applications) often begin
@@ -36053,6 +36142,7 @@ the address, giving a suitable error message.
 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
 .cindex "VERP"
 .cindex "Variable Envelope Return Paths"
+.cindex "envelope from"
 .cindex "envelope sender"
 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
 are a way of helping mailing list administrators discover which subscription
@@ -37380,6 +37470,15 @@ The field is a single "L".
 
 On accept lines, where PIPELINING was offered but not used by the client,
 the field has a minus appended.
+
+.new
+.cindex "pipelining" "early connection"
+If Exim is built with the SUPPORT_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.
+.wen
+
 .next
 .cindex "log" "queue run"
 .cindex "queue runner" "logging"