Docs: clarify client-side auth options for smtp transport
[users/heiko/exim.git] / doc / doc-txt / experimental-spec.txt
index 145fc42daa58ef348924203e40c4d1c3b80dde43..47cd93f3d94f4c9330119047521487b276380144 100644 (file)
@@ -1,14 +1,12 @@
-$Cambridge: exim/doc/doc-txt/experimental-spec.txt,v 1.1 2005/01/11 10:51:15 ph10 Exp $
+From time to time, experimental features may be added to Exim.
+While a feature  is experimental, there  will be a  build-time
+option whose name starts  "EXPERIMENTAL_" that must be  set in
+order to include the  feature. This file contains  information
+about experimental  features, all  of which  are unstable and
+liable to incompatible change.
 
 
-From time to time, experimental features may be added to Exim. 
-While a feature is experimental, there will be a build-time 
-option whose name starts "EXPERIMENTAL_" that must be set in
-order to include the feature. This file contains information
-about experimenatal features, all of which are unstable and
-liable to incompatibile change.
 
 
-
-1. Brighmail AntiSpam (BMI) suppport
+Brightmail AntiSpam (BMI) support
 --------------------------------------------------------------
 
 Brightmail  AntiSpam  is  a  commercial  package.  Please  see
 --------------------------------------------------------------
 
 Brightmail  AntiSpam  is  a  commercial  package.  Please  see
@@ -32,35 +30,35 @@ instead  of per-message.  To use  BMI, you  need to  take the
 following steps:
 
   1) Compile Exim with BMI support
 following steps:
 
   1) Compile Exim with BMI support
-  2) Set up main BMI options (top section of exim config file)
+  2) Set up main BMI options (top section of Exim config file)
   3) Set up ACL control statement (ACL section of the config
      file)
   4) Set up your routers to use BMI verdicts (routers section
      of the config file).
   5) (Optional) Set up per-recipient opt-in information.
 
   3) Set up ACL control statement (ACL section of the config
      file)
   4) Set up your routers to use BMI verdicts (routers section
      of the config file).
   5) (Optional) Set up per-recipient opt-in information.
 
-These four steps are explained in more details below. 
+These four steps are explained in more details below.
 
 1) Adding support for BMI at compile time
 
   To compile with BMI support,  you need to link Exim  against
 
 1) Adding support for BMI at compile time
 
   To compile with BMI support,  you need to link Exim  against
-  the   Brighmail  client   SDK,  consisting   of  a   library
+  the  Brightmail  client   SDK,  consisting   of  a   library
   (libbmiclient_single.so)  and  a  header  file  (bmi_api.h).
   You'll also need to explicitly set a flag in the Makefile to
   include BMI support in the Exim binary. Both can be achieved
   with  these lines in Local/Makefile:
 
   EXPERIMENTAL_BRIGHTMAIL=yes
   (libbmiclient_single.so)  and  a  header  file  (bmi_api.h).
   You'll also need to explicitly set a flag in the Makefile to
   include BMI support in the Exim binary. Both can be achieved
   with  these lines in Local/Makefile:
 
   EXPERIMENTAL_BRIGHTMAIL=yes
-  CFLAGS=-DBRIGHTMAIL -I/path/to/the/dir/with/the/includefile
+  CFLAGS=-I/path/to/the/dir/with/the/includefile
   EXTRALIBS_EXIM=-L/path/to/the/dir/with/the/library -lbmiclient_single
   EXTRALIBS_EXIM=-L/path/to/the/dir/with/the/library -lbmiclient_single
-  
+
   If  you use  other CFLAGS  or EXTRALIBS_EXIM  settings then
   merge the content of these lines with them.
 
   Note for BMI6.x users: You'll also have to add -lxml2_single
   to the EXTRALIBS_EXIM line. Users of 5.5x do not need to  do
   this.
   If  you use  other CFLAGS  or EXTRALIBS_EXIM  settings then
   merge the content of these lines with them.
 
   Note for BMI6.x users: You'll also have to add -lxml2_single
   to the EXTRALIBS_EXIM line. Users of 5.5x do not need to  do
   this.
-  
+
   You    should     also    include     the    location     of
   libbmiclient_single.so in your dynamic linker  configuration
   file   (usually   /etc/ld.so.conf)   and   run    "ldconfig"
   You    should     also    include     the    location     of
   libbmiclient_single.so in your dynamic linker  configuration
   file   (usually   /etc/ld.so.conf)   and   run    "ldconfig"
@@ -68,22 +66,22 @@ These four steps are explained in more details below.
   able to find the library file.
 
 
   able to find the library file.
 
 
