Merge pull request #30 from SpamExperts/master

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

diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt
index a112ec7e950aa56e5c05fb6a491123d6f3bff001..5f0346e6acaf4e1f824f3e613d24f7b36f9dc190 100644 (file)
--- a/doc/doc-docbook/spec.xfpt
+++ b/doc/doc-docbook/spec.xfpt
@@ -1985,10 +1985,9 @@ Two different types of DNS record for handling IPv6 addresses have been
 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
 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"&. It is not known
-if anyone is actually using A6 records. Exim has support for A6 records, but
-this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
-support has not been tested for some time.
+over-complex, and its status was reduced to &"experimental"&. Exim used to
+have a compile option for including A6 record support but this has now been
+withdrawn.

 
 
 
 
 
 


@@ -6880,8 +6879,8 @@ is used on its own as the result. If the lookup does not succeed, the
 &<<SECTforexpfai>>& for an explanation of what this means.
 
 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, TLSA and TXT,
 &<<SECTforexpfai>>& for an explanation of what this means.
 
 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, TLSA and TXT,

-and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
-configured). If no type is given, TXT is assumed. When the type is PTR,
+and, when Exim is compiled with IPv6 support, AAAA.
+If no type is given, TXT is assumed. When the type is PTR,

 the data can be an IP address, written as normal; inversion and the addition of
 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
 .code
 the data can be an IP address, written as normal; inversion and the addition of
 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
 .code


@@ -6890,8 +6889,7 @@ ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
 If the data for a PTR record is not a syntactically valid IP address, it is not
 altered and nothing is added.
 
 If the data for a PTR record is not a syntactically valid IP address, it is not
 altered and nothing is added.
 

-For any record type, if multiple records are found (or, for A6 lookups, if a
-single record leads to multiple addresses), the data is returned as a
+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,
 depends on the DNS resolver. You can specify a different separator character
 between multiple records by putting a right angle-bracket followed immediately
 concatenation, with newline as the default separator. The order, of course,
 depends on the DNS resolver. You can specify a different separator character
 between multiple records by putting a right angle-bracket followed immediately


@@ -7013,7 +7011,7 @@ The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
 authorization required but absent, or &"?"& for unknown.
 
 .cindex "A+" "in &(dnsdb)& lookup"
 authorization required but absent, or &"?"& for unknown.
 
 .cindex "A+" "in &(dnsdb)& lookup"

-The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
+The pseudo-type A+ performs an AAAA

 and then an A lookup.  All results are returned; defer processing
 (see below) is handled separately for each lookup.  Example:
 .code
 and then an A lookup.  All results are returned; defer processing
 (see below) is handled separately for each lookup.  Example:
 .code


@@ -13290,6 +13288,7 @@ listed in more than one group.
 .row &%acl_smtp_mail%&               "ACL for MAIL"
 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
 .row &%acl_smtp_mime%&               "ACL for MIME parts"
 .row &%acl_smtp_mail%&               "ACL for MAIL"
 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
 .row &%acl_smtp_mime%&               "ACL for MIME parts"

+.row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"

 .row &%acl_smtp_predata%&            "ACL for start of data"
 .row &%acl_smtp_quit%&               "ACL for QUIT"
 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
 .row &%acl_smtp_predata%&            "ACL for start of data"
 .row &%acl_smtp_quit%&               "ACL for QUIT"
 .row &%acl_smtp_rcpt%&               "ACL for RCPT"


@@ -13639,6 +13638,12 @@ 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 &<<SECTscanmimepart>>& for details.
 
 extension. It defines the ACL that is run for each MIME part in a message. See
 section &<<SECTscanmimepart>>& for details.
 

+.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 &<<CHAPACL>>& for further details.
+

 .option acl_smtp_predata main string&!! unset
 This option defines the ACL that is run when an SMTP DATA command is
 received, before the message itself is received. See chapter &<<CHAPACL>>& for
 .option acl_smtp_predata main string&!! unset
 This option defines the ACL that is run when an SMTP DATA command is
 received, before the message itself is received. See chapter &<<CHAPACL>>& for


@@ -17984,6 +17989,9 @@ 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%&.
 
 an address; if such a router is expected to handle "all remaining non-local
 domains", then it is important to set &%no_more%&.
 

+The router will defer rather than decline if the domain
+is found in the &%fail_defer_domains%& router option.
+

 Reasons for a &(dnslookup)& router to decline currently include:
 .ilist
 The domain does not exist in DNS
 Reasons for a &(dnslookup)& router to decline currently include:
 .ilist
 The domain does not exist in DNS