-2) Setting up BMI support in the exim main configuration
+2) Setting up BMI support in the Exim main configuration
 
 
-  To enable BMI  support in the  main exim configuration,  you
+  To enable BMI  support in the  main Exim configuration,  you
   should set the path to the main BMI configuration file  with
   the "bmi_config_file" option, like this:
   should set the path to the main BMI configuration file  with
   the "bmi_config_file" option, like this:
-  
+
   bmi_config_file = /opt/brightmail/etc/brightmail.cfg
   bmi_config_file = /opt/brightmail/etc/brightmail.cfg
-  
-  This must go into section 1 of exims configuration file (You
+
+  This must go into section 1 of Exim's configuration file (You
   can  put it  right on  top). If  you omit  this option,  it
   defaults to /opt/brightmail/etc/brightmail.cfg.
 
   Note for BMI6.x users: This  file is in XML format  in V6.xx
   and its  name is  /opt/brightmail/etc/bmiconfig.xml. So  BMI
   6.x users MUST set the bmi_config_file option.
   can  put it  right on  top). If  you omit  this option,  it
   defaults to /opt/brightmail/etc/brightmail.cfg.
 
   Note for BMI6.x users: This  file is in XML format  in V6.xx
   and its  name is  /opt/brightmail/etc/bmiconfig.xml. So  BMI
   6.x users MUST set the bmi_config_file option.
-  
+
 
 3) Set up ACL control statement
 
 
 3) Set up ACL control statement
 
@@ -95,8 +93,8 @@ These four steps are explained in more details below.
   an "accept"  block in  the "acl_check_rcpt"  ACL. You should
   use the "accept" block(s)  that accept messages from  remote
   servers for your own domain(s). Here is an example that uses
   an "accept"  block in  the "acl_check_rcpt"  ACL. You should
   use the "accept" block(s)  that accept messages from  remote
   servers for your own domain(s). Here is an example that uses
-  the "accept" blocks from exims default configuration file:
-  
+  the "accept" blocks from Exim's default configuration file:
+
 
   accept  domains       = +local_domains
           endpass
 
   accept  domains       = +local_domains
           endpass
@@ -107,7 +105,7 @@ These four steps are explained in more details below.
           endpass
           verify        = recipient
           control       = bmi_run
           endpass
           verify        = recipient
           control       = bmi_run
-  
+
   If bmi_run  is not  set in  any ACL  during reception of the
   message, it will NOT be passed to the BMI server.
 
   If bmi_run  is not  set in  any ACL  during reception of the
   message, it will NOT be passed to the BMI server.
 
@@ -118,108 +116,108 @@ These four steps are explained in more details below.
   more "verdicts" are  present. Different recipients  can have
   different verdicts. Each  recipient is treated  individually
   during routing, so you  can query the verdicts  by recipient
   more "verdicts" are  present. Different recipients  can have
   different verdicts. Each  recipient is treated  individually
   during routing, so you  can query the verdicts  by recipient
-  at  that stage.  From Exims  view, a  verdict can  have the
+  at  that stage.  From Exim's  view, a  verdict can  have the
   following outcomes:
   following outcomes:
-  
+
   o deliver the message normally
   o deliver the message to an alternate location
   o do not deliver the message
   o deliver the message normally
   o deliver the message to an alternate location
   o do not deliver the message
-  
+
   To query  the verdict  for a  recipient, the  implementation
   offers the following tools:
   To query  the verdict  for a  recipient, the  implementation
   offers the following tools:
-  
-  
+
+
   - Boolean router  preconditions. These  can be  used in  any
     router. For a simple  implementation of BMI, these  may be
     all  that  you  need.  The  following  preconditions   are
     available:
   - Boolean router  preconditions. These  can be  used in  any
     router. For a simple  implementation of BMI, these  may be
     all  that  you  need.  The  following  preconditions   are
     available:
-    
+
     o bmi_deliver_default
     o bmi_deliver_default
-    
+
       This  precondition  is  TRUE  if  the  verdict  for  the
       recipient is  to deliver  the message  normally. If  the
       message has not been  processed by the BMI  server, this
       variable defaults to TRUE.
       This  precondition  is  TRUE  if  the  verdict  for  the
       recipient is  to deliver  the message  normally. If  the
       message has not been  processed by the BMI  server, this
       variable defaults to TRUE.
-      
+
     o bmi_deliver_alternate
     o bmi_deliver_alternate
-    
+
       This  precondition  is  TRUE  if  the  verdict  for  the
       recipient  is to  deliver the  message to  an alternate
       location.  You  can  get the  location  string  from the
       $bmi_alt_location expansion variable if you need it. See
       further below. If the message has not been processed  by
       the BMI server, this variable defaults to FALSE.
       This  precondition  is  TRUE  if  the  verdict  for  the
       recipient  is to  deliver the  message to  an alternate
       location.  You  can  get the  location  string  from the
       $bmi_alt_location expansion variable if you need it. See
       further below. If the message has not been processed  by
       the BMI server, this variable defaults to FALSE.
-      
+
     o bmi_dont_deliver
     o bmi_dont_deliver
-    
+
       This  precondition  is  TRUE  if  the  verdict  for  the
       recipient  is  NOT  to   deliver  the  message  to   the
       recipient. You will typically use this precondition in a
       top-level blackhole router, like this:
       This  precondition  is  TRUE  if  the  verdict  for  the
       recipient  is  NOT  to   deliver  the  message  to   the
       recipient. You will typically use this precondition in a
       top-level blackhole router, like this:
-      
+
         # don't deliver messages handled by the BMI server
         bmi_blackhole:
           driver = redirect
           bmi_dont_deliver
           data = :blackhole:
         # don't deliver messages handled by the BMI server
         bmi_blackhole:
           driver = redirect
           bmi_dont_deliver
           data = :blackhole:
-      
+
       This router should be on top of all others, so  messages
       that should not be delivered do not reach other  routers
       at all. If   the  message  has  not  been  processed  by
       the  BMI server, this variable defaults to FALSE.
       This router should be on top of all others, so  messages
       that should not be delivered do not reach other  routers
       at all. If   the  message  has  not  been  processed  by
       the  BMI server, this variable defaults to FALSE.
-      
-      
+
+
   - A list router  precondition to query  if rules "fired"  on
     the message for the recipient. Its name is "bmi_rule". You
     use  it  by  passing it  a  colon-separated  list of  rule
     numbers. You can use this condition to route messages that
     matched specific rules. Here is an example:
   - A list router  precondition to query  if rules "fired"  on
     the message for the recipient. Its name is "bmi_rule". You
     use  it  by  passing it  a  colon-separated  list of  rule
     numbers. You can use this condition to route messages that
     matched specific rules. Here is an example:
-    
+
       # special router for BMI rule #5, #8 and #11
       bmi_rule_redirect:
         driver = redirect
         bmi_rule = 5:8:11
         data = postmaster@mydomain.com
       # special router for BMI rule #5, #8 and #11
       bmi_rule_redirect:
         driver = redirect
         bmi_rule = 5:8:11
         data = postmaster@mydomain.com
-      
-  
+
+
   - Expansion variables. Several  expansion variables are  set
     during  routing.  You  can  use  them  in  custom   router
     conditions,  for  example.  The  following  variables  are
     available:
   - Expansion variables. Several  expansion variables are  set
     during  routing.  You  can  use  them  in  custom   router
     conditions,  for  example.  The  following  variables  are
     available:
-    
+
     o $bmi_base64_verdict
     o $bmi_base64_verdict
-    
+
       This variable  will contain  the BASE64  encoded verdict
       for the recipient being routed. You can use it to add  a
       header to messages for tracking purposes, for example:
       This variable  will contain  the BASE64  encoded verdict
       for the recipient being routed. You can use it to add  a
       header to messages for tracking purposes, for example:
-      
+
       localuser:
         driver = accept
         check_local_user
         headers_add = X-Brightmail-Verdict: $bmi_base64_verdict
         transport = local_delivery
       localuser:
         driver = accept
         check_local_user
         headers_add = X-Brightmail-Verdict: $bmi_base64_verdict
         transport = local_delivery
-      
+
       If there is no verdict available for the recipient being
       routed, this variable contains the empty string.
       If there is no verdict available for the recipient being
       routed, this variable contains the empty string.
-    
+
     o $bmi_base64_tracker_verdict
     o $bmi_base64_tracker_verdict
-    
+
       This variable  will contain  a BASE64  encoded subset of
       the  verdict  information  concerning  the  "rules" that
       fired  on the  message. You  can add  this string  to a
       header, commonly named "X-Brightmail-Tracker". Example:
       This variable  will contain  a BASE64  encoded subset of
       the  verdict  information  concerning  the  "rules" that
       fired  on the  message. You  can add  this string  to a
       header, commonly named "X-Brightmail-Tracker". Example:
-      
+
       localuser:
         driver = accept
         check_local_user
         headers_add = X-Brightmail-Tracker: $bmi_base64_tracker_verdict
         transport = local_delivery
       localuser:
         driver = accept
         check_local_user
         headers_add = X-Brightmail-Tracker: $bmi_base64_tracker_verdict
         transport = local_delivery
-        
+
       If there is no verdict available for the recipient being
       routed, this variable contains the empty string.
       If there is no verdict available for the recipient being
       routed, this variable contains the empty string.