@@ -18069,7 +18077,7 @@ when there is a DNS lookup error.
 .cindex "DNS" "DNSSEC"
 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
 the dnssec request bit set.
 .cindex "DNS" "DNSSEC"
 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
 the dnssec request bit set.

-This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
+This applies to all of the SRV, MX, AAAA, A lookup sequence.

 
 
 
 
 
 


@@ -18081,9 +18089,20 @@ This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
 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.
 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.

-This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
+This applies to all of the SRV, MX, AAAA, A lookup sequence.
+

 
 
 
 

+.option fail_defer_domains dnslookup "domain list&!!" unset
+.cindex "MX record" "not found"
+DNS lookups for domains matching &%fail_defer_domains%&
+which find no matching record will cause the router to defer
+rather than the default behaviour of decline.
+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.
+

 
 .option mx_domains dnslookup "domain list&!!" unset
 .cindex "MX record" "required to exist"
 
 .option mx_domains dnslookup "domain list&!!" unset
 .cindex "MX record" "required to exist"


@@ -23008,7 +23027,7 @@ details.
 .cindex "DNS" "DNSSEC"
 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
 the dnssec request bit set.
 .cindex "DNS" "DNSSEC"
 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
 the dnssec request bit set.

-This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
+This applies to all of the SRV, MX, AAAA, A lookup sequence.

 
 
 
 
 
 


@@ -23020,7 +23039,7 @@ This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
 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.
 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.

-This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
+This applies to all of the SRV, MX, AAAA, A lookup sequence.

 
 
 
 
 
 


@@ -24355,6 +24374,13 @@ 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.
 
 legitimate reasons for this (host died, network died), but if it repeats a lot
 for the same host, it indicates something odd.
 

+.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%&.
+

 .vitem &%refused_MX%&
 A connection to a host obtained from an MX record was refused.
 
 .vitem &%refused_MX%&
 A connection to a host obtained from an MX record was refused.
 


@@ -27107,8 +27133,8 @@ the feature was not requested by the client.
 .cindex "QUIT, ACL for"
 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
 .cindex "QUIT, ACL for"
 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. For this reason, the only verbs that are
-permitted are &%accept%& and &%warn%&.
+does not in fact control any access. For this reason, it may only accept
+or warn as its final result.

 
 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
 
 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


@@ -30829,20 +30855,29 @@ Elements after the first for Unix sockets, or second for TCP socket,
 are options.
 The supported option are:
 .code
 are options.
 The supported option are:
 .code

-variant=rspamd      Use Rspamd rather than SpamAssassin protocol
+pri=<priority>      Selection priority
+weight=<value>      Selection bias

 time=<start>-<end>  Use only between these times of day
 time=<start>-<end>  Use only between these times of day

+retry=<timespec>    Retry on connect fail

 tmo=<timespec>      Connection time limit
 tmo=<timespec>      Connection time limit

-weight=<value>      Selection bias
-backup              Use only if all non-backup servers fail
-retry=<timespec>       Retry on connect fail
+variant=rspamd      Use Rspamd rather than SpamAssassin protocol

 .endd
 
 .endd
 

+The &`pri`& option specifies a priority for the server within the list,
+higher values being tried first.
+The deafult priority is 1.
+
+The &`weight`& option specifies a selection bias.
+Within a priority set
+servers are queried in a random fashion, weighted by this value.
+The default value for selection bias is 1.
+

 Time specifications for the &`time`& option are <hour>.<minute>.<second>
 in the local time zone; each element being one or more digits.
 Either the seconds or both minutes and seconds, plus the leading &`.`&
 characters, may be omitted and will be taken as zero.
 
 Time specifications for the &`time`& option are <hour>.<minute>.<second>
 in the local time zone; each element being one or more digits.
 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 &`tmo`& and &`retry`& options
+Timeout specifications for the &`retry`& and &`tmo`& options

 are the usual Exim time interval standard, eg. &`20s`& or &`1m`&.
 
 The &`tmo`& option specifies an overall timeout for communication.
 are the usual Exim time interval standard, eg. &`20s`& or &`1m`&.
 
 The &`tmo`& option specifies an overall timeout for communication.


@@ -30851,9 +30886,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.
 The &`retry`& option specifies a time after which a single retry for
 a failed connect is made.
 The default is to not retry.

-
-Servers are queried in a random fashion, weighted by the selection bias.
-The default value for selection bias is 1.

 .wen
 
 The &%spamd_address%& variable is expanded before use if it starts with
 .wen
 
 The &%spamd_address%& variable is expanded before use if it starts with