-      
+
     o $bmi_alt_location
     o $bmi_alt_location
-    
+
       If  the  verdict  is  to  redirect  the  message  to  an
       alternate  location,  this  variable  will  contain  the
       alternate location string returned by the BMI server. In
       If  the  verdict  is  to  redirect  the  message  to  an
       alternate  location,  this  variable  will  contain  the
       alternate location string returned by the BMI server. In
@@ -228,17 +226,17 @@ These four steps are explained in more details below.
       there is  no verdict  available for  the recipient being
       routed, or if the  message is to be  delivered normally,
       this variable contains the empty string.
       there is  no verdict  available for  the recipient being
       routed, or if the  message is to be  delivered normally,
       this variable contains the empty string.
-      
+
     o $bmi_deliver
     o $bmi_deliver
-    
+
       This is an additional integer variable that can be  used
       to query if the message should be delivered at all.  You
       should use router preconditions instead if possible.
       This is an additional integer variable that can be  used
       to query if the message should be delivered at all.  You
       should use router preconditions instead if possible.
-      
+
       $bmi_deliver is '0': the message should NOT be delivered.
       $bmi_deliver is '1': the message should be delivered.
       $bmi_deliver is '0': the message should NOT be delivered.
       $bmi_deliver is '1': the message should be delivered.
-      
-   
+
+
   IMPORTANT NOTE: Verdict inheritance.
   The  message  is passed  to  the BMI  server  during message
   reception,  using the  target addresses  from the  RCPT TO:
   IMPORTANT NOTE: Verdict inheritance.
   The  message  is passed  to  the BMI  server  during message
   reception,  using the  target addresses  from the  RCPT TO:
@@ -247,8 +245,8 @@ These four steps are explained in more details below.
   inherit the  verdict from  the original  address. This means
   that verdicts also apply to all "child" addresses  generated
   from top-level addresses that were sent to the BMI server.
   inherit the  verdict from  the original  address. This means
   that verdicts also apply to all "child" addresses  generated
   from top-level addresses that were sent to the BMI server.
-  
-  
+
+
 5) Using per-recipient opt-in information (Optional)
 
   The  BMI server  features multiple  scanning "profiles"  for
 5) Using per-recipient opt-in information (Optional)
 
   The  BMI server  features multiple  scanning "profiles"  for
@@ -256,7 +254,7 @@ These four steps are explained in more details below.
   server and are  queried by the  BMI server itself.  However,
   you can also  pass opt-in data  for each recipient  from the
   MTA to the  BMI server. This  is particularly useful  if you
   server and are  queried by the  BMI server itself.  However,
   you can also  pass opt-in data  for each recipient  from the
   MTA to the  BMI server. This  is particularly useful  if you
-  already look  up recipient  data in  exim anyway  (which can
+  already look  up recipient  data in  Exim anyway  (which can
   also be  stored in  a SQL  database or  other source).  This
   implementation enables you  to pass opt-in  data to the  BMI
   server  in  the  RCPT   ACL.  This  works  by   setting  the
   also be  stored in  a SQL  database or  other source).  This
   implementation enables you  to pass opt-in  data to the  BMI
   server  in  the  RCPT   ACL.  This  works  by   setting  the
@@ -268,165 +266,419 @@ These four steps are explained in more details below.
   flag. Here is an example that will pull opt-in data for each
   recipient      from       a      flat       file      called
   '/etc/exim/bmi_optin_data'.
   flag. Here is an example that will pull opt-in data for each
   recipient      from       a      flat       file      called
   '/etc/exim/bmi_optin_data'.
-  
+
   The file format:
   The file format:
-  
+
     user1@mydomain.com: <OPTIN STRING1>:<OPTIN STRING2>
     user2@thatdomain.com: <OPTIN STRING3>
     user1@mydomain.com: <OPTIN STRING1>:<OPTIN STRING2>
     user2@thatdomain.com: <OPTIN STRING3>
-    
-    
+
+
   The example:
   The example:
-  
+
     accept  domains       = +relay_to_domains
             endpass
             verify        = recipient
             bmi_optin     = ${lookup{$local_part@$domain}lsearch{/etc/exim/bmi_optin_data}}
     accept  domains       = +relay_to_domains
             endpass
             verify        = recipient
             bmi_optin     = ${lookup{$local_part@$domain}lsearch{/etc/exim/bmi_optin_data}}
-            control       = bmi_run  
-  
+            control       = bmi_run
+
   Of course,  you can  also use  any other  lookup method that
   Of course,  you can  also use  any other  lookup method that
-  exim supports, including LDAP, Postgres, MySQL, Oracle etc.,
+  Exim supports, including LDAP, Postgres, MySQL, Oracle etc.,
   as long as  the result is  a list of  colon-separated opt-in
   strings.
   as long as  the result is  a list of  colon-separated opt-in
   strings.
-  
+
   For a list of available opt-in strings, please contact  your
   Brightmail representative.
   For a list of available opt-in strings, please contact  your
   Brightmail representative.
-  
-  
 
 
-  
-2. Sender Policy Framework (SPF) support
---------------------------------------------------------------
 
 
-To learn  more  about  SPF, visit   http://spf.pobox.com. This
-document does   not explain  the SPF  fundamentals, you should
-read and understand the implications of deploying SPF on  your
-system before doing so.
-
-SPF support is added via the libspf2 library. Visit 
-
-  http://www.libspf2.org/
-  
-to obtain  a copy,  then compile  and install  it. By default,
-this will  put headers  in /usr/local/include  and the  static
-library in /usr/local/lib.
-
-To compile exim with SPF support, set these additional flags in
-Local/Makefile:
-
-EXPERIMENTAL_SPF=yes
-CFLAGS=-DSPF -I/usr/local/include
-EXTRALIBS_EXIM=-L/usr/local/lib -lspf2
-
-This assumes   that the   libspf2 files   are installed  in
-their default locations.
-
-You can now run SPF checks in incoming SMTP by using the "spf"
-ACL condition  in either  the MAIL,  RCPT or  DATA ACLs.  When
-using it in the RCPT ACL, you can make the checks dependend on
-the RCPT  address (or  domain), so  you can  check SPF records
-only  for   certain  target   domains.  This   gives  you  the
-possibility  to opt-out  certain customers  that do  not want
-their mail to be subject to SPF checking.
-
-The spf condition  takes a list  of strings on  its right-hand
-side. These strings describe the outcome of the SPF check  for
-which the spf condition should succeed. Valid strings are:
-
-  o pass      The SPF check passed, the sending host
-              is positively verified by SPF.
-  o fail      The SPF check failed, the sending host
-              is NOT allowed to send mail for the domain
-              in the envelope-from address.
-  o softfail  The SPF check failed, but the queried
-              domain can't absolutely confirm that this
-              is a forgery.
-  o none      The queried domain does not publish SPF
-              records.
-  o neutral   The SPF check returned a "neutral" state.
-              This means the queried domain has published
-              a SPF record, but wants to allow outside
-              servers to send mail under its domain as well.
-  o err_perm  This indicates a syntax error in the SPF
-              record of the queried domain. This should be
-              treated like "none".
-  o err_temp  This indicates a temporary error during all
-              processing, including exim's SPF processing.
-              You may defer messages when this occurs.
-              
-You can prefix each string with an exclamation mark to  invert
-is meaning,  for example  "!fail" will  match all  results but
-"fail".  The  string  list is  evaluated  left-to-right,  in a
-short-circuit fashion.  When a  string matches  the outcome of
-the SPF check, the condition  succeeds. If none of the  listed
-strings matches the  outcome of the  SPF check, the  condition
-fails.
-
-Here is a simple example to fail forgery attempts from domains
-that publish SPF records:
-
-/* -----------------
-deny message = $sender_host_address is not allowed to send mail from $sender_address_domain
-     spf = fail
---------------------- */
-
-You can also give special treatment to specific domains:
-
-/* -----------------
-deny message = AOL sender, but not from AOL-approved relay.
-     sender_domains = aol.com
-     spf = fail:neutral
---------------------- */
-
-Explanation: AOL  publishes SPF  records, but  is liberal  and
-still allows  non-approved relays  to send  mail from aol.com.
-This will result in a "neutral" state, while mail from genuine
-AOL servers  will result  in "pass".  The example  above takes
-this into account and  treats "neutral" like "fail",  but only
-for aol.com. Please note that this violates the SPF draft.
-
-When the spf condition has run, it sets up several expansion
-variables.
-
-  $spf_header_comment
-  This contains a human-readable string describing the outcome
-  of the SPF check. You can add it to a custom header or use
-  it for logging purposes.
-  
-  $spf_received
-  This contains a complete SPF-Received: header that can be
-  added to the message. Please note that according to the SPF
-  draft, this header must be added at the top of the header
-  list. Please see section 10 on how you can do this.
-  
-  $spf_result
-  This contains the outcome of the SPF check in string form,
-  one of pass, fail, softfail, none, neutral, err_perm or
-  err_temp.
-  
-  $spf_smtp_comment
-  This contains a string that can be used in a SMTP response
-  to the calling party. Useful for "fail".
-  
-  
-
-3. SRS (Sender Rewriting Scheme) Support
+
+
+SRS (Sender Rewriting Scheme) Support (using libsrs_alt)
 --------------------------------------------------------------
 --------------------------------------------------------------
+See also the main docs, for an alternative native support implementation.
 
 
-Exiscan  currently  includes SRS  support  via Miles  Wilton's
-libsrs_alt library. The current version of the supported 
-library is 0.5.
+Exim can be built with SRS support using Miles  Wilton's
+libsrs_alt library. The current version of the supported
+library is 0.5, there are reports of 1.0 working.
 
 In order to  use SRS, you  must get a  copy of libsrs_alt from
 
 
 In order to  use SRS, you  must get a  copy of libsrs_alt from
 
-http://srs.mirtol.com/
+https://opsec.eu/src/srs/
+
+(not the original source, which has disappeared.)
 
 Unpack the tarball, then refer to MTAs/README.EXIM
 to proceed. You need to set
 
 
 Unpack the tarball, then refer to MTAs/README.EXIM
 to proceed. You need to set
 
-EXPERIMENTAL_SRS=yes
+EXPERIMENTAL_SRS_ALT=yes
 
 in your Local/Makefile.
 
 
 in your Local/Makefile.
 
+The built-in support, included by SUPPORT_SRS,
+shuold *not* be enabled if you wish to use the libsrs_alt
+version.
+
+The following main-section options become available:
+       srs_config              string
+       srs_hashlength          int
+       srs_hashmin             int
+       srs_maxage              int
+       srs_secrets             string
+       srs_usehash             bool
+       srs_usetimestamp        bool
+
+The redirect router gains these options (all of type string, unset by default):
+       srs
+       srs_alias
+       srs_condition
+       srs_dbinsert
+       srs_dbselect
+
+The following variables become available:
+       $srs_db_address
+       $srs_db_key
+       $srs_orig_recipient
+       $srs_orig_sender
+       $srs_recipient
+       $srs_status
+
+The predefined feature-macro _HAVE_SRS will be present.
+Additional delivery log line elements, tagged with "SRS=" will show the srs sender.    
+For configuration information see https://github.com/Exim/exim/wiki/SRS .
+
+
+
+
+DCC Support
+--------------------------------------------------------------
+Distributed Checksum Clearinghouse; http://www.rhyolite.com/dcc/
+
+*) Building exim
+
+In order to build exim with DCC support add
+
+EXPERIMENTAL_DCC=yes
+
+to your Makefile. (Re-)build/install exim. exim -d should show
+EXPERIMENTAL_DCC under "Support for".
+
+
+*) Configuration
+
+In the main section of exim.cf add at least
+  dccifd_address = /usr/local/dcc/var/dccifd
+or
+  dccifd_address = <ip> <port>
+
+In the DATA ACL you can use the new condition
+        dcc = *
+
+After that "$dcc_header" contains the X-DCC-Header.
+
+Return values are:
+  fail    for overall "R", "G" from dccifd
+  defer   for overall "T" from dccifd
+  accept  for overall "A", "S" from dccifd
+
+dcc = */defer_ok works as for spamd.
+
+The "$dcc_result" variable contains the overall result from DCC
+answer.  There will an X-DCC: header added to the mail.
+
+Usually you'll use
+  defer   !dcc = *
+to greylist with DCC.
+
+If you set, in the main section,
+  dcc_direct_add_header = true
+then the dcc header will be added "in deep" and if the spool
+file was already written it gets removed. This forces Exim to
+write it again if needed.  This helps to get the DCC Header
+through to eg. SpamAssassin.
+
+If you want to pass even more headers in the middle of the
+DATA stage you can set
+  $acl_m_dcc_add_header
+to tell the DCC routines to add more information; eg, you might set
+this to some results from ClamAV.  Be careful.  Header syntax is
+not checked and is added "as is".
+
+In case you've troubles with sites sending the same queue items from several
+hosts and fail to get through greylisting you can use
+$acl_m_dcc_override_client_ip
+
+Setting $acl_m_dcc_override_client_ip to an IP address overrides the default
+of $sender_host_address. eg. use the following ACL in DATA stage:
+
+  warn    set acl_m_dcc_override_client_ip = \
+    ${lookup{$sender_helo_name}nwildlsearch{/etc/mail/multipleip_sites}{$value}{}}
+          condition = ${if def:acl_m_dcc_override_client_ip}
+          log_message = dbg: acl_m_dcc_override_client_ip set to \
+                        $acl_m_dcc_override_client_ip
+
+Then set something like
+# cat /etc/mail/multipleip_sites
+mout-xforward.gmx.net           82.165.159.12
+mout.gmx.net                    212.227.15.16
+
+Use a reasonable IP. eg. one the sending cluster actually uses.
+
+
+
+DSN extra information
+---------------------
+If compiled with EXPERIMENTAL_DSN_INFO extra information will be added
+to DSN fail messages ("bounces"), when available.  The intent is to aid
+tracing of specific failing messages, when presented with a "bounce"
+complaint and needing to search logs.
+
+
+The remote MTA IP address, with port number if nonstandard.
+Example:
+  Remote-MTA: X-ip; [127.0.0.1]:587
+Rationale:
+  Several addresses may correspond to the (already available)
+  dns name for the remote MTA.
+
+The remote MTA connect-time greeting.
+Example:
+  X-Remote-MTA-smtp-greeting: X-str; 220 the.local.host.name ESMTP Exim x.yz Tue, 2 Mar 1999 09:44:33 +0000
+Rationale:
+  This string sometimes presents the remote MTA's idea of its
+  own name, and sometimes identifies the MTA software.
+
+The remote MTA response to HELO or EHLO.
+Example:
+  X-Remote-MTA-helo-response: X-str; 250-the.local.host.name Hello localhost [127.0.0.1]
+Limitations:
+  Only the first line of a multiline response is recorded.
+Rationale:
+  This string sometimes presents the remote MTA's view of
+  the peer IP connecting to it.
+
+The reporting MTA detailed diagnostic.
+Example:
+  X-Exim-Diagnostic: X-str; SMTP error from remote mail server after RCPT TO:<d3@myhost.test.ex>: 550 hard error
+Rationale:
+  This string sometimes give extra information over the
+  existing (already available) Diagnostic-Code field.
+
+
+Note that non-RFC-documented field names and data types are used.
+
+
+Queuefile transport
+-------------------
+Queuefile is a pseudo transport which does not perform final delivery.
+It simply copies the exim spool files out of the spool directory into
+an external directory retaining the exim spool format.
+
+The spool files can then be processed by external processes and then
+requeued into exim spool directories for final delivery.
+However, note carefully the warnings in the main documentation on
+qpool file formats.
+
+The motivation/inspiration for the transport is to allow external
+processes to access email queued by exim and have access to all the
+information which would not be available if the messages were delivered
+to the process in the standard email formats.
+
+The mailscanner package is one of the processes that can take advantage
+of this transport to filter email.
+
+The transport can be used in the same way as the other existing transports,
+i.e by configuring a router to route mail to a transport configured with
+the queuefile driver.
+
+The transport only takes one option:
+
+* directory - This is used to specify the directory messages should be
+copied to.  Expanded.
+
+The generic transport options (body_only, current_directory, disable_logging,
+debug_print, delivery_date_add, envelope_to_add, event_action, group,
+headers_add, headers_only, headers_remove, headers_rewrite, home_directory,
+initgroups, max_parallel, message_size_limit, rcpt_include_affixes,
+retry_use_local_part, return_path, return_path_add, shadow_condition,
+shadow_transport, transport_filter, transport_filter_timeout, user) are
+ignored.
+
+Sample configuration:
+
+(Router)
+
+scan:
+   driver = accept
+   transport = scan
+
+(Transport)
+
+scan:
+  driver = queuefile
+  directory = /var/spool/baruwa-scanner/input
+
+
+In order to build exim with Queuefile transport support add or uncomment
+
+EXPERIMENTAL_QUEUEFILE=yes
+
+to your Local/Makefile. (Re-)build/install exim. exim -d should show
+Experimental_QUEUEFILE in the line "Support for:".
+
+
+ARC support
+-----------
+Specification: https://tools.ietf.org/html/draft-ietf-dmarc-arc-protocol-11
+Note that this is not an RFC yet, so may change.
+
+[RFC 8617 was published 2019/06.  Draft 11 was 2018/01.  A review of the
+changes has not yet been done]
+
+ARC is intended to support the utility of SPF and DKIM in the presence of
+intermediaries in the transmission path - forwarders and mailinglists -
+by establishing a cryptographically-signed chain in headers.
+
+Normally one would only bother doing ARC-signing when functioning as
+an intermediary.  One might do verify for local destinations.
+
+ARC uses the notion of a "ADministrative Management Domain" (ADMD).
+Described in RFC 5598 (section 2.3), this is essentially a set of
+mail-handling systems that mail transits that are all under the control
+of one organisation.  A label should be chosen to identify the ADMD.
+Messages should be ARC-verified on entry to the ADMD, and ARC-signed on exit
+from it.
+
+
+Building with ARC Support
+--
+Enable using EXPERIMENTAL_ARC=yes in your Local/Makefile.
+You must also have DKIM present (not disabled), and you very likely
+want to have SPF enabled.
+
+
+Verification
+--
+An ACL condition is provided to perform the "verifier actions" detailed
+in section 6 of the above specification.  It may be called from the DATA ACL
+and succeeds if the result matches any of a given list.
+It also records the highest ARC instance number (the chain size)
+and verification result for later use in creating an Authentication-Results:
+standard header.
+
+  verify = arc/<acceptable_list>   none:fail:pass
+
+  add_header = :at_start:${authresults {<admd-identifier>}}
+
+       Note that it would be wise to strip incoming messages of A-R headers
+       that claim to be from our own <admd-identifier>.
+
+There are four new variables:
+
+  $arc_state           One of pass, fail, none
+  $arc_state_reason    (if fail, why)
+  $arc_domains         colon-sep list of ARC chain domains, in chain order.
+                       problematic elements may have empty list elements
+  $arc_oldest_pass     lowest passing instance number of chain
+
+Example:
+  logwrite = oldest-p-ams: <${reduce {$lh_ARC-Authentication-Results:} \
+                               {} \
+                               {${if = {$arc_oldest_pass} \
+                                       {${extract {i}{${extract {1}{;}{$item}}}}} \
+                                       {$item} {$value}}} \
+                           }>
+
+Receive log lines for an ARC pass will be tagged "ARC".
+
+
+Signing
+--
+arc_sign = <admd-identifier> : <selector> : <privkey> [ : <options> ]
+An option on the smtp transport, which constructs and prepends to the message
+an ARC set of headers.  The textually-first Authentication-Results: header
+is used as a basis (you must have added one on entry to the ADMD).
+Expanded as a whole; if unset, empty or forced-failure then no signing is done.
+If it is set, all of the first three elements must be non-empty.
+
+The fourth element is optional, and if present consists of a comma-separated list
+of options.  The options implemented are
+
+  timestamps           Add a t= tag to the generated AMS and AS headers, with the
+                       current time.
+  expire[=<val>]       Add an x= tag to the generated AMS header, with an expiry time.
+                       If the value <val> is an plain number it is used unchanged.
+                       If it starts with a '+' then the following number is added
+                       to the current time, as an offset in seconds.
+                       If a value is not given it defaults to a one month offset.
+
+[As of writing, gmail insist that a t= tag on the AS is mandatory]
+
+Caveats:
+ * There must be an Authentication-Results header, presumably added by an ACL
+   while receiving the message, for the same ADMD, for arc_sign to succeed.
+   This requires careful coordination between inbound and outbound logic.
+
+   Only one A-R header is taken account of.  This is a limitation versus
+   the ARC spec (which says that all A-R headers from within the ADMD must
+   be used).
+
+ * If passing a message to another system, such as a mailing-list manager
+   (MLM), between receipt and sending, be wary of manipulations to headers made
+   by the MLM.
+   + For instance, Mailman with REMOVE_DKIM_HEADERS==3 might improve
+     deliverability in a pre-ARC world, but that option also renames the
+     Authentication-Results header, which breaks signing.
+
+ * Even if you use multiple DKIM keys for different domains, the ARC concept
+   should try to stick to one ADMD, so pick a primary domain and use that for
+   AR headers and outbound signing.
+
+Signing is not compatible with cutthrough delivery; any (before expansion)
+value set for the option will result in cutthrough delivery not being
+used via the transport in question.
+
+
+
+Dovecot authenticator via inet socket
+--------------------------------------------------------------
+If Dovecot is configured similar to :-
+
+service auth {
+...
+#SASL
+  inet_listener {
+    name = exim
+    port = 12345
+  }
+...
+}
+
+then an Exim authenticator can be configured :-
+
+  dovecot-plain:
+    driver =           dovecot
+    public_name =      PLAIN
+    server_socket =    dovecot_server_name 12345
+    server_tls =       true
+    server_set_id =    $auth1
+
+If the server_socket does not start with a / it is taken as a hostname (or IP);
+and a whitespace-separated port number must be given.
+
+
+
+
+Logging protocol unusual states
+---------------------------------------------------------------
+An extra log_selector, "protocol_detail" has been added in the default build.
+The name may change in future, hence the Experimenal status.
+
+Currrently the only effect is to enable logging, under TLS,
+of a TCP RST received directly after a QUIT (in server mode).
+
+Outlook is consistently doing this; not waiting for the SMTP response
+to its QUIT, not properly closing the TLS session and not properly closing
+the TCP connection.  Previously this resulted is an error from SSL_write
+being logged.
 
 --------------------------------------------------------------
 End of file
 
 --------------------------------------------------------------
 End of file