From 4f5788623ab3e8456ad254883b6cc018079aab96 Mon Sep 17 00:00:00 2001 From: Philip Hazel Date: Tue, 4 Apr 2006 14:03:49 +0000 Subject: [PATCH] Update documentation for 4.61 and some of the preparation tools. --- doc/doc-docbook/HowItWorks.txt | 17 +- doc/doc-docbook/Makefile | 18 +- doc/doc-docbook/Markup.txt | 16 +- doc/doc-docbook/MyStyle-fo.xsl | 15 +- doc/doc-docbook/MyStyle-spec-fo.xsl | 15 +- doc/doc-docbook/PageLabelPDF | 15 +- doc/doc-docbook/TidyHTML-spec | 24 +- doc/doc-docbook/TidyInfo | 69 + doc/doc-docbook/filter.xfpt | 10 +- doc/doc-docbook/index.html | 4 +- doc/doc-docbook/spec.xfpt | 1974 ++++++++++++++++----------- doc/doc-docbook/x2man | 4 +- doc/doc-txt/NewStuff | 204 +-- 13 files changed, 1369 insertions(+), 1016 deletions(-) create mode 100755 doc/doc-docbook/TidyInfo diff --git a/doc/doc-docbook/HowItWorks.txt b/doc/doc-docbook/HowItWorks.txt index 228709273..5bd93ef4a 100644 --- a/doc/doc-docbook/HowItWorks.txt +++ b/doc/doc-docbook/HowItWorks.txt @@ -1,4 +1,4 @@ -$Cambridge: exim/doc/doc-docbook/HowItWorks.txt,v 1.3 2006/02/01 11:01:01 ph10 Exp $ +$Cambridge: exim/doc/doc-docbook/HowItWorks.txt,v 1.4 2006/04/04 14:03:49 ph10 Exp $ CREATING THE EXIM DOCUMENTATION @@ -401,7 +401,7 @@ of it inserts   so that the table's cell is a little bit wider than the text itself. The TidyHTML-spec script also takes the opportunity to postprocess the -spec.html/ix01.html file, which contains the document index. Again, the index +spec_html/ix01.html file, which contains the document index. Again, the index is generated as one single line, so it splits it up. Then it creates a list of letters at the top of the index and hyperlinks them both ways from the different letter portions of the index. @@ -448,16 +448,18 @@ characters in the source are transliterated, and the elements are removed. The docbook2texi script is then called to convert the XML file into a Texinfo file. However, this is not quite enough. The converted file ends up with "conceptindex" and "optionindex" items, which are not recognized by the -makeinfo command. An in-line call to Perl in the Makefile changes these to -"cindex" and "findex" respectively in the final .texinfo file. Finally, a call -of makeinfo creates a set of .info files. +makeinfo command. These have to be changed to "cindex" and "findex" +respectively in the final .texinfo file. Furthermore, the main menu lacks a +pointer to the index, and indeed the index node itself is missing. These +problems are fixed by running the file through a script called TidyInfo. +Finally, a call of makeinfo creates a set of .info files. There is one apparently unconfigurable feature of docbook2texi: it does not seem possible to give it a file name for its output. It chooses a name based on the title of the document. Thus, the main specification ends up in a file called the_exim_mta.texi and the filter document in exim_filtering.texi. These files are removed after their contents have been copied and modified by the -inline Perl call, which makes a .texinfo file. +TidyInfo script, which writes to a .texinfo file. CREATING THE MAN PAGE @@ -575,6 +577,7 @@ PageLabelPDF Script to postprocess PDF Pre-xml Script to preprocess XML TidyHTML-filter Script to tidy up the filter HTML output TidyHTML-spec Script to tidy up the spec HTML output +TidyInfo Script to sort index problems in Texinfo output Tidytxt Script to compact multiple blank lines filter.xfpt xfpt source of the filter document spec.xfpt xfpt source of the specification document @@ -582,4 +585,4 @@ x2man Script to make the Exim man page from the XML Philip Hazel -Last updated: 31 January 2006 +Last updated: 30 March 2006 diff --git a/doc/doc-docbook/Makefile b/doc/doc-docbook/Makefile index 0495b582e..f422bdda8 100644 --- a/doc/doc-docbook/Makefile +++ b/doc/doc-docbook/Makefile @@ -1,4 +1,4 @@ -# $Cambridge: exim/doc/doc-docbook/Makefile,v 1.7 2006/02/01 11:01:01 ph10 Exp $ +# $Cambridge: exim/doc/doc-docbook/Makefile,v 1.8 2006/04/04 14:03:49 ph10 Exp $ # Make file for Exim documentation from xfpt source. @@ -47,9 +47,9 @@ filter.ps: filter.fo # Do not use ps2pdf from the PS version; better PDF is generated directly. It # contains cross links etc. -filter.pdf: filter.fo +filter.pdf: filter.fo PageLabelPDF fop filter.fo -pdf filter-tmp.pdf - mv filter-tmp.pdf filter.pdf + ./PageLabelPDF 2 filter.pdf filter.html: filter-html.xml TidyHTML-filter MyStyle-nochunk-html.xsl \ MyStyle-html.xsl MyStyle.xsl @@ -115,12 +115,12 @@ spec.ps: spec.fo spec.pdf: spec.fo PageLabelPDF FOP_OPTS=-Xmx512m fop spec.fo -pdf spec-tmp.pdf - ./PageLabelPDF spec.pdf + ./PageLabelPDF 12 spec.pdf spec.html: spec-html.xml TidyHTML-spec MyStyle-chunk-html.xsl \ MyStyle-html.xsl MyStyle.xsl - /bin/rm -rf spec.html - xmlto -x MyStyle-chunk-html.xsl -o spec.html html spec-html.xml + /bin/rm -rf spec_html + xmlto -x MyStyle-chunk-html.xsl -o spec_html html spec-html.xml ./TidyHTML-spec spec.txt: spec-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \ @@ -135,8 +135,7 @@ spec.txt: spec-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \ spec.info: spec-info.xml docbook2texi spec-info.xml - perl -ne 's/conceptindex/cindex/;s/optionindex/findex/;print;' \ - spec.texinfo + ./TidyInfo spec.texinfo /bin/rm -rf the_exim_mta.texi makeinfo -o spec.info spec.texinfo @@ -200,8 +199,7 @@ test.txt: test-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \ test.info: test-info.xml docbook2texi test-info.xml - perl -ne 's/conceptindex/cindex/;s/optionindex/findex/;print;' \ - test.texinfo + ./TidyInfo test.texinfo /bin/rm -rf short_title.texi makeinfo -o test.info test.texinfo diff --git a/doc/doc-docbook/Markup.txt b/doc/doc-docbook/Markup.txt index 9220eb4e8..f81876508 100644 --- a/doc/doc-docbook/Markup.txt +++ b/doc/doc-docbook/Markup.txt @@ -1,4 +1,4 @@ -$Cambridge: exim/doc/doc-docbook/Markup.txt,v 1.1 2006/02/01 11:01:01 ph10 Exp $ +$Cambridge: exim/doc/doc-docbook/Markup.txt,v 1.2 2006/04/04 14:03:49 ph10 Exp $ XFPT MARKUP USED IN THE EXIM DOCUMENTATION ------------------------------------------ @@ -217,8 +217,16 @@ To create an index entry, include a line like one of these: .oindex "primary text" "secondary text" The first is for the "concept index" and the second is for the "options index". -Not all forms of output distinguish between these - sometimes there is just one -index. +The secondary text is of course optional. Not all forms of output distinguish +between these - sometimes there is just one index. For the concept index, it is +also possible to set "start" and "end" markers so that the entry lists a range +of pages. This is how to do that: + + .scindex IID "primary text" "secondary text" + + .ecindex IID + +The IID must be some unique string to tie the entries together. The index for the Exim reference manual has a number of "see also" entries. These are coded in raw XML at the start of the source file. @@ -351,4 +359,4 @@ Each such entry must be separately marked. If there are more than one or two, it may be easier just to mark the entire table. Philip Hazel -Last updated: 25 January 2006 +Last updated: 30 March 2006 diff --git a/doc/doc-docbook/MyStyle-fo.xsl b/doc/doc-docbook/MyStyle-fo.xsl index a23da6496..f6731d392 100644 --- a/doc/doc-docbook/MyStyle-fo.xsl +++ b/doc/doc-docbook/MyStyle-fo.xsl @@ -1,4 +1,4 @@ - + + + + + + + + end-on-even + no-force + + + diff --git a/doc/doc-docbook/MyStyle-spec-fo.xsl b/doc/doc-docbook/MyStyle-spec-fo.xsl index afca6c520..7d43e756e 100644 --- a/doc/doc-docbook/MyStyle-spec-fo.xsl +++ b/doc/doc-docbook/MyStyle-spec-fo.xsl @@ -1,4 +1,4 @@ - + @@ -14,17 +14,4 @@ printing the Exim specification document. --> - - - - - - - end-on-even - no-force - - - diff --git a/doc/doc-docbook/PageLabelPDF b/doc/doc-docbook/PageLabelPDF index aa144e208..5819d11c4 100755 --- a/doc/doc-docbook/PageLabelPDF +++ b/doc/doc-docbook/PageLabelPDF @@ -1,20 +1,21 @@ #! /usr/bin/perl -w -# $Cambridge: exim/doc/doc-docbook/PageLabelPDF,v 1.1 2006/02/01 11:01:01 ph10 Exp $ +# $Cambridge: exim/doc/doc-docbook/PageLabelPDF,v 1.2 2006/04/04 14:03:49 ph10 Exp $ # Program to add page label information to the PDF output file. I have not # found a way of automatically discovering the number of frontmatter pages -# in the document. It is therefore screwed in as 12 in the next statement. +# in the document. It is therefore taken as an argument to be inserted into the +# next statement. $add = "/PageLabels << /Nums [ 0 << /S /r >>\n" . - " 12 << /S /D >>\n" . + " $ARGV[0] << /S /D >>\n" . " ]\n" . " >>\n"; $extra = length $add; $before = 0; -while (<>) +while () { print; $before += length($_); @@ -23,13 +24,13 @@ while (<>) print $add; -while (<>) +while () { print; last if $_ =~ /^xref$/; } -while (<>) +while () { if (/^(\d{10}) (.*)/) { @@ -40,7 +41,7 @@ while (<>) elsif (/^startxref/) { print; - $_ = <>; + $_ = ; if (/^(\d+)/) { print $1 + $extra, "\n"; diff --git a/doc/doc-docbook/TidyHTML-spec b/doc/doc-docbook/TidyHTML-spec index c1bc994cd..4e7b8a2ca 100755 --- a/doc/doc-docbook/TidyHTML-spec +++ b/doc/doc-docbook/TidyHTML-spec @@ -1,6 +1,6 @@ #! /usr/bin/perl -# $Cambridge: exim/doc/doc-docbook/TidyHTML-spec,v 1.3 2006/02/01 11:01:01 ph10 Exp $ +# $Cambridge: exim/doc/doc-docbook/TidyHTML-spec,v 1.4 2006/04/04 14:03:49 ph10 Exp $ # Script to tidy up the spec HTML files that are generated by xmlto. The # following changes are made: @@ -15,7 +15,7 @@ # 6. Before each occurrence of insert   so that the table's cell # is a little bit wider than the text itself. -chdir "spec.html"; +chdir "spec_html"; $tocref = 1; @@ -25,11 +25,23 @@ open(IN, "index.html") || die "Failed to open index.html for reading: $!\n"; @toc = ; close(IN); -# Insert a newline after every > because the whole toc is generated as one -# humungous line that is hard to check. Then split the lines so that each one -# is a separate element in the vector. +# Insert a newline after every > except when it is preceded by 'class="quote"', +# because the whole toc is generated as one humungous line that is hard to +# check. We have to avoid it in the quote case because that puts a space into +# the output, and similarly for the the comes afterwards. Easy way out +# is just not to do it for all occurrences. Unfortunately, Perl does +# not implement lookbehinds where the alternatives are of different lengths, so +# we have to take two passes. + + +foreach $line (@toc) + { + $line =~ s/(?\s*/>\n/g; + $line =~ s/<\/span>\n/<\/span>/g; + } + +# Split the lines so that each one is a separate element in the vector. -foreach $line (@toc) { $line =~ s/>\s*/>\n/g; } for ($i = 0; $i < scalar(@toc); $i++) { splice @toc, $i, 1, (split /(?<=\n)/, $toc[$i]); } diff --git a/doc/doc-docbook/TidyInfo b/doc/doc-docbook/TidyInfo new file mode 100755 index 000000000..9b9f8f290 --- /dev/null +++ b/doc/doc-docbook/TidyInfo @@ -0,0 +1,69 @@ +#! /usr/bin/perl -w + +# $Cambridge: exim/doc/doc-docbook/TidyInfo,v 1.1 2006/04/04 14:03:49 ph10 Exp $ + +# This is script to tidy up the Texinfo file that docbook2texi produces. We +# have to change "conceptindex" and "optionindex" to "cindex" and "findex", and +# we also have to add access to the index into the menus and a final node. + +# Find the start of the first menu. + +while (<>) + { + print; + last if /^\@menu/; + } + +# Find the end of the first menu. + +while (<>) + { + last if /^$/; + print; + } + +# Insert a menu link to the index. + +print "* Concept Index::\n\n"; + +# Find the final @bye line. En route, we look for the last chapter node, the +# one that has nothing following, and insert a pointer to an index node. Also, +# change the index names. + +while (<>) + { + last if /^\@bye/; + if (/^\@node ([^,]+), , (.*)/) + { + my($save1) = $1; + my($save2) = $2; + my($saveline) = $_; + $_ = <>; + if (/^\@chapter/) + { + print "\@node $save1, Concept Index, $save2\n"; + $previous = $save1; + } + else + { + print "$saveline"; + } + print; + } + else + { + s/conceptindex/cindex/; + s/optionindex/findex/; + print; + } + } + +# Insert the final index stuff at the end. + +print "\@appendix\n"; +print "\@node Concept Index, , $previous, Top\n"; +print "\n\@printindex cp\n\n"; + +print; + +# End diff --git a/doc/doc-docbook/filter.xfpt b/doc/doc-docbook/filter.xfpt index d0eda0182..c281d215f 100644 --- a/doc/doc-docbook/filter.xfpt +++ b/doc/doc-docbook/filter.xfpt @@ -1,4 +1,4 @@ -. $Cambridge: exim/doc/doc-docbook/filter.xfpt,v 1.1 2006/02/01 11:01:01 ph10 Exp $ +. $Cambridge: exim/doc/doc-docbook/filter.xfpt,v 1.2 2006/04/04 14:03:49 ph10 Exp $ . ///////////////////////////////////////////////////////////////////////////// . This is the primary source of the document that describes Exim's filtering @@ -39,12 +39,12 @@ Exim's interfaces to mail filtering Exim filtering -30 January 2006 +04 April 2006 PhilipHazel PH - 4.60-1 - 30 January 2006 + 4.61 + 04 April 2006 PH 2006University of Cambridge @@ -55,7 +55,7 @@ .chapter "Forwarding and filtering in Exim" This document describes the user interfaces to Exim's in-built mail filtering facilities, and is copyright © University of Cambridge 2006. It -corresponds to Exim version 4.60. +corresponds to Exim version 4.61. diff --git a/doc/doc-docbook/index.html b/doc/doc-docbook/index.html index d8a081333..e3e9128e6 100644 --- a/doc/doc-docbook/index.html +++ b/doc/doc-docbook/index.html @@ -1,5 +1,5 @@ - + Exim 4 Documentation @@ -11,7 +11,7 @@ The following Exim 4 documentation is available in HTML:

diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt index 67d8c830f..a23aab3de 100644 --- a/doc/doc-docbook/spec.xfpt +++ b/doc/doc-docbook/spec.xfpt @@ -1,4 +1,4 @@ -. $Cambridge: exim/doc/doc-docbook/spec.xfpt,v 1.1 2006/02/01 11:01:02 ph10 Exp $ +. $Cambridge: exim/doc/doc-docbook/spec.xfpt,v 1.2 2006/04/04 14:03:49 ph10 Exp $ . . ///////////////////////////////////////////////////////////////////////////// . This is the primary source of the Exim Manual. It is an xfpt document that is @@ -18,8 +18,8 @@ . ///////////////////////////////////////////////////////////////////////////// .set ACL "access control lists (ACLs)" -.set previousversion "4.50" -.set version "4.60" +.set previousversion "4.60" +.set version "4.61" . ///////////////////////////////////////////////////////////////////////////// @@ -51,11 +51,14 @@ . --- is suitable for the many tables at the start of the main options chapter; . --- the small number of other 2-column tables override it. -.macro table2 190pt 300pt +.macro table2 190pt 260pt .itable none 0 0 2 $1 left $2 left .endmacro -. --- Macros for the concept and option index entries +. --- Macros for the concept and option index entries. For a "range" style of +. --- entry, use .scindex for the start and .ecindex for the end. The first +. --- argument of .scindex and the only argument of .ecindex must be the ID +. --- that ties them together. .macro cindex && @@ -66,6 +69,19 @@ && .endmacro +.macro scindex +&& +&&$2&& +.arg 3 +&&$3&& +.endarg +&& +.endmacro + +.macro ecindex +&& +.endmacro + .macro oindex && &&$1&& @@ -90,14 +106,14 @@ Specification of the Exim Mail Transfer Agent The Exim MTA -05 January 2006 +22 March 2006 PhilipHazel PH University of Cambridge Computing Service
New Museums Site, Pembroke Street, Cambridge CB2 3QH, England
- 4.60-1 - 30 January 2006 + 4.61 + 22 March 2006 PH 2006University of Cambridge @@ -313,7 +329,6 @@ Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date with the latest release of Exim. (Note that the earlier book about Exim, published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.) -.new .cindex "Debian" "information sources" If you are using a Debian distribution of Exim, you will find information about Debian-specific features in the file @@ -322,7 +337,6 @@ Debian-specific features in the file .endd The command &(man update-exim.conf)& is another source of Debian-specific information. -.wen .cindex "&_doc/NewStuff_&" .cindex "&_doc/ChangeLog_&" @@ -399,10 +413,8 @@ The following are the three main Exim mailing lists: You can subscribe to these lists, change your existing subscriptions, and view or search the archives via the mailing lists link on the Exim home page. .cindex "Debian" "mailing list for" -&new("If you are using a Debian distribution of Exim, you may wish to subscribe -to the Debian-specific mailing list -&'pkg-exim4-users@lists.alioth.debian.org'&.") -.wen +If you are using a Debian distribution of Exim, you may wish to subscribe to +the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&. .section "Exim training" .cindex "training courses" @@ -676,7 +688,7 @@ monitor using the freely-distributable PCRE library, copyright © University of Cambridge. The source is distributed in the directory &_src/pcre_&. However, this is a cut-down version of PCRE. If you want to use the PCRE library in other programs, you should obtain and install the full -version from &*ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre*&. +version from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre). .next .cindex "cdb" "acknowledgement" Support for the cdb (Constant DataBase) lookup method is provided by code @@ -1063,13 +1075,11 @@ corrected, and can also freeze individual messages by hand if necessary. In addition, an administrator can force a delivery error, causing a bounce message to be sent. -.new .cindex "&%timeout_frozen_after%&" .cindex "&%ignore_bounce_errors_after%&" There are options called &%ignore_bounce_errors_after%& and &%timeout_frozen_after%&, which discard frozen messages after a certain time. The first applies only to frozen bounces, the second to any frozen messages. -.wen .cindex "message" "log file for" .cindex "log" "file for each message" @@ -1260,13 +1270,11 @@ facility for this purpose. .section "Duplicate addresses" -.new .cindex "case of local parts" .cindex "address duplicate" "discarding" Once routing is complete, Exim scans the addresses that are assigned to local and remote transports, and discards any duplicates that it finds. During this check, local parts are treated as case-sensitive. -.wen .section "Router preconditions" "SECTrouprecon" @@ -1543,7 +1551,7 @@ for only a short time (see &%timeout_frozen_after%& and . //////////////////////////////////////////////////////////////////////////// .chapter "Building and installing Exim" -.cindex "building Exim" +.scindex IIDbuex "building Exim" .section "Unpacking" Exim is distributed as a gzipped or bzipped tar file which, when upacked, @@ -1900,7 +1908,6 @@ FAQ, where some common problems are covered. .section 'Output from &"make"&' -.new The output produced by the &'make'& process for compile lines is often very unreadable, because these lines can be very long. For this reason, the normal output is suppressed by default, and instead output similar to that which @@ -1913,7 +1920,6 @@ FULLECHO='' make -e The value of FULLECHO defaults to &"@"&, the flag character that suppresses command reflection in &'make'&. When you ask for the full output, it is given in addition to the the short output. -.wen @@ -2091,8 +2097,7 @@ As with Exim itself, the final three files need not exist, and in this case the variables of the same name, preceded by EXIMON_. For example, setting EXIMON_LOG_DEPTH in the environment overrides the value of LOG_DEPTH at run time. - - +.ecindex IIDbuex .section "Installing Exim binaries and scripts" @@ -2391,8 +2396,8 @@ still be received from local processes, and if automatic delivery is configured . //////////////////////////////////////////////////////////////////////////// .chapter "The Exim command line" "CHAPcommandline" -.cindex "command line" "options" -.cindex "options" "command line" +.scindex IIDclo1 "command line" "options" +.scindex IIDclo2 "options" "command line" Exim's command line takes the standard Unix form of a sequence of options, each starting with a hyphen character, followed by a number of arguments. The options are compatible with the main options of Sendmail, and there are also @@ -2592,7 +2597,7 @@ from the controlling terminal, even when no debugging is specified. Run Exim in expansion testing mode. Exim discards its root privilege, to prevent ordinary users from using this mode to read otherwise inaccessible files. If no arguments are given, Exim runs interactively, prompting for lines -of data. &new("Otherwise, it processes each argument in turn.") +of data. Otherwise, it processes each argument in turn. If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries to load the &%libreadline%& library dynamically whenever the &%-be%& option is @@ -2608,12 +2613,10 @@ configuration file (for example, &$qualify_domain$&) are available, but no message-specific values (such as &$domain$&) are set, because no message is being processed. -.new &*Note*&: If you use this mechanism to test lookups, and you change the data files or databases you are using, you must exit and restart Exim before trying the same lookup again. Otherwise, because each Exim process caches the results of lookups, you will just get the same result as before. -.wen .vitem &%-bF%&&~<&'filename'&> .oindex "&%-bF%&" @@ -2977,15 +2980,21 @@ and to write it to the standard output. For example: exim -brt bach.comp.mus.example Retry rule: *.comp.mus.example F,2h,15m; F,4d,30m; .endd +.new See chapter &<>& for a description of Exim's retry rules. The first argument, which is required, can be a complete address in the form -&'local_part@domain'&, or it can be just a domain name. The second argument is -an optional second domain name; if no retry rule is found for the first -argument, the second is tried. This ties in with Exim's behaviour when looking -for retry rules for remote hosts &-- if no rule is found that matches the host, -one that matches the mail domain is sought. The final argument is the name of a -specific delivery error, as used in setting up retry rules, for example -&"quota_3d"&. +&'local_part@domain'&, or it can be just a domain name. If the second argument +contains a dot, it is interpreted as an optional second domain name; if no +retry rule is found for the first argument, the second is tried. This ties in +with Exim's behaviour when looking for retry rules for remote hosts &-- if no +rule is found that matches the host, one that matches the mail domain is +sought. Finally, an argument that is the name of a specific delivery error, as +used in setting up retry rules, can be given. For example: +.code +exim -brt haydn.comp.mus.example quota_3d +Retry rule: *@haydn.comp.mus.example quota_3d F,1h,15m +.endd +.wen .vitem &%-brw%& .oindex "&%-brw%&" @@ -3294,14 +3303,12 @@ The available debugging categories are: &`verify `& address verification logic &`all `& almost all of the above (see below), and also &%-v%& .endd -.new 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`& is included, an awful lot of output that is very rarely of interest is generated, so it now has to be explicitly requested. However, &`-all`& does turn everything off. -.wen .cindex "resolver" "debugging output" .cindex "DNS resolver" "debugging output" @@ -3448,12 +3455,10 @@ to be an admin user. However, there is an option called &%prod_requires_admin%& which can be set false to relax this restriction (and also the same requirement for the &%-q%&, &%-R%&, and &%-S%& options). -.new The deliveries happen synchronously, that is, the original Exim process does not terminate until all the delivery attempts have finished. No output is produced unless there is a serious error. If you want to see what is happening, use the &%-v%& option as well, or inspect Exim's main log. -.wen .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~... .oindex "&%-Mar%&" @@ -3465,7 +3470,7 @@ id, and the remaining ones must be email addresses. However, if the message is active (in the middle of a delivery attempt), it is not altered. This option can be used only by an admin user. -.vitem "&*-MC*&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&& +.vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&& &~<&'message&~id'&>" .oindex "&%-MC%&" .cindex "SMTP" "passed connection" @@ -4176,7 +4181,6 @@ recognized when Exim is run normally. It allows for the setting up of explicit &"queue times"& so that various warning/retry features can be tested. .vitem &%-t%& -.new .oindex "&%-t%&" .cindex "recipient" "extracting from header lines" .cindex "&'Bcc:'& header line" @@ -4187,7 +4191,6 @@ input, the &%-t%& option causes the recipients of the message to be obtained from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of from the command arguments. The addresses are extracted before any rewriting takes place and the &'Bcc:'& header line, if present, is then removed. -.wen .cindex "Sendmail compatibility" "&%-t%& option" If the command has any arguments, they specify addresses to which the message @@ -4218,12 +4221,12 @@ are often added at the end of the header, and if a message is resent more than once, it is common for the original set of &%Resent-%& headers to be renamed as &%X-Resent-%& when a new set is added. This removes any possible ambiguity. -.vitem &*-ti*& +.vitem &%-ti%& .oindex "&%-ti%&" This option is exactly equivalent to &%-t%& &%-i%&. It is provided for compatibility with Sendmail. -.vitem &*-tls-on-connect*& +.vitem &%-tls-on-connect%& .oindex "&%-tls-on-connect%&" .cindex "TLS" "use without STARTTLS" .cindex "TLS" "automatic start" @@ -4233,7 +4236,7 @@ incoming SMTP connections to behave as if the incoming port is listed in the &<>& for further details. -.vitem &*-U*& +.vitem &%-U%& .oindex "&%-U%&" .cindex "Sendmail compatibility" "&%-U%& option ignored" Sendmail uses this option for &"initial message submission"&, and its @@ -4241,7 +4244,7 @@ documentation states that in future releases, it may complain about syntactically invalid messages rather than fixing them when this flag is not set. Exim ignores this option. -.vitem &*-v*& +.vitem &%-v%& .oindex "&%-v%&" This option causes Exim to write information to the standard error stream, describing what it is doing. In particular, it shows the log lines for @@ -4251,7 +4254,7 @@ the log if the setting of &%log_selector%& discards them. Any relevant selectors are shown with each log line. If none are shown, the logging is unconditional. -.vitem &*-x*& +.vitem &%-x%& .oindex "&%-x%&" AIX uses &%-x%& for a private purpose (&"mail from a local mail program has National Language Support extended characters in the body of the mail item"&). @@ -4259,6 +4262,10 @@ It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores this option. .endlist +.ecindex IIDclo1 +.ecindex IIDclo2 + + . //////////////////////////////////////////////////////////////////////////// . Insert a stylized DocBook comment here, to identify the end of the command . line options. This is for the benefit of the Perl script that automatically @@ -4456,9 +4463,12 @@ using this syntax: &`.include`& <&'file name'&> &`.include_if_exists`& <&'file name'&> .endd +.new on a line by itself. Double quotes round the file name are optional. If you use the first form, a configuration error occurs if the file does not exist; the -second form does nothing for non-existent files. +second form does nothing for non-existent files. In all cases, an absolute file +name is required. +.wen Includes may be nested to any depth, but remember that Exim reads its configuration file often, so it is a good idea to keep them to a minimum. @@ -4473,8 +4483,8 @@ hosts_lookup = a.b.c \ .include /some/file .endd Include processing happens after macro processing (see below). Its effect is to -process the lines of the file as if they occurred inline where the inclusion -appears. +process the lines of the included file as if they occurred inline where the +inclusion appears. @@ -4493,11 +4503,9 @@ continuations, is the replacement text, and has leading and trailing white space removed. Quotes are not removed. The replacement text can never end with a backslash character, but this doesn't seem to be a serious limitation. -.new Macros may also be defined between router, transport, authenticator, or ACL definitions. They may not, however, be defined within an individual driver or ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration. -.wen .section "Macro substitution" Once a macro is defined, all subsequent lines in the file (and any included @@ -4519,7 +4527,6 @@ line is ignored. A macro at the start of a line may turn the line into a comment line or a &`.include`& line. -.new .section "Redefining macros" Once defined, the value of a macro can be redefined later in the configuration (or in an included file). Redefinition is specified by using &'=='& instead of @@ -4540,7 +4547,6 @@ MAC == MAC and something added .endd This can be helpful in situations where the configuration file is built from a number of other files. -.wen .section "Overriding macro values" The values set for macros in the configuration file can be overridden by the @@ -4802,12 +4808,10 @@ local_interfaces = 127.0.0.1 : ::::1 .endd contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1. -.new &*Note*&: Although leading and trailing white space is ignored in individual list items, it is not ignored when parsing the list. The space after the first colon in the example above is necessary. If it were not there, the list would be interpreted as the two items 127.0.0.1:: and 1. -.wen .cindex "list separator" "changing" .cindex "IPv6" "addresses in lists" @@ -4942,7 +4946,7 @@ option. . //////////////////////////////////////////////////////////////////////////// .chapter "The default configuration file" "CHAPdefconfil" -.cindex "configuration file" "default &""walk through""&" +.scindex IIDconfiwal "configuration file" "default &""walk through""&" .cindex "default" "configuration file &""walk through""&" The default configuration file supplied with Exim as &_src/configure.default_& is sufficient for a host with simple mail requirements. As an introduction to @@ -5011,7 +5015,6 @@ The next two configuration lines are genuine option settings: acl_smtp_rcpt = acl_check_rcpt acl_smtp_data = acl_check_data .endd -.new These options specify &'Access Control Lists'& (ACLs) that are to be used during an incoming SMTP session for every recipient of a message (every RCPT command), and after the contents of the message have been received, @@ -5031,7 +5034,6 @@ These are example settings that can be used when Exim is compiled with the content-scanning extension. The first specifies the interface to the virus scanner, and the second specifies the interface to SpamAssassin. Further details are given in chapter &<>&. -.wen Two more commented-out options settings follow: .code @@ -5256,7 +5258,6 @@ discusses the details of address verification. accept hosts = +relay_from_hosts control = submission .endd -.new This statement accepts the address if the message is coming from one of the hosts that are defined as being allowed to relay through this host. Recipient verification is omitted here, because in many cases the clients are dumb MUAs @@ -5276,7 +5277,6 @@ likely to come from MUAs. The default configuration does not define any authenticators, which means that no client can in fact authenticate. You will need to add authenticator definitions if you want to make use of this ACL statement. -.wen .code # deny message = rejected because $sender_host_address \ # is in a black list at $dnslist_domain\n\ @@ -5322,7 +5322,6 @@ message &"administrative prohibition"&. .code acl_check_data: .endd -.new This line marks the start of the second ACL, and names it. Most of the contents of this ACL are commented out: .code @@ -5351,7 +5350,6 @@ whatever the spam score. accept .endd This final line in the DATA ACL accepts the message unconditionally. -.wen .section "Router configuration" @@ -5455,7 +5453,6 @@ userforward: pipe_transport = address_pipe reply_transport = address_reply .endd -.new This is the most complicated router in the default configuration. It is another redirection router, but this time it is looking for forwarding data set up by individual users. The &%check_local_user%& setting specifies a check that the @@ -5473,7 +5470,6 @@ by any sequence of characters, is removed from the local part and placed in the variable &$local_part_suffix$&. The second suffix option specifies that the presence of a suffix in the local part is optional. When a suffix is present, the check for a local login uses the local part with the suffix removed. -.wen When a local user account is found, the file called &_.forward_& in the user's home directory is consulted. If it does not exist, or is empty, the router @@ -5525,13 +5521,11 @@ localuser: # local_part_suffix_optional transport = local_delivery .endd -.new The final router sets up delivery into local mailboxes, provided that the local part is the name of a local login, by accepting the address and assigning it to the &(local_delivery)& transport. Otherwise, we have reached the end of the routers, so the address is bounced. The commented suffix settings fulfil the same purpose as they do for the &(userforward)& router. -.wen .section "Transport configuration" @@ -5637,6 +5631,7 @@ begin authenticators .endd defines mechanisms for the use of the SMTP AUTH command. No authenticators are specified in the default configuration file. +.ecindex IIDconfiwal @@ -5745,8 +5740,8 @@ in &$1$& and the &"ac"& or &"edu"& in &$2$&. . //////////////////////////////////////////////////////////////////////////// .chapter "File and database lookups" "CHAPfdlookup" -.cindex "file" "lookup" -.cindex "database lookups" +.scindex IIDfidalo1 "file" "lookups" +.scindex IIDfidalo2 "database lookups" .cindex "lookup" "description of" Exim can be configured to look up data in files or databases as it processes messages. Two different kinds of syntax are used: @@ -5765,14 +5760,12 @@ succeeds or fails is what really counts. These kinds of list are described in chapter &<>&. .endlist -.new String expansions, lists, and lookups interact with each other in such a way that there is no order in which to describe any one of them that does not involve references to the others. Each of these three chapters makes more sense if you have read the other two first. If you are reading this for the first time, be aware that some of it will make a lot more sense after you have read chapters &<>& and &<>&. -.wen .section "Examples of different lookup syntax" It is easy to confuse the two different kinds of lookup, especially as the @@ -5783,13 +5776,11 @@ Be careful to distinguish between the following two examples: domains = ${lookup{$sender_host_address}lsearch{/some/file}} domains = lsearch;/some/file .endd -.new The first uses a string expansion, the result of which must be a domain list. No strings have been specified for a successful or a failing lookup; the defaults in this case are the looked-up data and an empty string, respectively. The expansion takes place before the string is processed as a list, and the file that is searched could contain lines like this: -.wen .code 192.168.3.4: domain1:domain2:... 192.168.1.9: domain3:domain4:... @@ -6109,12 +6100,10 @@ password value. For example: PostgreSQL database. See section &<>&. .next -.new .cindex "sqlite lookup type" .cindex "lookup" "sqlite" &(sqlite)&: The format of the query is a file name followed by an SQL statement that is passed to an SQLite database. See section &<>&. -.wen .next &(testdb)&: This is a lookup type that is used for testing Exim. It is @@ -6132,12 +6121,10 @@ statements such as require condition = \ ${lookup whoson {$sender_host_address}{yes}{no}} .endd -.new The query consists of a single IP address. The value returned is the name of the authenticated user, which is stored in the variable &$value$&. However, in this example, the data in &$value$& is not used; the result of the lookup is one of the fixed strings &"yes"& or &"no"&. -.wen .endlist @@ -6369,12 +6356,10 @@ an expansion string could contain: .code ${lookup dnsdb{mx=a.b.example}{$value}fail} .endd -.new If the lookup succeeds, the result is placed in &$value$&, which in this case is used on its own as the result. If the lookup succeeds, the &`fail`& keyword causes a &'forced expansion failure'& &-- see section &<>& for an explanation of what this means. -.wen The supported DNS record types are A, CNAME, MX, NS, PTR, SRV, and TXT, and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also @@ -6439,7 +6424,6 @@ given domain are on a blacklist. You can probably assume that the name servers for the high-level domains such as &%com%& or &%co.uk%& are not going to be on such a list. -.new .cindex "CSA" "in &(dnsdb)& lookup" A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV records according to the CSA rules, which are described in section @@ -6452,7 +6436,6 @@ ${lookup dnsdb {csa=$sender_helo_name}} has two space-separated fields: an authorization code and a target host name. The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit authorization required but absent, or &"?"& for unknown. -.wen .section "Multiple dnsdb lookups" @@ -6845,12 +6828,10 @@ operator is to double any quote characters within the text. .section "SQL lookups" "SECTsql" -.new .cindex "SQL lookup types" Exim can support lookups in Interbase, MySQL, Oracle, PostgreSQL, and SQLite databases. Queries for these databases contain SQL statements, so an example might be -.wen .code ${lookup mysql{select mailbox from users where id='userx'}\ {$value}fail} @@ -6955,7 +6936,6 @@ If a PostgreSQL query is issued that does not request any data (an insert, update, or delete command), the result of the lookup is the number of rows affected. -.new .section "More about SQLite" "SECTsqlite" .cindex "lookup" "SQLite" .cindex "SQLite lookup type" @@ -6984,7 +6964,8 @@ are rejected after a timeout period, during which the SQLite library waits for the lock to be released. In Exim, the default timeout is set to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%& option. -.wen +.ecindex IIDfidalo1 +.ecindex IIDfidalo2 . //////////////////////////////////////////////////////////////////////////// @@ -6993,7 +6974,7 @@ option. .chapter "Domain, host, address, and local part lists" &&& "CHAPdomhosaddlists" &&& "Domain, host, and address lists" -.cindex "list of domains; hosts; etc." +.scindex IIDdohoadli "lists of domains; hosts; etc." A number of Exim configuration options contain lists of domains, hosts, email addresses, or local parts. For example, the &%hold_domains%& option contains a list of domains whose delivery is currently suspended. These lists @@ -7039,7 +7020,7 @@ senders based on the receiving domain. .section "Negated items in lists" .cindex "list" "negation" -.cindex "negation in lists" +.cindex "negation" "in lists" Items in a list may be positive or negative. Negative items are indicated by a leading exclamation mark, which may be followed by optional white space. A list defines a set of items (domains, etc). When Exim processes one of these lists, @@ -7711,8 +7692,11 @@ Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same list. The effect of each one lasts until the next, or until the end of the list. +.new &*Note*&: This section applies to permanent lookup failures. It does &'not'& -apply to temporary DNS errors. They always cause a defer action. +apply to temporary DNS errors. They always cause a defer action (except when +&%dns_again_means_nonexist%& converts them into permanent errors). +.wen @@ -7818,14 +7802,45 @@ data, the list is empty and matches nothing. The empty sender can also be detected by a regular expression that matches an empty string, and by a query-style lookup that succeeds when &$sender_address$& is empty. -The following kinds of address list pattern can match any address, including -the empty address that is characteristic of bounce message senders: +.new +Non-empty items in an address list can be straightforward email addresses. For +example: +.code +senders = jbc@askone.example : hs@anacreon.example +.endd +A certain amount of wildcarding is permitted. If a pattern contains an @ +character, but is not a regular expression and does not begin with a +semicolon-terminated lookup type (described below), the local part of the +subject address is compared with the local part of the pattern, which may start +with an asterisk. If the local parts match, the domain is checked in exactly +the same way as for a pattern in a domain list. For example, the domain can be +wildcarded, refer to a named list, or be a lookup: +.code +deny senders = *@*.spamming.site:\ + *@+hostile_domains:\ + bozo@partial-lsearch;/list/of/dodgy/sites:\ + *@dbm;/bad/domains.db +.endd +.cindex "local part" "starting with !" +.cindex "address list" "local part starting with !" +If a local part that begins with an exclamation mark is required, it has to be +specified using a regular expression, because otherwise the exclamation mark is +treated as a sign of negation, as is standard in lists. + +If a non-empty pattern that is not a regular expression or a lookup does not +contain an @ character, it is matched against the domain part of the subject +address. The only two formats that are recognized this way are a literal +domain, or a domain pattern that starts with *. In both these cases, the effect +is the same as if &`*@`& preceded the pattern. For example: +.code +deny senders = enemy.domain : *.enemy.domain +.endd -.ilist -As explained above, if a pattern item is empty, it matches the empty address -(and no others). +The following kinds of more complicated address list pattern can match any +address, including the empty address that is characteristic of bounce message +senders: -.next +.ilist .cindex "regular expressions" "in address list" .cindex "address list" "regular expression in" If (after expansion) a pattern starts with &"^"&, a regular expression match is @@ -7834,10 +7849,12 @@ You must take care that backslash and dollar characters are not misinterpreted as part of the string expansion. The simplest way to do this is to use &`\N`& to mark that part of the string as non-expandable. For example: .code -deny senders = \N^\d{8}.+@spamhaus.example$\N : ... +deny senders = \N^.*this.*@example\.com$\N : \ + \N^\d{8}.+@spamhaus.example$\N : ... .endd -The &`\N`& sequences are removed by the expansion, so this item does indeed -start with &"^"& by the time it is being interpreted as an address pattern. +The &`\N`& sequences are removed by the expansion, so these items do indeed +start with &"^"& by the time they are being interpreted as address patterns. +.wen .next .cindex "address list" "lookup for complete address" @@ -7956,31 +7973,6 @@ them, the chains may be no more than fifty items long. The @@<&'lookup'&> style of item can also be used with a query-style lookup, but in this case, the chaining facility is not available. The lookup can only return a single list of local parts. -.next -If a pattern contains an @ character, but is not a regular expression and does -not begin with a lookup type as described above, the local part of the subject -address is compared with the local part of the pattern, which may start with an -asterisk. If the local parts match, the domain is checked in exactly the same -way as for a pattern in a domain list. For example, the domain can be -wildcarded, refer to a named list, or be a lookup: -.code -deny senders = *@*.spamming.site:\ - *@+hostile_domains:\ - bozo@partial-lsearch;/list/of/dodgy/sites:\ - *@dbm;/bad/domains.db -.endd -.cindex "local part" "starting with !" -.cindex "address list" "local part starting with !" -If a local part that begins with an exclamation mark is required, it has to be -specified using a regular expression, because otherwise the exclamation mark is -treated as a sign of negation. -.next -If a pattern is not one of the above syntax forms, that is, if a -non-empty pattern that is not a regular expression or a lookup does not contain -an @ character, it is matched against the domain part of the subject address. -The only two formats that are recognized this way are a literal domain, or a -domain pattern that starts with *. In both these cases, the effect is the same -as if &`*@`& preceded the pattern. .endlist &*Warning*&: There is an important difference between the address list items @@ -8047,6 +8039,7 @@ that the special items that refer to the local host (&`@`&, &`@[]`&, &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized. Refer to section &<>& for details of the other available item types. +.ecindex IIDdohoadli @@ -8055,7 +8048,7 @@ types. . //////////////////////////////////////////////////////////////////////////// .chapter "String expansions" "CHAPexpand" -.cindex "expansion" "of strings" +.scindex IIDstrexp "expansion" "of strings" Many strings in Exim's run time configuration are expanded before use. Some of them are expanded every time they are used; others are expanded only once. @@ -8172,10 +8165,9 @@ below. The operator notation is used for simple expansion items that have just one argument, because it reduces the number of braces and therefore makes the string easier to understand. -.new .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&& {*&<&'arg'&>&*}...}*&" - +.cindex &%dlfunc%& This expansion dynamically loads and then calls a locally-written C function. This functionality is available only if Exim is compiled with .code @@ -8210,11 +8202,11 @@ taken from &'yield'& if it is set. When compiling a function that is to be used in this way with gcc, you need to add &%-shared%& to the gcc command. Also, in the Exim build-time configuration, you must add &%-export-dynamic%& to EXTRALIBS. -.wen .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&& {*&<&'string3'&>&*}}*&" .cindex "expansion" "extracting substrings by key" +.cindex "&%extract%&" "substrings by key" The key and <&'string1'&> are first expanded separately. Leading and trailing white space is removed from the key (but not from any of the strings). The key must not consist entirely of digits. The expanded <&'string1'&> must be of the @@ -8253,6 +8245,7 @@ This forces an expansion failure (see section &<>&); .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&& {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" .cindex "expansion" "extracting substrings by number" +.cindex "&%extract%&" "substrings by number" The <&'number'&> argument must consist entirely of decimal digits, apart from leading and trailing white space, which is ignored. This is what distinguishes this form of &%extract%& from the previous kind. It @@ -8410,6 +8403,7 @@ expansion. .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*& .cindex "expansion" "hmac hashing" +.cindex &%hmac%& This function uses cryptographic hashing (either MD5 or SHA-1) to convert a shared secret and some text into a message authentication code, as specified in RFC 2104. This differs from &`${md5:secret_text...}`& or @@ -8447,6 +8441,7 @@ using Exim's &%-be%& option, or by other means, for example by using the .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*& .cindex "expansion" "conditional" +.cindex "&%if%&, expansion item" If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole item; otherwise <&'string2'&> is used. The available conditions are described in section &<>& below. For example: @@ -8472,6 +8467,7 @@ condition = ${if >{$acl_m4}{3}} .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*& .cindex "expansion" "string truncation" +.cindex "&%length%&" "expansion item" The &%length%& item is used to extract the initial portion of a string. Both strings are expanded, and the first one must yield a number, <&'n'&>, say. If you are using a fixed value for the number, that is, if <&'string1'&> does not @@ -8493,7 +8489,7 @@ described in the next item. .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&& {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" .cindex "expansion" "lookup in" -.cindex "file" "lookup" +.cindex "file" "lookups" .cindex "lookup" "in expanded string" The two forms of lookup item specify data lookups in files and databases, as discussed in chapter &<>&. The first form is used for single-key @@ -8592,7 +8588,6 @@ The &(redirect)& router has an option called &%forbid_filter_perl%& which locks out the use of this expansion item in filter files. -.new .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*& .cindex "prvs" "expansion item" The first argument is a complete email address and the second is secret @@ -8601,9 +8596,7 @@ it defaults to 0. The result of the expansion is a prvs-signed email address, to be typically used with the &%return_path%& option on an &(smtp)& transport as part of a bounce address tag validation (BATV) scheme. For more discussion and an example, see section &<>&. -.wen -.new .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&& {*&<&'string'&>&*}}*&" .cindex "prvscheck" "expansion item" @@ -8629,11 +8622,11 @@ is the expansion of the third argument. All three variables can be used in the expansion of the third argument. However, once the expansion is complete, only &$prvscheck_result$& remains set. For more discussion and an example, see section &<>&. -.wen .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*& .cindex "expansion" "inserting an entire file" .cindex "file" "inserting into expansion" +.cindex "&%readfile%& expansion item" The file name and end-of-line string are first expanded separately. The file is then read, and its contents replace the entire item. All newline characters in the file are replaced by the end-of-line string if it is present. Otherwise, @@ -8651,6 +8644,7 @@ locks out the use of this expansion item in filter files. {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&" .cindex "expansion" "inserting from a socket" .cindex "socket" "use of in expansion" +.cindex "&%readsocket%& expansion item" This item inserts data that is read from a Unix domain socket into the expanded string. The minimal way of using it uses just two arguments: .code @@ -8706,12 +8700,12 @@ expansion item above. .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&& {*&<&'string2'&>&*}}*&" .cindex "expansion" "running a command" +.cindex "&%run%& expansion item" The command and its arguments are first expanded separately, and then the command is run in a separate process, but under the same uid and gid. As in other command executions from Exim, a shell is not used by default. If you want a shell, you must explicitly code it. -.new .cindex "return code" "from &%run%& expansion" .cindex "&$value$&" If the command succeeds (gives a zero return code) <&'string1'&> is expanded @@ -8723,7 +8717,6 @@ is absent, the result is empty. Alternatively, <&'string2'&> can be the word &"fail"& (not in braces) to force expansion failure if the command does not succeed. If both strings are omitted, the result is contents of the standard output on success, and nothing on failure. -.wen .cindex "&$runrc$&" The return code from the command is put in the variable &$runrc$&, and this @@ -8749,6 +8742,7 @@ out the use of this expansion item in filter files. .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*& .cindex "expansion" "string substitution" +.cindex "&%sg%& expansion item" This item works like Perl's substitution operator (s) with the global (/g) option; hence its name. However, unlike the Perl equivalent, Exim does not modify the subject string; instead it returns the modified string for insertion @@ -8831,6 +8825,7 @@ yields all but the last character of the string, that is, &"abcd"&. .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&& {*&<&'replacements'&>&*}}*&" .cindex "expansion" "character translation" +.cindex "&%tr%& expansion item" This item does single-character translation on its subject string. The second argument is a list of characters to be translated in the subject string. Each matching character is replaced by the corresponding character from the @@ -8856,14 +8851,14 @@ following operations can be performed: .vlist .vitem &*${address:*&<&'string'&>&*}*& .cindex "expansion" "RFC 2822 address handling" +.cindex "&%address%&" "expansion item" The string is interpreted as an RFC 2822 address, as it might appear in a header line, and the effective address is extracted from it. If the string does not parse successfully, the result is empty. -.new .vitem &*${base62:*&<&'digits'&>&*}*& -.cindex "base62" +.cindex "&%base62%&" .cindex "expansion" "conversion to base 62" The string must consist entirely of decimal digits. The number is converted to base 62 and output as a string of six characters, including leading zeros. In @@ -8871,17 +8866,14 @@ the few operating environments where Exim uses base 36 instead of base 62 for its message identifiers (because those systems do not have case-sensitive file names), base 36 is used by this operator, despite its name. &*Note*&: Just to be absolutely clear: this is &'not'& base64 encoding. -.wen -.new .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*& -.cindex "base62" +.cindex "&%base62d%&" .cindex "expansion" "conversion to base 62" The string must consist entirely of base-62 digits, or, in operating environments where Exim uses base 36 instead of base 62 for its message identifiers, base-36 digits. The number is converted to decimal and output as a string. -.wen .vitem &*${domain:*&<&'string'&>&*}*& .cindex "domain" "extraction" @@ -8892,6 +8884,7 @@ from it. If the string does not parse successfully, the result is empty. .vitem &*${escape:*&<&'string'&>&*}*& .cindex "expansion" "escaping non-printing characters" +.cindex "&%escape%&, expansion item" If the string contains any non-printing characters, they are converted to escape sequences starting with a backslash. Whether characters with the most significant bit set (so-called &"8-bit characters"&) count as printing or not @@ -8901,14 +8894,13 @@ is controlled by the &%print_topbitchars%& option. .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*& .cindex "expansion" "expression evaluation" .cindex "expansion" "arithmetic expression" -.new +.cindex "&%eval%& expansion item" These items supports simple arithmetic in expansion strings. The string (after expansion) must be a conventional arithmetic expression, but it is limited to five basic operators (plus, minus, times, divide, remainder) and parentheses. All operations are carried out using integer arithmetic. Plus and minus have a lower priority than times, divide, and remainder; operators with the same priority are evaluated from left to right. -.wen For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as @@ -8920,14 +8912,12 @@ A number may be followed by &"K"& or &"M"& to multiply it by 1024 or 1024*1024, respectively. Negative numbers are supported. The result of the computation is a decimal representation of the answer (without &"K"& or &"M"&). For example: -.new .display &`${eval:1+1} `& yields 2 &`${eval:1+2*3} `& yields 7 &`${eval:(1+2)*3} `& yields 9 &`${eval:2+42%5} `& yields 4 .endd -.wen As a more realistic example, in an ACL you might have .code @@ -8961,6 +8951,7 @@ and then re-expands what it has found. .cindex "Unicode" .cindex "UTF-8" "conversion from" .cindex "expansion" "UTF-8 conversion" +.cindex "&%from_utf8%&" The world is slowly moving towards Unicode, although there are no standards for email yet. However, other applications (including some databases) are starting to store data in Unicode, using UTF-8 encoding. This operator converts from a @@ -8994,6 +8985,7 @@ abbreviation &%h%& can be used when &%hash%& is used as an operator. .vitem &*${hex2b64:*&<&'hexstring'&>&*}*& .cindex "base64 encoding" "conversion from hex" .cindex "expansion" "hex to base64" +.cindex "&%hex2b64%&" This operator converts a hex string into one that is base64 encoded. This can be useful for processing the output of the MD5 and SHA-1 hashing functions. @@ -9003,6 +8995,7 @@ be useful for processing the output of the MD5 and SHA-1 hashing functions. .cindex "string" "case forcing" .cindex "lower casing" .cindex "expansion" "case forcing" +.cindex "&%lc%& expansion item" This forces the letters in the string into lower-case, for example: .code ${lc:$local_part} @@ -9010,6 +9003,7 @@ ${lc:$local_part} .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*& .cindex "expansion" "string truncation" +.cindex "&%length%&" "expansion item" The &%length%& operator is a simpler interface to the &%length%& function that can be used when the parameter is a fixed number (as opposed to a string that changes when expanded). The effect is the same as @@ -9023,6 +9017,7 @@ when &%length%& is used as an operator. .vitem &*${local_part:*&<&'string'&>&*}*& .cindex "expansion" "local part extraction" +.cindex "&%local_part%& expansion item" The string is interpreted as an RFC 2822 address and the local part is extracted from it. If the string does not parse successfully, the result is empty. @@ -9033,6 +9028,7 @@ empty. .cindex "IP address" "masking" .cindex "CIDR notation" .cindex "expansion" "IP address masking" +.cindex "&%mask%&, expansion item" If the form of the string to be operated on is not an IP address followed by a slash and an integer (that is, a network address in CIDR notation), the expansion fails. Otherwise, this operator converts the IP address to binary, @@ -9058,6 +9054,7 @@ Letters in IPv6 addresses are always output in lower case. .vitem &*${md5:*&<&'string'&>&*}*& .cindex "MD5 hash" .cindex "expansion" "MD5 hash" +.cindex "&%md5%& expansion item" The &%md5%& operator computes the MD5 hash value of the string, and returns it as a 32-digit hexadecimal number, in which any letters are in lower case. @@ -9077,6 +9074,7 @@ See the description of the general &%nhash%& item above for details. .vitem &*${quote:*&<&'string'&>&*}*& .cindex "quoting" "in string expansions" .cindex "expansion" "quoting" +.cindex "&%quote%&, expansion item" The &%quote%& operator puts its argument into double quotes if it is an empty string or contains anything other than letters, digits, underscores, dots, and hyphens. @@ -9094,6 +9092,7 @@ The place where this is useful is when the argument is a substitution from a variable or a message header. .vitem &*${quote_local_part:*&<&'string'&>&*}*& +.cindex "&%quote_local_part%& expansion item" This operator is like &%quote%&, except that it quotes the string only if required to do so by the rules of RFC 2822 for quoting local parts. For example, a plus sign would not cause quoting (but it would for &%quote%&). @@ -9120,6 +9119,7 @@ yields an unchanged string. .vitem &*${rxquote:*&<&'string'&>&*}*& .cindex "quoting" "in regular expressions" .cindex "regular expressions" "quoting" +.cindex "&%rxquote%& expansion item" The &%rxquote%& operator inserts a backslash before any non-alphanumeric characters in its argument. This is useful when substituting the values of variables or headers inside regular expressions. @@ -9128,6 +9128,7 @@ variables or headers inside regular expressions. .vitem &*${rfc2047:*&<&'string'&>&*}*& .cindex "expansion" "RFC 2047" .cindex "RFC 2047" "expansion operator" +.cindex "&%rfc2047%& expansion item" This operator encodes text according to the rules of RFC 2047. This is an encoding that is used in header lines to encode non-ASCII characters. It is assumed that the input string is in the encoding specified by the @@ -9146,6 +9147,7 @@ characters. .vitem &*${sha1:*&<&'string'&>&*}*& .cindex "SHA-1 hash" .cindex "expansion" "SHA-1 hashing" +.cindex "&%sha2%& expansion item" The &%sha1%& operator computes the SHA-1 hash value of the string, and returns it as a 40-digit hexadecimal number, in which any letters are in upper case. @@ -9153,6 +9155,7 @@ it as a 40-digit hexadecimal number, in which any letters are in upper case. .vitem &*${stat:*&<&'string'&>&*}*& .cindex "expansion" "statting a file" .cindex "file" "extracting characteristics" +.cindex "&%stat%& expansion item" The string, after expansion, must be a file path. A call to the &[stat()]& function is made for this path. If &[stat()]& fails, an error occurs and the expansion fails. If it succeeds, the data from the stat replaces the item, as a @@ -9163,15 +9166,14 @@ a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You can extract individual fields using the &%extract%& expansion item. -.new The use of the &%stat%& expansion in users' filter files can be locked out by the system administrator. &*Warning*&: The file size may be incorrect on 32-bit systems for files larger than 2GB. -.wen .vitem &*${str2b64:*&<&'string'&>&*}*& .cindex "expansion" "base64 encoding" .cindex "base64 encoding" "in string expansion" +.cindex "&%str2b64%& expansion item" This operator converts a string into one that is base64 encoded. @@ -9179,12 +9181,13 @@ This operator converts a string into one that is base64 encoded. .vitem &*${strlen:*&<&'string'&>&*}*& .cindex "expansion" "string length" .cindex "string" "length in expansion" +.cindex "&%strlen%& expansion item" The item is replace by the length of the expanded string, expressed as a decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&. .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*& -.cindex "&%substr%&" +.cindex "&%substr%& expansion item" .cindex "substring extraction" .cindex "expansion" "substring expansion" The &%substr%& operator is a simpler interface to the &%substr%& function that @@ -9196,8 +9199,16 @@ ${substr{}{}{}} See the description of the general &%substr%& item above for details. The abbreviation &%s%& can be used when &%substr%& is used as an operator. +.new +.vitem &*${time_eval:*&<&'string'&>&*}*& +.cindex "&%time_eval%& expansion item" +.cindex "time interval" "decoding" +This item converts an Exim time interval such as &`2d4h5m`& into a number of +seconds. +.wen + .vitem &*${time_interval:*&<&'string'&>&*}*& -.cindex "&%time_interval%&" +.cindex "&%time_interval%& expansion item" .cindex "time interval" "formatting" The argument (after sub-expansion) must be a sequence of decimal digits that represents an interval of time as a number of seconds. It is converted into a @@ -9209,6 +9220,7 @@ number of larger units and output in Exim's normal time format, for example, .cindex "string" "case forcing" .cindex "upper casing" .cindex "expansion" "case forcing" +.cindex "&%uc%& expansion item" This forces the letters in the string into upper-case. .endlist @@ -9225,6 +9237,7 @@ while expanding strings: .vlist .vitem &*!*&<&'condition'&> .cindex "expansion" "negating a condition" +.cindex "negation" "in expansion condition" Preceding any condition with an exclamation mark negates the result of the condition. @@ -9253,6 +9266,7 @@ lower case), signifying multiplication by 1024 or 1024*1024, respectively. .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& .cindex "expansion" "encrypted comparison" .cindex "encrypted strings" "comparing" +.cindex "&%crypteq%& expansion condition" This condition is included in the Exim binary if it is built to support any authentication mechanisms (see chapter &<>&). Otherwise, it is necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%& @@ -9328,6 +9342,7 @@ longer than 8 characters. .vitem &*def:*&<&'variable&~name'&> .cindex "expansion" "checking for empty variable" +.cindex "&%def%& expansion condition" The &%def%& condition must be followed by the name of one of the expansion variables defined in section &<>&. The condition is true if the variable does not contain the empty string. For example: @@ -9351,18 +9366,21 @@ the header name must be terminated by a colon if white space does not follow. .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& .cindex "string" "comparison" .cindex "expansion" "string comparison" +.cindex "&%eq%& expansion condition" The two substrings are first expanded. The condition is true if the two resulting strings are identical, including the case of letters. .vitem &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& .cindex "string" "comparison" .cindex "expansion" "string comparison" +.cindex "&%eqi%& expansion condition" The two substrings are first expanded. The condition is true if the two resulting strings are identical when compared in a case-independent way. .vitem &*exists&~{*&<&'file&~name'&>&*}*& .cindex "expansion" "file existence test" .cindex "file" "existence test" +.cindex "&%exists%&, expansion condition" The substring is first expanded and then interpreted as an absolute path. The condition is true if the named file (or directory) exists. The existence test is done by calling the &[stat()]& function. The use of the &%exists%& test in @@ -9372,40 +9390,48 @@ users' filter files may be locked out by the system administrator. .cindex "delivery" "first" .cindex "first delivery" .cindex "expansion" "first delivery test" +.cindex "&%first_delivery%& expansion condition" This condition, which has no data, is true during a message's first delivery attempt. It is false during any subsequent delivery attempts. .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& +.cindex "&%ge%& expansion condition" See &*gei*&. .vitem &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& .cindex "string" "comparison" .cindex "expansion" "string comparison" +.cindex "&%gei%& expansion condition" The two substrings are first expanded. The condition is true if the first string is lexically greater than or equal to the second string: for &%ge%& the comparison includes the case of letters, whereas for &%gei%& the comparison is case-independent. .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& +.cindex "&%gt%& expansion condition" See &*gti*&. .vitem &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& .cindex "string" "comparison" .cindex "expansion" "string comparison" +.cindex "&%gti%& expansion condition" The two substrings are first expanded. The condition is true if the first string is lexically greater than the second string: for &%gt%& the comparison includes the case of letters, whereas for &%gti%& the comparison is case-independent. .vitem &*isip&~{*&<&'string'&>&*}*& +.cindex "&%isip%& expansion condition" See &*isip6*&. .vitem &*isip4&~{*&<&'string'&>&*}*& +.cindex "&%isip4%& expansion condition" See &*isip6*&. .vitem &*isip6&~{*&<&'string'&>&*}*& .cindex "IP address" "testing string format" .cindex "string" "testing for IP address" +.cindex "&%isip6%& expansion condition" The substring is first expanded, and then tested to see if it has the form of an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas &%isip4%& and &%isip6%& test just for IPv4 or IPv6 addresses, respectively. For @@ -9419,6 +9445,7 @@ to test which version of IP an incoming SMTP connection is using. .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*& .cindex "LDAP" "use for authentication" .cindex "expansion" "LDAP authentication test" +.cindex "&%ldapauth%& expansion condition" This condition supports user authentication using LDAP. See section &<>& for details of how to use LDAP in lookups and the syntax of queries. For this use, the query must contain a user name and password. The @@ -9432,22 +9459,26 @@ this can be used. .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& +.cindex "&%le%& expansion condition" See &*lei*&. .vitem &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& .cindex "string" "comparison" .cindex "expansion" "string comparison" +.cindex "&%lei%& expansion condition" The two substrings are first expanded. The condition is true if the first string is lexically less than or equal to the second string: for &%le%& the comparison includes the case of letters, whereas for &%lei%& the comparison is case-independent. .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& +.cindex "&%lt%& expansion condition" See &*lti*&. .vitem &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& .cindex "string" "comparison" .cindex "expansion" "string comparison" +.cindex "&%lti%& expansion condition" The two substrings are first expanded. The condition is true if the first string is lexically less than the second string: for &%lt%& the comparison includes the case of letters, whereas for &%lti%& the comparison is @@ -9457,6 +9488,7 @@ case-independent. .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& .cindex "expansion" "regular expression comparison" .cindex "regular expressions" "match in expanded string" +.cindex "&%match%&, expansion condition" The two substrings are first expanded. The second is then treated as a regular expression and applied to the first. Because of the pre-expansion, if the regular expression contains dollar, or backslash characters, they must be @@ -9488,13 +9520,15 @@ combination of conditions using &%or%&, the subsequent values of the numeric variables are those of the condition that succeeded. .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& +.cindex "&%match_address%& expansion condition" See &*match_local_part*&. .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& +.cindex "&%match_domain%& expansion condition" See &*match_local_part*&. -.new .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& +.cindex "&%match_ip%& expansion condition" This condition matches an IP address to a list of IP address patterns. It must be followed by two argument strings. The first (after expansion) must be an IP address or an empty string. The second (after expansion) is a restricted host @@ -9532,12 +9566,12 @@ specific address mask, for example, by using &`net24-`&. .endlist ilist Consult section &<>& for further details of these patterns. -.wen .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& .cindex "domain list" "in expansion condition" .cindex "address list" "in expansion condition" .cindex "local part list" "in expansion condition" +.cindex "&%match_local_part%& expansion condition" This condition, together with &%match_address%& and &%match_domain%&, make it possible to test domain, address, and local part lists within expansions. Each condition requires two arguments: an item and a list to match. A trivial @@ -9568,6 +9602,7 @@ matched using &%match_ip%&. .cindex "AUTH" "with PAM" .cindex "Solaris" "PAM support" .cindex "expansion" "PAM authentication test" +.cindex "&%pam%& expansion condition" &'Pluggable Authentication Modules'& (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is available in the latest releases of Solaris and in some GNU/Linux @@ -9613,6 +9648,7 @@ group, PAM can then be used from an Exim authenticator. .cindex "&'pwcheck'& daemon" .cindex "Cyrus" .cindex "expansion" "&'pwcheck'& authentication test" +.cindex "&%pwcheck%& expansion condition" This condition supports user authentication using the Cyrus &'pwcheck'& daemon. This is one way of making it possible for passwords to be checked by a process that is not running as root. &*Note*&: The use of &'pwcheck'& is now @@ -9638,6 +9674,7 @@ server_condition = ${if pwcheck{$1:$2}{1}{0}} .vitem &*queue_running*& .cindex "queue runner" "detecting when delivering from" .cindex "expansion" "queue runner test" +.cindex "&%queue_runnint%& expansion condition" This condition, which has no data, is true during delivery attempts that are initiated by queue runner processes, and false otherwise. @@ -9645,12 +9682,12 @@ initiated by queue runner processes, and false otherwise. .vitem &*radius&~{*&<&'authentication&~string'&>&*}*& .cindex "Radius" .cindex "expansion" "Radius authentication" +.cindex "&%radiu%& expansion condition" Radius authentication (RFC 2865) is supported in a similar way to PAM. You must set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of the Radius client configuration file in order to build Exim with Radius support. -.new With just that one setting, Exim expects to be linked with the &%radiusclient%& library, using the original API. If you are using release 0.4.0 or later of this library, you need to set @@ -9659,7 +9696,6 @@ RADIUS_LIB_TYPE=RADIUSCLIENTNEW .endd in &_Local/Makefile_& when building Exim. You can also link Exim with the &%libradius%& library that comes with FreeBSD. To do this, set -.wen .code RADIUS_LIB_TYPE=RADLIB .endd @@ -9680,6 +9716,7 @@ server_condition = ${if radius{}{yes}{no}} .cindex "&'saslauthd'& daemon" .cindex "Cyrus" .cindex "expansion" "&'saslauthd'& authentication test" +.cindex "&%saslauthd%& expansion condition" This condition supports user authentication using the Cyrus &'saslauthd'& daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated. Using this daemon is one way of making it possible for passwords to be checked @@ -9760,7 +9797,7 @@ expansion of the string. For example, the commands available in Exim filter files include an &%if%& command with its own regular expression matching condition. -.vitem "&$acl_c0$& &-- &$acl_c9$&" +.vitem "&$acl_c0$& &-- &$acl_c19$&" Values can be placed in these variables by the &%set%& modifier in an ACL. The values persist throughout the lifetime of an SMTP connection. They can be used to pass information between ACLs and different invocations of the same ACL. @@ -9768,7 +9805,7 @@ When a message is received, the values of these variables are saved with the message, and can be accessed by filters, routers, and transports during subsequent delivery. -.vitem "&$acl_m0$& &-- &$acl_m9$&" +.vitem "&$acl_m0$& &-- &$acl_m19$&" Values can be placed in these variables by the &%set%& modifier in an ACL. They retain their values while a message is being received, but are reset afterwards. They are also reset by MAIL, RSET, EHLO, HELO, and after starting a @@ -9776,7 +9813,6 @@ TLS session. When a message is received, the values of these variables are saved with the message, and can be accessed by filters, routers, and transports during subsequent delivery. -.new .vitem &$acl_verify_message$& .cindex "&$acl_verify_message$&" After an address verification has failed, this variable contains the failure @@ -9789,7 +9825,6 @@ warn !verify = sender You can use &$acl_verify_message$& during the expansion of the &%message%& or &%log_message%& modifiers, to include information about the verification failure. -.wen .vitem &$address_data$& .cindex "&$address_data$&" @@ -9838,6 +9873,13 @@ to the relevant file. When, as a result of aliasing or forwarding, a message is directed to a pipe, this variable holds the pipe command when the transport is running. +.new +.vitem "&$auth1$& &-- &$auth3$&" +.cindex "&$auth1$&, &$auth2$&, etc" +These variables are used in SMTP authenticators (see chapters +&<>&&--&<>&). Elsewhere, they are empty. +.wen + .vitem &$authenticated_id$& .cindex "authentication" "id" .cindex "&$authenticated_id$&" @@ -10138,7 +10180,6 @@ option in the &(appendfile)& transport. The variable contains the inode number of the temporary file which is about to be renamed. It can be used to construct a unique name for the file. -.new .vitem &$interface_address$& .cindex "&$interface_address$&" As soon as a server starts processing a TCP/IP connection, this variable is set @@ -10147,7 +10188,6 @@ port number. These values are therefore available for use in the &"connect"& ACL. See also the &%-oMi%& command line option. As well as being used in ACLs, these variable could be used, for example, to make the file name for a TLS certificate depend on which interface and/or port is being used. -.wen .vitem &$interface_port$& .cindex "&$interface_port$&" @@ -10335,7 +10375,6 @@ in bytes. The count starts from the character after the blank line that separates the body from the header. Newlines are included in the count. See also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&. -.new .vitem &$message_exim_id$& .cindex "&$message_exim_id$&" When a message is being received or delivered, this variable contains the @@ -10344,7 +10383,6 @@ An id is not created for a message until after its header has been successfully received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header line; it is the local id that Exim assigns to the message, for example: &`1BXTIK-0001yO-VA`&. -.wen .vitem &$message_headers$& This variable contains a concatenation of all the header lines when a message @@ -10352,11 +10390,8 @@ is being processed, except for lines added by routers or transports. The header lines are separated by newline characters. .vitem &$message_id$& -.new This is an old name for &$message_exim_id$&, which is now deprecated. -.wen -.new .vitem &$message_linecount$& .cindex "&$message_linecount$&" This variable contains the total number of lines in the header and body of the @@ -10375,7 +10410,6 @@ deny message = Too many lines in message header .endd In the MAIL and RCPT ACLs, the value is zero because at that stage the message has not yet been received. -.wen .vitem &$message_size$& .cindex "size" "of message" @@ -10494,7 +10528,6 @@ a single-component name, Exim calls &[gethostbyname()]& (or qualified host name. See also &$smtp_active_hostname$&. -.new .vitem &$prvscheck_address$& This variable is used in conjunction with the &%prvscheck%& expansion item, which is described in sections &<>& and @@ -10509,7 +10542,6 @@ which is described in sections &<>& and This variable is used in conjunction with the &%prvscheck%& expansion item, which is described in sections &<>& and &<>&. -.wen .vitem &$qualify_domain$& .cindex "&$qualify_domain$&" @@ -10573,12 +10605,10 @@ The &%-oMr%& option provides a way of specifying a custom protocol name for messages that are injected locally by trusted callers. This is commonly used to identify messages that are being re-injected after some kind of scanning. -.new .vitem &$received_time$& .cindex "&$received_time$&" This variable contains the date and time when the current message was received, as a number of seconds since the start of the Unix epoch. -.wen .vitem &$recipient_data$& .cindex "&$recipient_data$&" @@ -10648,7 +10678,9 @@ increases for each accepted recipient. It can be referenced in an ACL. .cindex "&$reply_address$&" When a message is being processed, this variable contains the contents of the &'Reply-To:'& header line if one exists and it is not empty, or otherwise the -contents of the &'From:'& header line. +contents of the &'From:'& header line. &new("Apart from the removal of leading +white space, the value is not processed in any way. In particular, no RFC 2047 +decoding or character code translation takes place.") .vitem &$return_path$& .cindex "&$return_path$&" @@ -10825,12 +10857,10 @@ identification received in response to an RFC 1413 request. When a message has been received locally, this variable contains the login name of the user that called Exim. -.new .vitem &$sender_rate_$&&'xxx'& A number of variables whose names begin &$sender_rate_$& are set as part of the &%ratelimit%& ACL condition. Details are given in section &<>&. -.wen .vitem &$sender_rcvhost$& .cindex "DNS" "reverse lookup" @@ -10864,7 +10894,6 @@ name, as specified by the &%smtp_active_hostname%& option. The value of &$smtp_active_hostname$& is saved with any message that is received, so its value can be consulted during routing and delivery. -.new .vitem &$smtp_command$& .cindex "&$smtp_command$&" During the processing of an incoming SMTP command, this variable contains the @@ -10878,17 +10907,14 @@ For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT command, the address in &$smtp_command$& is the original address before any rewriting, whereas the values in &$local_part$& and &$domain$& are taken from the address after SMTP-time rewriting. -.wen .vitem &$smtp_command_argument$& -.new .cindex "SMTP command" "argument for" .cindex "&$smtp_command_argument$&" While an ACL is running to check an SMTP command, this variable contains the argument, that is, the text that follows the command name, with leading white space removed. Following the introduction of &$smtp_command$&, this variable is somewhat redundant, but is retained for backwards compatibility. -.wen .vitem "&$sn0$& &-- &$sn9$&" These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators @@ -11011,6 +11037,7 @@ delivery delay. Details of its use are explained in section &<>&. This variable is set only during the creation of a message warning about a delivery delay. Details of its use are explained in section &<>&. .endlist +.ecindex IIDstrexp @@ -11018,7 +11045,7 @@ delivery delay. Details of its use are explained in section &<>&. . //////////////////////////////////////////////////////////////////////////// .chapter "Embedded Perl" "CHAPperl" -.cindex "Perl" "calling from Exim" +.scindex IIDperl "Perl" "calling from Exim" Exim can be built to include an embedded Perl interpreter. When this is done, Perl subroutines can be called as part of the string expansion process. To make use of the Perl support, you need version 5.004 or later of Perl installed on @@ -11142,7 +11169,7 @@ Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this example, the code for the subroutine is empty, so it does nothing, but you can include any Perl code that you like. The text of the &%warn%& message is passed as the first subroutine argument. - +.ecindex IIDperl . //////////////////////////////////////////////////////////////////////////// @@ -11328,6 +11355,7 @@ connections via the daemon.) .section "IPv6 address scopes" +.cindex "IPv6" "address scopes" IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces can, in principle, have the same link-local IPv6 address on different interfaces. Thus, additional information is needed, over and above the IP @@ -11352,6 +11380,27 @@ instead of &[getaddrinfo()]&. (Before version 4.14, it always used this function.) Of course, this means that the additional functionality of &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost. +.new +.section "Disabling IPv6" +.cindex "IPv6" "disabling" +Sometimes it happens that an Exim binary that was compiled with IPv6 support is +run on a host whose kernel does not support IPv6. The binary will fall back to +using IPv4, but it may waste resources looking up AAAA records, and trying to +connect to IPv6 addresses, causing delays to mail delivery. If you set the +.oindex "&%disable_ipv6%&" +&%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6 +activities take place. AAAA records are never looked up, and any IPv6 addresses +that are listed in &%local_interfaces%&, data for the &(manualroute)& router, +etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines +to handle IPv6 literal addresses. + +On the other hand, when IPv6 is in use, there may be times when you want to +disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%& +option to globally suppress the lookup of AAAA records for specified domains, +and you can use the &%ignore_target_hosts%& generic router option to ignore +IPv6 addresses in an individual router. +.wen + .section "Examples of starting a listening daemon" @@ -11442,8 +11491,8 @@ details. . //////////////////////////////////////////////////////////////////////////// .chapter "Main configuration" "CHAPmainconfig" -.cindex "configuration file" "main section" -.cindex "main configuration" +.scindex IIDconfima "configuration file" "main section" +.scindex IIDmaiconf "main configuration" The first part of the run time configuration file contains three types of item: .ilist @@ -11471,6 +11520,7 @@ listed in more than one group. .section "Miscellaneous" .table2 .row &%bi_command%& "to run for &%-bi%& command line option" +.row &%disable_ipv6%& "do no IPv6 processing" .row &%keep_malformed%& "for broken files &-- should not happen" .row &%localhost_number%& "for unique message ids in clusters" .row &%message_body_visible%& "how much to show in &$message_body$&" @@ -11804,6 +11854,7 @@ See also the &'Policy controls'& section above. .section "Routing and delivery" .table2 +.row &%disable_ipv6%& "do no IPv6 processing" .row &%dns_again_means_nonexist%& "for broken domains" .row &%dns_check_names_pattern%& "pre-DNS syntax check" .row &%dns_ipv4_lookup%& "only v4 lookup for these domains" @@ -11865,12 +11916,10 @@ Consequently, this option is turned off by default. This option defines the ACL that is run when a non-SMTP message is on the point of being accepted. See chapter &<>& for further details. -.new .option acl_not_smtp_mime main string&!! unset This option defines the ACL that is run for individual MIME parts of non-SMTP messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for SMTP messages. -.wen .option acl_smtp_auth main string&!! unset .cindex "&ACL;" "setting up for SMTP commands" @@ -11950,7 +11999,6 @@ received. See chapter &<>& for further details. .option admin_groups main "string list&!!" unset .cindex "admin user" -.new This option is expanded just once, at the start of Exim's processing. If the current group or any of the supplementary groups of an Exim caller is in this colon-separated list, the caller has admin privileges. If all your system @@ -11958,7 +12006,6 @@ programmers are in a specific group, for example, you can give them all Exim admin privileges by putting that group in &%admin_groups%&. However, this does not permit them to read Exim's spool files (whose group owner is the Exim gid). To permit this, you have to add individuals to the Exim group. -.wen .option allow_domain_literals main boolean false .cindex "domain literal" @@ -12044,7 +12091,6 @@ expansion is *, which matches all hosts. .option auto_thaw main time 0s -.new .cindex "thawing messages" .cindex "unfreezing messages" If this option is set to a time greater than zero, a queue runner will try a @@ -12056,7 +12102,6 @@ saying &"keep on trying, even though there are big problems"&. &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not thought to be very useful any more, and its use should probably be avoided. -.wen .option av_scanner main string "see below" This option is available if Exim is built with the content-scanning extension. @@ -12092,14 +12137,23 @@ delivery software."& It is not used if &%bounce_message_file%& is set. .option bounce_return_body main boolean true .cindex "bounce message" "including body" +.new This option controls whether the body of an incoming message is included in a -bounce message when &%bounce_return_message%& is true. If it is not set, only -the message header is included. +bounce message when &%bounce_return_message%& is true. The default setting +causes the entire message, both header and body, to be returned (subject to the +value of &%bounce_return_size_limit%&). If this option is false, only the +message header is included. In the case of a non-SMTP message containing an +error that is detected during reception, only those header lines preceding the +point at which the error was detected are returned. .cindex "bounce message" "including original" +.wen .option bounce_return_message main boolean true -If this option is set false, the original message is not included in bounce -messages generated by Exim. See also &%bounce_return_size_limit%&. +.new +If this option is set false, none of the original message is included in +bounce messages generated by Exim. See also &%bounce_return_size_limit%& and +&%bounce_return_body%&. +.wen .option bounce_return_size_limit main integer 100K @@ -12246,7 +12300,6 @@ This option specifies one or more default SMTP ports on which the Exim daemon listens. See chapter &<>& for details of how it is used. For backward compatibility, &%daemon_smtp_port%& (singular) is a synonym. -.new .option daemon_startup_retries main integer 9 .cindex "daemon startup" "retrying" This option, along with &%daemon_startup_sleep%&, controls the retrying done by @@ -12257,7 +12310,6 @@ defines the number of retries after the first failure, and .option daemon_startup_sleep main time 30s See &%daemon_startup_retries%&. -.wen .option delay_warning main "time list" 24h .cindex "warning of delay" @@ -12327,6 +12379,18 @@ should not be present in incoming messages, and this option causes them to be removed at the time the message is received, to avoid any problems that might occur when a delivered message is subsequently sent on to some other recipient. + +.new +.option disable_ipv6 main boolean false +.cindex "IPv6" "disabling" +If this option is set true, even if the Exim binary has IPv6 support, no IPv6 +activities take place. AAAA records are never looked up, and any IPv6 addresses +that are listed in &%local_interfaces%&, data for the &%manualroute%& router, +etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines +to handle IPv6 literal addresses. +.wen + + .option dns_again_means_nonexist main "domain list&!!" unset .cindex "DNS" "&""try again""& response; overriding" DNS lookups give a &"try again"& response for the DNS errors @@ -12340,29 +12404,37 @@ by a setting such as this: .code dns_again_means_nonexist = *.in-addr.arpa .endd -This option applies to all DNS lookups that Exim does. The &(dnslookup)& router -has some options of its own for controlling what happens when lookups for MX or -SRV records give temporary errors. These more specific options are applied -after the global option. +.new +This option applies to all DNS lookups that Exim does. It also applies when the +&[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors, +since these are most likely to be caused by DNS lookup problems. The +&(dnslookup)& router has some options of its own for controlling what happens +when lookups for MX or SRV records give temporary errors. These more specific +options are applied after this global option. +.wen .option dns_check_names_pattern main string "see below" .cindex "DNS" "pre-check of name syntax" +.new When this option is set to a non-empty string, it causes Exim to check domain -names for illegal characters before handing them to the DNS resolver, because -some resolvers give temporary errors for malformed names. If a domain name -contains any illegal characters, a &"not found"& result is forced, and the -resolver is not called. The check is done by matching the domain name against a -regular expression, which is the value of this option. The default pattern is +names for characters that are not allowed in host names before handing them to +the DNS resolver, because some resolvers give temporary errors for names that +contain unusual characters. If a domain name contains any unwanted characters, +a &"not found"& result is forced, and the resolver is not called. The check is +done by matching the domain name against a regular expression, which is the +value of this option. The default pattern is .code dns_check_names_pattern = \ - (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9-]*[^\W_])?)+$ + (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$ .endd -which permits only letters, digits, and hyphens in components, but they may not -start or end with a hyphen. -If you set &%allow_utf8_domains%&, you must modify this pattern, or set the -option to an empty string. +which permits only letters, digits, slashes, and hyphens in components, but +they must start and end with a letter or digit. Hyphens are not, in fact, +permitted in host names, but they are found in certain NS records (which can be +accessed in Exim by using a &%dnsdb%& lookup). If you set +&%allow_utf8_domains%&, you must modify this pattern, or set the option to an +empty string. +.wen -.new .option dns_csa_search_limit main integer 5 This option controls the depth of parental searching for CSA SRV records in the DNS, as described in more detail in section &<>&. @@ -12371,22 +12443,20 @@ DNS, as described in more detail in section &<>&. This option controls whether or not an IP address, given as a CSA domain, is reversed and looked up in the reverse DNS, as described in more detail in section &<>&. -.wen .option dns_ipv4_lookup main "domain list&!!" unset .cindex "IPv6" "DNS lookup for AAAA records" .cindex "DNS" "IPv6 lookup for AAAA records" -When Exim is compiled with IPv6 support, it looks for IPv6 address records -(AAAA and, if configured, A6) as well as IPv4 address records when trying to -find IP addresses for hosts, unless the host's domain matches this list. +.new +When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it +looks for IPv6 address records (AAAA records) as well as IPv4 address records +(A records) when trying to find IP addresses for hosts, unless the host's +domain matches this list. This is a fudge to help with name servers that give big delays or otherwise do -not work for the new IPv6 record types. If Exim is handed an IPv6 address -record as a result of an MX lookup, it always recognizes it, and may as a -result make an outgoing IPv6 connection. All this option does is to make Exim -look only for IPv4-style A records when it needs to find an IP address for a -host name. In due course, when the world's name servers have all been upgraded, -there should be no need for this option. +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. +.wen .option dns_retrans main time 0s @@ -12454,11 +12524,17 @@ variables &$0$&, &$1$&, etc. are set in the normal way. .option errors_reply_to main string unset .cindex "bounce message" "&'Reply-to:'& in" -Exim's bounce and delivery warning messages contain the header line +.new +By default, Exim's bounce and delivery warning messages contain the header line .display &`From: Mail Delivery System `& .endd +.oindex &%quota_warn_message%& where &'qualify-domain'& is the value of the &%qualify_domain%& option. +A warning message that is generated by the &%quota_warn_message%& option in an +&(appendfile)& transport may contain its own &'From:'& header line that +overrides the default. + Experience shows that people reply to bounce messages. If the &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce and warning messages. For example: @@ -12466,7 +12542,11 @@ and warning messages. For example: errors_reply_to = postmaster@my.domain.example .endd The value of the option is not expanded. It must specify a valid RFC 2822 -address. +address. However, if a warning message that is generated by the +&%quota_warn_message%& option in an &(appendfile)& transport contain its +own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is +not used. +.wen .option exim_group main string "compile-time configured" @@ -12656,7 +12736,6 @@ do. .option helo_try_verify_hosts main "host list&!!" unset -.new .cindex "HELO verifying" "optional" .cindex "EHLO verifying" "optional" By default, Exim just checks the syntax of HELO and EHLO commands (see @@ -12699,7 +12778,6 @@ name given in the HELO or EHLO in the same way as for rejected with a 550 error, and entries are written to the main and reject logs. If a MAIL command is received before EHLO or HELO, it is rejected with a 503 error. -.wen .option hold_domains main "domain list&!!" unset .cindex "domain" "delaying delivery" @@ -13052,7 +13130,7 @@ open files"& errors with NDBM, you need to reduce the value of .option max_username_length main integer 0 -.cindex "length of login name" +.cindex "length" "of login name" .cindex "user name" "maximum length" .cindex "limit" "user name length" Some operating systems are broken in that they truncate long arguments to @@ -13157,13 +13235,11 @@ option is available only if Exim has been built with MySQL support. .option never_users main "string list&!!" unset -.new This option is expanded just once, at the start of Exim's processing. Local message deliveries are normally run in processes that are setuid to the recipient, and remote deliveries are normally run under Exim's own uid and gid. It is usually desirable to prevent any deliveries from running as root, as a safety precaution. -.wen When Exim is built, an option called FIXED_NEVER_USERS can be set to a list of users that must not be used for local deliveries. This list is fixed in @@ -13436,12 +13512,10 @@ very large queues and/or very sluggish deliveries. This option does not, however, interlock with other processes, so additional queue runners can be started by other means, or by killing and restarting the daemon. -.new Setting this option to zero does not suppress queue runs; rather, it disables the limit, allowing any number of simultaneous queue runner processes to be run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on the daemon's command line. -.wen .option queue_smtp_domains main "domain list&!!" unset .cindex "queueing incoming messages" @@ -13478,12 +13552,11 @@ added to the message. Otherwise, the string should start with the text &"Received:"& and conform to the RFC 2822 specification for &'Received:'& header lines. The default setting is: -.new .code received_header_text = Received: \ ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\ {${if def:sender_ident \ - {from ${quote_local_part: $sender_ident} }}\ + {from ${quote_local_part:$sender_ident} }}\ ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\ by $primary_hostname \ ${if def:received_protocol {with $received_protocol}} \ @@ -13494,7 +13567,6 @@ received_header_text = Received: \ id $message_exim_id\ ${if def:received_for {\n\tfor $received_for}} .endd -.wen The reference to the TLS cipher is omitted when Exim is built without TLS support. The use of conditional expansions ensures that this works for both @@ -13624,10 +13696,13 @@ past failures. .option retry_interval_max main time 24h .cindex "retry" "limit on interval" .cindex "limit" "on retry interval" +.new Chapter &<>& describes Exim's mechanisms for controlling the intervals between delivery attempts for messages that cannot be delivered straight away. This option sets an overall limit to the length of time between -retries. +retries. It cannot be set greater than 24 hours; any attempt to do so forces +the default value. +.wen .option return_path_remove main boolean true @@ -13652,8 +13727,9 @@ This option is an obsolete synonym for &%bounce_return_size_limit%&. RFC 1413 identification calls are made to any client host which matches an item in the list. - -.option rfc1413_query_timeout main time 30s +.new +.option rfc1413_query_timeout main time 5s +.wen .cindex "RFC 1413" "query timeout" .cindex "timeout" "for RFC 1413 call" This sets the timeout on RFC 1413 identification calls. If it is set to zero, @@ -13976,12 +14052,10 @@ Some sites find it helpful to be able to limit the rate at which certain hosts can send them messages, and the rate at which an individual message can specify recipients. -.new Exim has two rate-limiting facilities. This section describes the older facility, which can limit rates within a single connection. The newer &%ratelimit%& ACL condition can limit rates across all connections. See section &<>& for details of the newer facility. -.wen When a host matches &%smtp_ratelimit_hosts%&, the values of &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the @@ -14126,12 +14200,10 @@ as failures in the configuration file. By using this option to override the compiled-in path, it is possible to run tests of Exim without using the standard spool. -.new .option sqlite_lock_timeout main time 5s .cindex "sqlite" "lock timeout" This option controls the timeout that the &(sqlite)& lookup uses when trying to access an SQLite database. See section &<>& for more details. -.wen .option strip_excess_angle_brackets main boolean false .cindex "angle brackets" "excess" @@ -14347,10 +14419,13 @@ further details, see section &<>&. .option tls_privatekey main string&!! unset .cindex "TLS" "server private key; location of" +.new The value of this option is expanded, and must then be the absolute path to a -file which contains the server's private key. If this option is unset, the -private key is assumed to be in the same file as the server's certificates. See -chapter &<>& for further details. +file which contains the server's private key. If this option is unset, or if +the expansion is forced to fail, or the result is an empty string, the private +key is assumed to be in the same file as the server's certificates. See chapter +&<>& for further details. +.wen .option tls_remember_esmtp main boolean false @@ -14421,7 +14496,6 @@ certificates. .option trusted_groups main "string list&!!" unset .cindex "trusted group" .cindex "group" "trusted" -.new This option is expanded just once, at the start of Exim's processing. If this option is set, any process that is running in one of the listed groups, or which has one of them as a supplementary group, is trusted. The groups can be @@ -14429,19 +14503,16 @@ specified numerically or by name. See section &<>& for details of what trusted callers are permitted to do. If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user are trusted. -.wen .option trusted_users main "string list&!!" unset .cindex "trusted user" .cindex "user" "trusted" -.new This option is expanded just once, at the start of Exim's processing. If this option is set, any process that is running as one of the listed users is trusted. The users can be specified numerically or by name. See section &<>& for details of what trusted callers are permitted to do. If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user are trusted. -.wen .option unknown_login main string&!! unset .cindex "uid (user id)" "unknown caller" @@ -14551,6 +14622,8 @@ been on the queue for a specified amount of time, as specified by .cindex "reject log" "disabling" If this option is set false, Exim no longer writes anything to the reject log. See chapter &<>& for details of what Exim writes to its logs. +.ecindex IIDconfima +.ecindex IIDmaiconf @@ -14559,8 +14632,8 @@ See chapter &<>& for details of what Exim writes to its logs. . //////////////////////////////////////////////////////////////////////////// .chapter "Generic options for routers" "CHAProutergeneric" -.cindex "options" "generic; for routers" -.cindex "generic options" "router" +.scindex IIDgenoprou1 "options" "generic; for routers" +.scindex IIDgenoprou2 "generic options" "router" This chapter describes the generic options that apply to all routers. Those that are preconditions are marked with ‡ in the &"use"& field. @@ -14574,13 +14647,11 @@ provide data for a transport is: &%errors_to%&, &%headers_add%&, .option address_data routers string&!! unset .cindex "router" "data attached to address" -.new The string is expanded just before the router is run, that is, after all the precondition tests have succeeded. If the expansion is forced to fail, the router declines, the value of &%address_data%& remains unchanged, and the &%more%& option controls what happens next. Other expansion failures cause delivery of the address to be deferred. -.wen .cindex "&$address_data$&" When the expansion succeeds, the value is retained with the address, and can be @@ -14642,9 +14713,9 @@ This option specifies a text message that is used when an address cannot be routed because Exim has run out of routers. The default message is &"Unrouteable address"&. This option is useful only on routers that have &%more%& set false, or on the very last router in a configuration, because the -value that is used is taken from the last router that is considered. &new("This +value that is used is taken from the last router that is considered. This includes a router that is skipped because its preconditions are not met, as -well as a router that declines.") For example, using the default configuration, +well as a router that declines. For example, using the default configuration, you could put: .code cannot_route_message = Remote domain not found in DNS @@ -14788,14 +14859,19 @@ to be used. .option errors_to routers string&!! unset .cindex "envelope sender" .cindex "router" "changing address for errors" -If a router successfully handles an address, it may queue the address for -delivery or it may generate child addresses. In both cases, if there is a -delivery problem during later processing, the resulting bounce message is sent -to the address that results from expanding this string, provided that the -address verifies successfully. &%errors_to%& is expanded before -&%headers_add%&, &%headers_remove%&, and &%transport%&. - -If the option is unset, or the expansion is forced to fail, or the result of +If a router successfully handles an address, it may assign the address to a +transport for delivery or it may generate child addresses. In both cases, if +there is a delivery problem during later processing, the resulting bounce +message is sent to the address that results from expanding this string, +provided that the address verifies successfully. The &%errors_to%& option is +expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&. + +The &%errors_to%& setting associated with an address can be overridden if it +subsequently passes through other routers that have their own &%errors_to%& +settings, or if the message is delivered by a transport with a &%return_path%& +setting. + +If &%errors_to%& is unset, or the expansion is forced to fail, or the result of the expansion fails to verify, the errors address associated with the incoming address is used. At top level, this is the envelope sender. A non-forced expansion failure causes delivery to be deferred. @@ -14803,19 +14879,11 @@ expansion failure causes delivery to be deferred. If an address for which &%errors_to%& has been set ends up being delivered over SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that any bounces that are generated by other MTAs on the delivery route are also -sent there. The most common use of &%errors_to%& is probably to direct mailing -list bounces to the manager of the list, as described in section -&<>&. - -The &%errors_to%& setting associated with an address can be overridden if it -subsequently passes through other routers that have their own &%errors_to%& -settings, -or if it is delivered by a transport with a &%return_path%& setting. - -You can set &%errors_to%& to the empty string by either of these settings: +sent there. You can set &%errors_to%& to the empty string by either of these +settings: .code errors_to = -errors_to = +errors_to = "" .endd An expansion item that yields an empty string has the same effect. If you do this, a locally detected delivery error for addresses processed by this router @@ -14829,6 +14897,10 @@ MAIL command for remote delivery, you can preserve the original return path in &$address_data$& in the router, and reinstate it in the transport by setting &%return_path%&. +The most common use of &%errors_to%& is to direct mailing list bounces to the +manager of the list, as described in section &<>&, or to +implement VERP (Variable Envelope Return Paths) (see section &<>&). + .option expn routers&!? boolean true @@ -14869,7 +14941,6 @@ verifying a sender, verification fails. .option fallback_hosts routers "string list" unset -.new .cindex "router" "fallback hosts" .cindex "fallback" "hosts specified on router" String expansion is not applied to this option. The argument must be a @@ -14878,7 +14949,6 @@ changed (see section &<>&), and a port can be specified with each name or address. In fact, the format of each item is exactly the same as defined for the list of hosts in a &(manualroute)& router (see section &<>&). -.wen If a router queues an address for a remote transport, this host list is associated with the address, and used instead of the transport's fallback host @@ -14904,7 +14974,6 @@ and the discussion in chapter &<>&. .option headers_add routers string&!! unset -.new .cindex "header lines" "adding" .cindex "router" "adding header lines" This option specifies a string of text that is expanded at routing time, and @@ -14915,7 +14984,6 @@ the text is used to add header lines at transport time is described in section message is in the process of being transported. This means that references to header lines in string expansions in the transport's configuration do not &"see"& the added header lines. -.wen The &%headers_add%& option is expanded after &%errors_to%&, but before &%headers_remove%& and &%transport%&. If the expanded string is empty, or if @@ -14925,15 +14993,12 @@ failures are treated as configuration errors. &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)& router that has the &%one_time%& option set. -.new &*Warning 2*&: If the &%unseen%& option is set on the router, all header additions are deleted when the address is passed on to subsequent routers. -.wen .option headers_remove routers string&!! unset -.new .cindex "header lines" "removing" .cindex "router" "removing header lines" This option specifies a string of text that is expanded at routing time, and @@ -14944,7 +15009,6 @@ section &<>&. Header lines are not actually removed until the message is in the process of being transported. This means that references to header lines in string expansions in the transport's configuration still &"see"& the original header lines. -.wen The &%headers_remove%& option is expanded after &%errors_to%& and &%headers_add%&, but before &%transport%&. If the expansion is forced to fail, @@ -14954,11 +15018,9 @@ errors. &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)& router that has the &%one_time%& option set. -.new &*Warning 2*&: If the &%unseen%& option is set on the router, all header removal requests are deleted when the address is passed on to subsequent routers. -.wen .option ignore_target_hosts routers "host list&!!" unset @@ -14983,7 +15045,6 @@ domain"& error, and an attempt to verify an address in the domain would fail. Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the router declines if presented with one of the listed addresses. -.new You can use this option to disable the use of IPv4 or IPv6 for mail delivery by means of the first or the second of the following settings, respectively: .code @@ -14992,7 +15053,6 @@ ignore_target_hosts = <; 0::0/0 .endd The pattern in the first line matches all IPv4 addresses, whereas the pattern in the second line matches all IPv6 addresses. -.wen This option may also be useful for ignoring link-local and site-local IPv6 addresses. Because, like all host lists, the value of &%ignore_target_hosts%& @@ -15034,7 +15094,6 @@ some character that does not occur in normal local parts. Wildcarding can be used to set up multiple user mailboxes, as described in section &<>&. -.new .cindex "&$local_part$&" .cindex "&$local_part_prefix$&" During the testing of the &%local_parts%& option, and while the router is @@ -15050,7 +15109,6 @@ When an address is being verified, &%local_part_prefix%& affects only the behaviour of the router. If the callout feature of verification is in use, this means that the full address, including the prefix, will be used during the callout. -.wen The prefix facility is commonly used to handle local parts of the form &%owner-something%&. Another common use is to support local parts of the form @@ -15126,9 +15184,9 @@ Exim has two logging styles for delivery, the idea being to make local deliveries stand out more visibly from remote ones. In the &"local"& style, the recipient address is given just as the local part, without a domain. The use of this style is controlled by this option. It defaults to true for the &(accept)& -router, and false for all the others. &new("This option applies only when a +router, and false for all the others. This option applies only when a router assigns an address to a transport. It has no effect on routers that -redirect addresses.") +redirect addresses. @@ -15151,11 +15209,9 @@ or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%& does not affect the behaviour if one of the precondition tests fails. In that case, the address is always passed to the next router. -.new Note that &%address_data%& is not considered to be a precondition. If its expansion is forced to fail, the router declines, and the value of &%more%& controls what happens next. -.wen .option pass_on_timeout routers boolean false @@ -15323,10 +15379,12 @@ are evaluated.) While the router is running, &%router_home_directory%& overrides the value of &$home$& that came from &%check_local_user%&. -When a router accepts an address and routes it to a transport (including the -cases when a redirect router generates a pipe, file, or autoreply delivery), -the home directory setting for the transport is taken from the first of these -values that is set: +.new +When a router accepts an address and assigns it to a local transport (including +the cases when a &(redirect)& router generates a pipe, file, or autoreply +delivery), the home directory setting for the transport is taken from the first +of these values that is set: +.wen .ilist The &%home_directory%& option on the transport; @@ -15531,7 +15589,6 @@ overriding a false setting of &%more%&. There is little point in setting the value of &%unseen%& contains expansion items (and therefore, presumably, is sometimes true and sometimes false). -.new .cindex "copy of message (&%unseen%& option)" The &%unseen%& option can be used to cause copies of messages to be delivered to some other destination, while also carrying out a normal delivery. In @@ -15539,7 +15596,6 @@ effect, the current address is made into a &"parent"& that has two children &-- one that is delivered as specified by this router, and a clone that goes on to be routed further. For this reason, &%unseen%& may not be combined with the &%one_time%& option in a &(redirect)& router. -.wen &*Warning*&: Header lines added to the address (or specified for removal) by this router or by previous routers affect the &"unseen"& copy of the message @@ -15604,6 +15660,8 @@ If this option is false, the router is skipped when verifying sender addresses or testing sender verification using &%-bvs%&. See section &<>& for a list of the order in which preconditions are evaluated. +.ecindex IIDgenoprou1 +.ecindex IIDgenoprou2 @@ -15643,8 +15701,8 @@ address for the &(local_delivery)& transport. . //////////////////////////////////////////////////////////////////////////// .chapter "The dnslookup router" "CHAPdnslookup" -.cindex "&(dnslookup)& router" -.cindex "routers" "&(dnslookup)&" +.scindex IIDdnsrou1 "&(dnslookup)& router" +.scindex IIDdnsrou2 "routers" "&(dnslookup)&" The &(dnslookup)& router looks up the hosts that handle mail for the recipient's domain in the DNS. A transport must always be set for this router, unless &%verify_only%& is set. @@ -15871,8 +15929,8 @@ is set and a lookup of &'klingon.dictionary'& fails, &'klingon.dictionary.fict.example'& is looked up, and if this fails, &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%& and &%search_parents%& options can cause some widening to be undertaken inside -the DNS resolver. &new("&%widen_domains%& is not applied to sender addresses -when verifying, unless &%rewrite_headers%& is false (not the default).") +the DNS resolver. &%widen_domains%& is not applied to sender addresses +when verifying, unless &%rewrite_headers%& is false (not the default). .section "Effect of qualify_single and search_parents" @@ -15889,6 +15947,8 @@ domains = @mx_any .endd that may happen while processing a router precondition before the router is entered. No widening ever takes place for these lookups. +.ecindex IIDdnsrou1 +.ecindex IIDdnsrou2 @@ -15908,12 +15968,21 @@ entered. No widening ever takes place for these lookups. This router has no private options. Unless it is being used purely for verification (see &%verify_only%&) a transport is required to be defined by the generic &%transport%& option. The router accepts the address if its domain part -takes the form of an RFC 2822 domain literal, that is, an IP address enclosed -in square brackets. For example, the &(ipliteral)& router handles the address +takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)& +router handles the address .code root@[192.168.1.1] .endd -by setting up delivery to the host with that IP address. +.new +by setting up delivery to the host with that IP address. IPv4 domain literals +consist of an IPv4 address enclosed in square brackets. IPv6 domain literals +are similar, but the address is preceded by &`ipv6:`&. For example: +.code +postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678] +.endd +Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the +grounds that sooner or later somebody will try it. +.wen .cindex "&%self%& option" "in &(ipliteral)& router" If the IP address matches something in &%ignore_target_hosts%&, the router @@ -16018,8 +16087,8 @@ call. It does not apply to UDP. . //////////////////////////////////////////////////////////////////////////// .chapter "The manualroute router" -.cindex "&(manualroute)& router" -.cindex "routers" "&(manualroute)&" +.scindex IIDmanrou1 "&(manualroute)& router" +.scindex IIDmanrou2 "routers" "&(manualroute)&" .cindex "domain" "manually routing" The &(manualroute)& router is so-called because it provides a way of manually routing an address according to its domain. It is mainly used when you want to @@ -16207,14 +16276,12 @@ be enclosed in quotes if it contains white space. .section "Format of the list of hosts" -.new A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is always separately expanded before use. If the expansion fails, the router declines. The result of the expansion must be a colon-separated list of names and/or IP addresses, optionally also including ports. The format of each item in the list is described in the next section. The list separator can be changed as described in section &<>&. -.wen If the list of hosts was obtained from a &%route_list%& item, the following variables are set during its expansion: @@ -16246,7 +16313,6 @@ semicolon is the default route list separator. .section "Format of one host item" "SECTformatonehostitem" -.new Each item in the list of hosts is either a host name or an IP address, optionally with an attached port number. When no port is given, an IP address is not enclosed in brackets. When a port is specified, it overrides the port @@ -16270,7 +16336,6 @@ number follows. For example: route_list = * " .endd -&new("This is also the case when an ACL-time callout is being used to verify a -recipient address.") However, if &%rcpt_include_affixes%& is set true, the +This is also the case when an ACL-time callout is being used to verify a +recipient address. However, if &%rcpt_include_affixes%& is set true, the whole local part is included in the RCPT command. This option applies to BSMTP deliveries by the &(appendfile)& and &(pipe)& transports as well as to the &(lmtp)& and &(smtp)& transports. @@ -18000,12 +18083,15 @@ either the message's envelope sender, or an address set by the &%errors_to%& option on a router. If the expansion is forced to fail, no replacement occurs; if it fails for another reason, delivery is deferred. This option can be used to support VERP (Variable Envelope Return Paths) &-- see -chapter &<>&. +section &<>&. -&*Note*&: If a delivery error is detected locally, -including the case when a remote server rejects a message at SMTP time, -the bounce message is not sent to the value of this option, but to the -previously set errors address (which defaults to the incoming sender address). +.new +&*Note*&: If a delivery error is detected locally, including the case when a +remote server rejects a message at SMTP time, the bounce message is not sent to +the value of this option. It is sent to the previously set errors address. +This defaults to the incoming sender address, but can be changed by setting +&%errors_to%& in a router. +.wen @@ -18065,7 +18151,7 @@ at transport time. It should not be confused with mail filtering as set up by individual users or via a system filter. When the message is about to be written out, the command specified by -&%transport_filter%& is started up in a separate, &new(parallel) process, and +&%transport_filter%& is started up in a separate, parallel process, and the entire message, including the header lines, is passed to it on its standard input (this in fact is done from a third process, to avoid deadlock). The command must be specified as an absolute path. @@ -18079,9 +18165,9 @@ settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or The standard error for the filter process is set to the same destination as its standard output; this is read and written to the message's ultimate -destination. &new("The process that writes the message to the filter, the +destination. The process that writes the message to the filter, the filter itself, and the original process that reads the result and delivers it -are all run in parallel, like a shell pipeline.") +are all run in parallel, like a shell pipeline. The filter can perform any transformations it likes, but of course should take care not to break RFC 2822 syntax. A demonstration Perl script is provided in @@ -18090,14 +18176,12 @@ show the possibilities. Exim does not check the result, except to test for a final newline when SMTP is in use. All messages transmitted over SMTP must end with a newline, so Exim supplies one if it is missing. -.new .cindex "content scanning" "per user" A transport filter can be used to provide content-scanning on a per-user basis at delivery time if the only required effect of the scan is to modify the message. For example, a content scan could insert a new header line containing a spam score. This could be interpreted by a filter in the user's MUA. It is not possible to discard a message at this stage. -.wen .cindex "SMTP" "SIZE" A problem might arise if the filter increases the size of a message that is @@ -18112,12 +18196,12 @@ additions to the message, or to disable the use of SIZE altogether. The value of the &%transport_filter%& option is the command string for starting the filter, which is run directly from Exim, not under a shell. The string is parsed by Exim in the same way as a command string for the &(pipe)& transport: -Exim breaks it up into arguments and then expands each argument separately. -&new("Any kind of expansion failure causes delivery to be deferred.") The -special argument &$pipe_addresses$& is replaced by a number of arguments, one -for each address that applies to this delivery. (This isn't an ideal name for -this feature here, but as it was already implemented for the &(pipe)& -transport, it seemed sensible not to change it.) +Exim breaks it up into arguments and then expands each argument separately (see +section &<>&). Any kind of expansion failure causes delivery +to be deferred. The special argument &$pipe_addresses$& is replaced by a number +of arguments, one for each address that applies to this delivery. (This isn't +an ideal name for this feature here, but as it was already implemented for the +&(pipe)& transport, it seemed sensible not to change it.) .cindex "&$host$&" .cindex "&$host_address$&" @@ -18128,24 +18212,56 @@ which the message is being sent. For example: transport_filter = /some/directory/transport-filter.pl \ $host $host_address $sender_address $pipe_addresses .endd -The filter process is run under the same uid and gid as the normal delivery. -For remote deliveries this is the Exim uid/gid by default. .new -The command should normally yield a zero return code. Transport filters are not -supposed to fail. A non-zero code is taken to mean that the transport filter -encountered some serious problem. Delivery of the message is deferred; the -message remains on the queue and is tried again later. It is not possible to -cause a message to be bounced from a transport filter. +Two problems arise if you want to use more complicated expansion items to +generate transport filter commands, both of which due to the fact that the +command is split up &'before'& expansion. +.ilist +If an expansion item contains white space, you must quote it, so that it is all +part of the same command item. If the entire option setting is one such +expansion item, you have to take care what kind of quoting you use. For +example: +.code +transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}' +.endd +This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and +&(/bin/cmd2)& otherwise. If double quotes had been used, they would have been +stripped by Exim when it read the option's value. When the value is used, if +the single quotes were missing, the line would be split into two items, +&`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when +Exim tried to expand the first one. +.next +Except for the special case of &$pipe_addresses$& that is mentioned above, an +expansion cannot generate multiple arguments, or a command name followed by +arguments. Consider this example: +.code +transport_filter = ${lookup{$host}lsearch{/some/file}\ + {$value}{/bin/cat}} +.endd +The result of the lookup is interpreted as the name of the command, even +if it contains white space. The simplest way round this is to use a shell: +.code +transport_filter = /bin/sh -c ${lookup{$host}lsearch{/some/file}\ + {$value}{/bin/cat}} +.endd +.endlist .wen +The filter process is run under the same uid and gid as the normal delivery. +For remote deliveries this is the Exim uid/gid by default. The command should +normally yield a zero return code. Transport filters are not supposed to fail. +A non-zero code is taken to mean that the transport filter encountered some +serious problem. Delivery of the message is deferred; the message remains on +the queue and is tried again later. It is not possible to cause a message to be +bounced from a transport filter. + If a transport filter is set on an autoreply transport, the original message is passed through the filter as it is being copied into the newly generated message, which happens if the &%return_message%& option is set. .option transport_filter_timeout transports time 5m -.new .cindex "transport filter" "timeout" When Exim is reading the output of a transport filter, it a applies a timeout that can be set by this option. Exceeding the timeout is normally treated as a @@ -18154,7 +18270,6 @@ temporary delivery failure. However, if a transport filter is used with a way as a timeout in the pipe command itself. By default, a timeout is a hard error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it becomes a temporary error. -.wen .option user transports string&!! "Exim user" @@ -18175,6 +18290,9 @@ For remote transports, you should leave this option unset unless you really are sure you know what you are doing. When a remote transport is running, it needs to be able to access Exim's hints databases, because each host may have its own retry data. +.ecindex IIDgenoptra1 +.ecindex IIDgenoptra2 +.ecindex IIDgenoptra3 @@ -18283,8 +18401,8 @@ containing all the recipients. . //////////////////////////////////////////////////////////////////////////// .chapter "The appendfile transport" "CHAPappendfile" -.cindex "&(appendfile)& transport" -.cindex "transports" "&(appendfile)&" +.scindex IIDapptra1 "&(appendfile)& transport" +.scindex IIDapptra2 "transports" "&(appendfile)&" .cindex "directory creation" .cindex "creating directories" The &(appendfile)& transport delivers a message by appending it to an existing @@ -18843,13 +18961,11 @@ become quite noticeable, especially on systems that have large block sizes. Nevertheless, it seems best to stick to the &'used'& figure, because this is the obvious value which users understand most easily. -.new The value of the option is expanded, and must then be a numerical value (decimal point allowed), optionally followed by one of the letters K, M, or G, for kilobytes, megabytes, or gigabytes. If Exim is running on a system with large file support (Linux and FreeBSD have this), mailboxes larger than 2G can be handled. -.wen &*Note*&: A value of zero is interpreted as &"no quota"&. @@ -18879,10 +18995,13 @@ delivery directory. .option quota_filecount appendfile string&!! 0 +.new This option applies when the &%directory%& option is set. It limits the total number of files in the directory (compare the inode limit in system quotas). It can only be used if &%quota%& is also set. The value is expanded; an expansion -failure causes delivery to be deferred. +failure causes delivery to be deferred. A value of zero is interpreted as +&"no quota"&. +.wen .option quota_is_inclusive appendfile boolean true @@ -18905,10 +19024,8 @@ the file length to the file name. For example: maildir_tag = ,S=$message_size quota_size_regex = ,S=(\d+) .endd -.new An alternative to &$message_size$& is &$message_linecount$&, which contains the number of lines in the message. -.wen The regular expression should not assume that the length is at the end of the file name (even though &%maildir_tag%& puts it there) because maildir MUAs @@ -18953,7 +19070,14 @@ The warning message itself is specified by the &%quota_warn_message%& option, and it must start with a &'To:'& header line containing the recipient(s) of the warning message. These do not necessarily have to include the recipient(s) of the original message. A &'Subject:'& line should also normally be supplied. You -can include any other header lines that you want. +can include any other header lines that you want. If you do not include a +&'From:'& line, the default is: +.code +From: Mail Delivery System +.endd +.oindex &%errors_reply_to%& +If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%& +option. .wen The &%quota%& option does not have to be set in order to use this option; they @@ -19346,12 +19470,10 @@ There can be more than one recipient only if the &%batch_max%& option is set greater than one. Finally, &%mailstore_suffix%& is expanded and the result appended to the file, followed by a newline if it does not end with one. -.new If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced failure, it is ignored. Other expansion errors are treated as serious configuration errors, and delivery is deferred. The variable &$mailstore_basename$& is available for use during these expansions. -.wen .section "Non-special new file delivery" @@ -19365,6 +19487,8 @@ directory = /var/bsmtp/$host might be used. A message is written to a file with a temporary name, which is then renamed when the delivery is complete. The final name is obtained by expanding the contents of the &%directory_file%& option. +.ecindex IIDapptra1 +.ecindex IIDapptra2 @@ -19375,10 +19499,15 @@ expanding the contents of the &%directory_file%& option. . //////////////////////////////////////////////////////////////////////////// .chapter "The autoreply transport" -.cindex "transports" "&(autoreply)&" -.cindex "&(autoreply)& transport" +.scindex IIDauttra1 "transports" "&(autoreply)&" +.scindex IIDauttra2 "&(autoreply)& transport" +.new The &(autoreply)& transport is not a true transport in that it does not cause -the message to be transmitted. Instead, it generates a new mail message. +the message to be transmitted. Instead, it generates a new mail message as an +automatic reply to the incoming message. &'References:'& and +&'Auto-Submitted:'& header lines are included. These are constructed according +to the rules in RFCs 2822 and 3834, respectively. +.wen If the router that passes the message to this transport does not have the &%unseen%& option set, the original message (for the current recipient) is not @@ -19568,6 +19697,8 @@ the text comes first. .option to autoreply string&!! unset This specifies recipients of the message and the contents of the &'To:'& header when the message is specified by the transport. +.ecindex IIDauttra1 +.ecindex IIDauttra2 @@ -19615,13 +19746,11 @@ number of arguments). The command is run directly, not via a shell. The message is passed to the new process using the standard input and output to operate the LMTP protocol. -.new .option ignore_quota lmtp boolean false .cindex "LMTP" "ignoring quota errors" If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server has advertised support for IGNOREQUOTA in its response to the LHLO command. -.wen .option socket lmtp string&!! unset This option must be set if &%command%& is not set. The result of expansion must @@ -19652,8 +19781,8 @@ necessary, running as the user &'exim'&. . //////////////////////////////////////////////////////////////////////////// .chapter "The pipe transport" "CHAPpipetransport" -.cindex "transports" "&(pipe)&" -.cindex "&(pipe)& transport" +.scindex IIDpiptra1 "transports" "&(pipe)&" +.scindex IIDpiptra2 "&(pipe)& transport" The &(pipe)& transport is used to deliver messages via a pipe to a command running in another process. One example is the use of &(pipe)& as a pseudo-remote transport for passing messages to some other delivery mechanism @@ -19761,10 +19890,18 @@ arguments. You have to write .code command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}" .endd +.new to ensure that it is all in one argument. The expansion is done in this way, argument by argument, so that the number of arguments cannot be changed as a result of expansion, and quotes or backslashes in inserted variables do not -interact with external quoting. +interact with external quoting. However, this leads to problems if you want to +generate multiple arguments (or the command name plus arguments) from a single +expansion. In this situation, the simplest solution is to use a shell. For +example: +.code +command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}} +.endd +.wen .cindex "transport" "filter" .cindex "filter" "transport filter" @@ -19928,10 +20065,8 @@ Otherwise, a non-zero status or termination by signal causes an error return from the transport unless the status value is one of those listed in &%temp_errors%&; these cause the delivery to be deferred and tried again later. -.new &*Note*&: This option does not apply to timeouts, which do not return a status. See the &%timeout_defer%& option for how timeouts are handled. -.wen .option log_defer_output pipe boolean false .cindex "&(pipe)& transport" "logging output" @@ -20061,14 +20196,12 @@ command are also killed, Exim makes the initial process a process group leader, and kills the whole process group on a timeout. However, this can be defeated if one of the processes starts a new process group. -.new .option timeout_defer pipe boolean false A timeout in a &(pipe)& transport, either in the command that the transport runs, or in a transport filter that is associated with it, is by default treated as a hard error, and the delivery fails. However, if &%timeout_defer%& is set true, both kinds of timeout become temporary errors, causing the delivery to be deferred. -.wen .option umask pipe "octal integer" 022 This specifies the umask setting for the subprocess that runs the command. @@ -20082,6 +20215,16 @@ commands. If you want to include a leading HELO command with such messages, you can do so by setting the &%message_prefix%& option. See section &<>& for details of batch SMTP. +.new +.option use_classresources pipe boolean false +.cindex "class resources (BSD)" +This option is available only when Exim is running on FreeBSD, NetBSD, or +BSD/OS. If it is set true, the &[setclassresources()]& function is used to set +resource limits when a &(pipe)& transport is run to perform a delivery. The +limits for the uid under which the pipe is to run are obtained from the login +class database. +.wen + .option use_crlf pipe boolean false .cindex "carriage return" @@ -20184,14 +20327,16 @@ local_user_cyrus: Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of &%return_output%& to cause any text written by Cyrus to be returned to the sender. +.ecindex IIDpiptra1 +.ecindex IIDpiptra2 . //////////////////////////////////////////////////////////////////////////// . //////////////////////////////////////////////////////////////////////////// .chapter "The smtp transport" "CHAPsmtptrans" -.cindex "transports" "&(smtp)&" -.cindex "&(smtp)& transport" +.scindex IIDsmttra1 "transports" "&(smtp)&" +.scindex IIDsmttra2 "&(smtp)& transport" The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP or LMTP protocol. The list of hosts to try can either be taken from the address that is being processed (having been set up by the router), or specified @@ -20259,15 +20404,19 @@ configured Exim is listening on the port to which the message is sent). .option authenticated_sender smtp string&!! unset .cindex "Cyrus" -When Exim has authenticated as a client, this option sets a value for the -AUTH= item on outgoing MAIL commands, overriding any existing -authenticated sender value. If the string expansion is forced to fail, the -option is ignored. Other expansion failures cause delivery to be deferred. If -the result of expansion is an empty string, that is also ignored. +.new +When Exim has authenticated as a client, or if &%authenticated_sender_force%& +is true, this option sets a value for the AUTH= item on outgoing MAIL commands, +overriding any existing authenticated sender value. If the string expansion is +forced to fail, the option is ignored. Other expansion failures cause delivery +to be deferred. If the result of expansion is an empty string, that is also +ignored. If the SMTP session is not authenticated, the expansion of &%authenticated_sender%& still happens (and can cause the delivery to be -deferred if it fails), but no AUTH= item is added to MAIL commands. +deferred if it fails), but no AUTH= item is added to MAIL commands +unless &%authenticated_sender_force%& is true. +.wen This option allows you to use the &(smtp)& transport in LMTP mode to deliver mail to Cyrus IMAP and provide the proper local part as the @@ -20283,6 +20432,14 @@ domain is involved), there is no checking on the syntax of the provided value. +.new +.option authenticated_sender_force smtp boolean false +If this option is set true, the &%authenticated_sender%& option's value +is used for the AUTH= item on outgoing MAIL commands, even if Exim has not +authenticated as a client. +.wen + + .option command_timeout smtp time 5m This sets a timeout for receiving a response to an SMTP command that has been sent out. It is also used when waiting for the initial banner line from the @@ -20354,7 +20511,6 @@ details. .option fallback_hosts smtp "string list" unset -.new .cindex "fallback" "hosts specified on transport" String expansion is not applied to this option. The argument must be a colon-separated list of host names or IP addresses, optionally also including @@ -20362,7 +20518,6 @@ port numbers, though the separator can be changed, as described in section &<>&. Each individual item in the list is the same as an item in a &%route_list%& setting for the &(manualroute)& router, as described in section &<>&. -.wen Fallback hosts can also be specified on routers, which associate them with the addresses they process. As for the &%hosts%& option without &%hosts_override%&, @@ -20405,12 +20560,10 @@ it may also consult other sources of information such as &_/etc/hosts_&. .option helo_data smtp string&!! &`$primary_hostname`& .cindex "HELO argument" "setting" .cindex "EHLO argument" "setting" -.new The value of this option is expanded, and used as the argument for the EHLO or HELO command that starts the outgoing SMTP session. The variables &$host$& and &$host_address$& are set to the identity of the remote host, and can be used to generate different values for different servers. -.wen .option hosts smtp "string list&!!" unset Hosts are associated with an address by a router such as &(dnslookup)&, which @@ -20424,7 +20577,6 @@ processed does not have any hosts associated with it. The hosts specified by &%hosts%& are also used, whether or not the address has its own hosts, if &%hosts_override%& is set. -.new The string is first expanded, before being interpreted as a colon-separated list of host names or IP addresses, possibly including port numbers. The separator may be changed to something other than colon, as described in section @@ -20432,7 +20584,6 @@ separator may be changed to something other than colon, as described in section item in a &%route_list%& setting for the &(manualroute)& router, as described in section &<>&. However, note that the &`/MX`& facility of the &(manualroute)& router is not available here. -.wen If the expansion fails, delivery is deferred. Unless the failure was caused by the inability to complete a lookup, the error is logged to the panic log as @@ -20582,13 +20733,11 @@ TCP/IP call properly. The keepalive mechanism takes several hours to detect unreachable hosts. -.new .option lmtp_ignore_quota smtp boolean false .cindex "LMTP" "ignoring quota errors" If this option is set true when the &%protocol%& option is set to &"lmtp"&, the string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server has advertised support for IGNOREQUOTA in its response to the LHLO command. -.wen .option max_rcpt smtp integer 100 .cindex "RCPT" "maximum number of outgoing" @@ -20714,12 +20863,15 @@ be the name of a file that contains a CRL in PEM format. .cindex "TLS client private key" "location of" .cindex "&$host$&" .cindex "&$host_address$&" +.new The value of this option must be the absolute path to a file which contains the client's private key. This is used when sending a message over an encrypted connection using a client certificate. The values of &$host$& and &$host_address$& are set to the name and address of the server during the -expansion. If this option is unset, the private key is assumed to be in the -same file as the certificate. See chapter &<>& for details of TLS. +expansion. If this option is unset, or the expansion is forced to fail, or the +result is an empty string, the private key is assumed to be in the same file as +the certificate. See chapter &<>& for details of TLS. +.wen .option tls_require_ciphers smtp string&!! unset @@ -20836,6 +20988,8 @@ The &%hosts_max_try_hardlimit%& option was added to help with this problem. Exim never tries more than this number of IP addresses; if it hits this limit and they are all timed out, the email address is bounced, even though not all possible IP addresses have been tried. +.ecindex IIDsmttra1 +.ecindex IIDsmttra2 @@ -20845,7 +20999,7 @@ possible IP addresses have been tried. . //////////////////////////////////////////////////////////////////////////// .chapter "Address rewriting" "CHAPrewrite" -.cindex "rewriting" "addresses" +.scindex IIDaddrew "rewriting" "addresses" There are some circumstances in which Exim automatically rewrites domains in addresses. The two most common are when an address is given without a domain (referred to as an &"unqualified address"&) or when an address contains an @@ -20935,25 +21089,34 @@ value of &$local_part$& and &$domain$& after verification are always the same as they were before (that is, they contain the unrewritten &-- except for SMTP-time rewriting &-- address). -Once a message's header lines have been received, all the envelope recipient -addresses are permanently rewritten, and rewriting is also applied to the -addresses in the header lines (if configured). +.new +As soon as a message's header lines have been received, all the envelope +recipient addresses are permanently rewritten, and rewriting is also applied to +the addresses in the header lines (if configured). This happens before adding +any header lines that were specified in MAIL or RCPT ACLs, and .cindex "&[local_scan()]& function" "address rewriting; timing of" -Thus, all the rewriting is completed before the DATA ACL and -&[local_scan()]& functions are run. +before the DATA ACL and &[local_scan()]& functions are run. +.wen 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 sender" "rewriting" +.new +.cindex "envelope sender" "rewriting at transport time" .cindex "rewriting" "at transport time" +.cindex "header lines" "rewriting at transport time" At transport time, additional rewriting of addresses in header lines can be specified by setting the generic &%headers_rewrite%& option on a transport. This option contains rules that are identical in form to those in the rewrite -section of the configuration file. In addition, the outgoing envelope sender -can be rewritten by means of the &%return_path%& transport option. However, it -is not possible to rewrite envelope recipients at transport time. +section of the configuration file. They are applied to the original message +header lines and any that were added by ACLs or a system filter. They are not +applied to header lines that are added by routers or the transport. + +The outgoing envelope sender can be rewritten by means of the &%return_path%& +transport option. However, it is not possible to rewrite envelope recipients at +transport time. +.wen @@ -21274,6 +21437,7 @@ method for using your system as a relay, because the incoming addresses appear to be local. If the bang path addresses are received via SMTP, it is safer to use the &"S"& flag to rewrite them as they are received, so that relay checking can be done on the rewritten addresses. +.ecindex IIDaddrew @@ -21283,13 +21447,13 @@ can be done on the rewritten addresses. . //////////////////////////////////////////////////////////////////////////// .chapter "Retry configuration" "CHAPretry" -.cindex "retry configuration" "description of" -.cindex "configuration file" "retry section" +.scindex IIDretconf1 "retry configuration" "description of" +.scindex IIDregconf2 "configuration file" "retry section" The &"retry"& section of the run time configuration file contains a list of -retry rules which control how often Exim tries to deliver messages that cannot +retry rules that control how often Exim tries to deliver messages that cannot be delivered at the first attempt. If there are no retry rules, temporary errors are treated as permanent. The &%-brt%& command line option can be used -to test which retry rule will be used for a given address or domain. +to test which retry rule will be used for a given address, domain and error. The most common cause of retries is temporary failure to deliver to a remote host because the host is down, or inaccessible because of a network problem. @@ -21378,14 +21542,15 @@ configuration is tested against the complete address only if &%retry_use_local_part%& is set for the transport (it defaults true for all local transports). -When Exim is looking for a retry rule after a remote delivery attempt has -failed, what happens depends on the type of failure. After a 4&'xx'& SMTP -response for a recipient address, the whole address is used when searching the -retry rules. The rule that is found is used to create a retry time for the -failing address. +.new +However, when Exim is looking for a retry rule after a remote delivery attempt +suffers an address error (a 4&'xx'& SMTP response for a recipient address), the +whole address is always used as the key when searching the retry rules. The +rule that is found is used to create a retry time for the failing address. +.wen -.section "Choosing which retry rule to use for host errors" +.section "Choosing which retry rule to use for host and message errors" For a temporary error that is not related to an individual address (for example, a connection timeout), each line in the retry configuration is checked twice. First, the name of the remote host is used as a domain name (preceded by @@ -21414,7 +21579,6 @@ first rule to determine retry times, but for all the other hosts for the domain &'a.b.c.example'&, the second rule is used. The second rule is also used if routing to &'a.b.c.example'& suffers a temporary failure. -.new &*Note*&: The host name is used when matching the patterns, not its IP address. However, if a message is routed directly to an IP address without the use of a host name, for example, if a &(manualroute)& router contains a setting such as: @@ -21423,7 +21587,6 @@ route_list = *.a.example 192.168.34.23 .endd then the &"host name"& that is used when searching for a retry rule is the textual form of the IP address. -.wen .section "Retry rules for specific errors" .cindex "retry" "specific errors; specifying" @@ -21435,18 +21598,37 @@ asterisk, which matches any error. The errors that can be tested for are: Authentication failed when trying to send to a host in the &%hosts_require_auth%& list in an &(smtp)& transport. +.new +.vitem &%data_4xx%& +A 4&'xx'& error was received for an outgoing DATA command, either immediately +after the command, or after sending the message's data. + +.vitem &%mail_4xx%& +A 4&'xx'& error was received for an outgoing MAIL command. + .vitem &%rcpt_4xx%& -A 4&'xx'& error was received for an outgoing RCPT command. Either the first or -both of the x's can be given as specific digits, for example: &`rcpt_45x`& or -&`rcpt_436`&. For example, to recognize 452 errors given to RCPT commands by a -particular host, and have retries every ten minutes and a one-hour timeout, you -could set up a retry rule of this form: +A 4&'xx'& error was received for an outgoing RCPT command. +.endlist + +For the three 4&'xx'& errors, either the first or both of the x's can be given +as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to +recognize 452 errors given to RCPT commands for addresses in a certain domain, +and have retries every ten minutes with a one-hour timeout, you could set up a +retry rule of this form: .code -the.host.name rcpt_452 F,1h,10m +the.domain.name rcpt_452 F,1h,10m .endd These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode). -Note, however, that they apply only to responses to RCPT commands. +.wen + +.vlist +.new +.vitem &%lost_connection%& +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. +.wen .vitem &%refused_MX%& A connection to a host obtained from an MX record was refused. @@ -21477,6 +21659,13 @@ obtained from an MX record. .vitem &%timeout%& There was a timeout while connecting or during an SMTP session. +.new +.vitem &%tls_required%& +The server was required to use TLS (it matched &%hosts_require_tls%& in the +&(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'& +to STARTTLS, or there was a problem setting up the TLS connection. +.wen + .vitem &%quota%& A mailbox quota was exceeded in a local delivery by the &(appendfile)& transport. @@ -21527,25 +21716,26 @@ You can specify retry rules that apply only when the failing message has a specific sender. In particular, this can be used to define retry rules that apply only to bounce messages. The third item in a retry rule can be of this form: -.code -senders=
+.display +&`senders=`&<&'address list'&> .endd The retry timings themselves are then the fourth item. For example: .code * rcpt_4xx senders=: F,1h,30m .endd -matches 4&'xx'& errors for bounce messages sent to any host. If the address -list contains white space, it must be enclosed in quotes. For example: +.new +matches recipient 4&'xx'& errors for bounce messages sent to any address at any +host. If the address list contains white space, it must be enclosed in quotes. +For example: .code -a.domain auth_failed senders="xb.dom : yc.dom" G,8h,10m,1.5 +a.domain rcpt_452 senders="xb.dom : yc.dom" G,8h,10m,1.5 .endd -.new -&*Warning*&: This facility can be unhelpful if it is used for host errors -(those that do not depend on the recipient). The reason is that the sender is -used only to match the retry rule. Once the rule has been found for a host -error, its contents are used to set a retry time for the host, and this will -apply to all messages, not just those with specific senders. .wen +&*Warning*&: This facility can be unhelpful if it is used for host errors +(which do not depend on the recipient). The reason is that the sender is used +only to match the retry rule. Once the rule has been found for a host error, +its contents are used to set a retry time for the host, and this will apply to +all messages, not just those with specific senders. When testing retry rules using &%-brt%&, you can supply a sender using the &%-f%& command line option, like this: @@ -21586,7 +21776,6 @@ the interval. specifies a starting value for the interval, and the second a multiplier, which is used to increase the size of the interval at each retry. .next -.new &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each retry, the previous interval is multiplied by the factor in order to get a maximum for the next interval. The mininum interval is the first argument of @@ -21594,7 +21783,6 @@ the parameter, and an actual interval is chosen randomly between them. Such a rule has been found to be helpful in cluster configurations when all the members of the cluster restart at once, and may therefore synchronize their queue processing times. -.wen .endlist When computing the next retry time, the algorithm definitions are scanned in @@ -21607,7 +21795,8 @@ interval is found. The main configuration variable .cindex "limit" "retry interval" .cindex "retry interval" "maximum" .cindex "&%retry_interval_max%&" -&%retry_interval_max%& limits the maximum interval between retries. +&%retry_interval_max%& limits the maximum interval between retries. &new("It +cannot be set greater than &`24h`&, which is its default value.") A single remote domain may have a number of hosts associated with it, and each host may have more than one IP address. Retry algorithms are selected on the @@ -21750,19 +21939,34 @@ If there is a continuous stream of messages for the failing domains, setting deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is true. +.new +.section "Deliveries that work intermittently" +.cindex "retry" "intermittently working deliveries" +Some additional logic is needed to cope with cases where a host is +intermittently available, or when a message has some attribute that prevents +its delivery when others to the same address get through. In this situation, +because some messages are successfully delivered, the &"retry clock"& for the +host or address keeps getting restarted, and so a message could remain on the +queue for ever because the cutoff time is never reached. + +Two exceptional actions are applied to prevent this happening. Firstly, if a +message's arrival time is earlier than the &"first failed"& time for a host or +address, the earlier time is used when scanning the retry rules. + +Secondly, if a message has been on the queue for longer than the cutoff time of +any applicable retry rule for a given address, a delivery is attempted for that +address, even if it is not yet time, and if this delivery fails, the address is +timed out. A new retry time is not computed in this case, so that other +messages for the same address are considered immediately. + +These two actions are probably equivalent; the fact that they both exist is a +a historical accident. The second was implemented first, and was left in place +when the first was added on the grounds that this was harmless, whereas +removing it might have broken something in this rather tricky area. +.ecindex IIDretconf1 +.ecindex IIDregconf2 +.wen -.section "Ultimate address timeout" -.cindex "retry" "ultimate address timeout" -An additional rule is needed to cope with cases where a host is intermittently -available, or when a message has some attribute that prevents its delivery when -others to the same address get through. In this situation, because some -messages are successfully delivered, the &"retry clock"& for the address keeps -getting restarted, and so a message could remain on the queue for ever. To -prevent this, if a message has been on the queue for longer than the cutoff -time of any applicable retry rule for a given address, a delivery is attempted -for that address, even if it is not yet time, and if this delivery fails, the -address is timed out. A new retry time is not computed in this case, so that -other messages for the same address are considered immediately. @@ -21772,8 +21976,8 @@ other messages for the same address are considered immediately. . //////////////////////////////////////////////////////////////////////////// .chapter "SMTP authentication" "CHAPSMTPAUTH" -.cindex "SMTP" "authentication configuration" -.cindex "authentication" +.scindex IIDauthconf1 "SMTP" "authentication configuration" +.scindex IIDauthconf2 "authentication" The &"authenticators"& section of Exim's run time configuration is concerned with SMTP authentication. This facility is an extension to the SMTP protocol, described in RFC 2554, which allows a client SMTP host to authenticate itself @@ -21864,7 +22068,7 @@ both sets of options, is required. For example: cram: driver = cram_md5 public_name = CRAM-MD5 - server_secret = ${if eq{$1}{ph10}{secret1}fail} + server_secret = ${if eq{$auth1}{ph10}{secret1}fail} client_name = ph10 client_secret = secret2 .endd @@ -22162,6 +22366,8 @@ to send a message, the sender address that is built from the login name and &%qualify_domain%& is treated as authenticated. However, if the &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides the authenticated sender that was received with the message. +.ecindex IIDauthconf1 +.ecindex IIDauthconf2 @@ -22172,15 +22378,17 @@ the authenticated sender that was received with the message. . //////////////////////////////////////////////////////////////////////////// .chapter "The plaintext authenticator" "CHAPplaintext" -.cindex "&(plaintext)& authenticator" -.cindex "authenticators" "&(plaintext)&" +.scindex IIDplaiauth1 "&(plaintext)& authenticator" +.scindex IIDplaiauth2 "authenticators" "&(plaintext)&" +.new The &(plaintext)& authenticator can be configured to support the PLAIN and LOGIN authentication mechanisms, both of which transfer authentication data as plain (unencrypted) text (though base64 encoded). The use of plain text is a -security risk. If you use one of these mechanisms without also making use of -SMTP encryption (see chapter &<>&) you should not use the same -passwords for SMTP connections as you do for login accounts. - +security risk; you are strongly advised to insist on the use of SMTP encryption +(see chapter &<>&) if you use the PLAIN or LOGIN mechanisms. If you do +use unencrypted plain text, you should not use the same passwords for SMTP +connections as you do for login accounts. +.wen .section "Using plaintext in a server" .cindex "options" "&(plaintext)& authenticator (server)" @@ -22200,15 +22408,25 @@ is described below. .cindex "binary zero" "in &(plaintext)& authenticator" .cindex "numerical variables (&$1$& &$2$& etc)" &&& "in &(plaintext)& authenticator" +.cindex "&$auth1$&, &$auth2$&, etc" .cindex "base64 encoding" "in &(plaintext)& authenticator" +.new The data sent by the client with the AUTH command, or in response to subsequent prompts, is base64 encoded, and so may contain any byte values when decoded. If any data is supplied with the command, it is treated as a -list of strings, separated by NULs (binary zeros), which are placed in the -expansion variables &$1$&, &$2$&, etc. If there are more strings in -&%server_prompts%& than the number of strings supplied with the AUTH -command, the remaining prompts are used to obtain more data. Each response from -the client may be a list of NUL-separated strings. +list of strings, separated by NULs (binary zeros), the first three of which are +placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$& (neither +LOGIN nor PLAIN uses more than three strings). + +For compatibility with previous releases of Exim, the values are also placed in +the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these +variables for this purpose is now deprecated, as it can lead to confusion in +string expansions that also use them for other things. +.wen + +If there are more strings in &%server_prompts%& than the number of strings +supplied with the AUTH command, the remaining prompts are used to obtain more +data. Each response from the client may be a list of NUL-separated strings. .cindex "&$authenticated_id$&" Once a sufficient number of data strings have been received, @@ -22239,14 +22457,16 @@ subsequently in response to an empty prompt from the server. The second and third strings are a user name and a corresponding password. Using a single fixed user name and password as an example, this could be configured as follows: +.new .code fixed_plain: driver = plaintext public_name = PLAIN server_prompts = : server_condition = \ - ${if and {{eq{$2}{username}}{eq{$3}{mysecret}}}{yes}{no}} - server_set_id = $2 + ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}\ + {yes}{no}} + server_set_id = $auth2 .endd The &%server_prompts%& setting specifies a single, empty prompt (empty items at the end of a string list are ignored). If all the data comes as part of the @@ -22277,26 +22497,28 @@ Having just one fixed user name and password, as in this example, is not very realistic, though for a small organization with only a handful of authenticating clients it could make sense. +.new A more sophisticated instance of this authenticator could use the user name in -&$2$& to look up a password in a file or database, and maybe do an encrypted +&$auth2$& to look up a password in a file or database, and maybe do an encrypted comparison (see &%crypteq%& in chapter &<>&). Here is a example of this approach, where the passwords are looked up in a DBM file. &*Warning*&: This is an incorrect example: .code server_condition = \ - ${if eq{$3}{${lookup{$2}dbm{/etc/authpwd}}}{yes}{no}} + ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}{yes}{no}} .endd -The expansion uses the user name (&$2$&) as the key to look up a password, -which it then compares to the supplied password (&$3$&). Why is this example +The expansion uses the user name (&$auth2$&) as the key to look up a password, +which it then compares to the supplied password (&$auth3$&). Why is this example incorrect? It works fine for existing users, but consider what happens if a non-existent user name is given. The lookup fails, but as no success/failure strings are given for the lookup, it yields an empty string. Thus, to defeat the authentication, all a client has to do is to supply a non-existent user name and an empty password. The correct way of writing this test is: .code -server_condition = ${lookup{$2}dbm{/etc/authpwd}\ - {${if eq{$value}{$3}{yes}{no}}}{no}} +server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\ + {${if eq{$value}{$auth3}{yes}{no}}}{no}} .endd +.wen In this case, if the lookup succeeds, the result is checked; if the lookup fails, authentication fails. If &%crypteq%& is being used instead of &%eq%&, the first example is in fact safe, because &%crypteq%& always fails if its @@ -22312,15 +22534,18 @@ The LOGIN authentication mechanism is not documented in any RFC, but is in use in a number of programs. No data is sent with the AUTH command. Instead, a user name and password are supplied separately, in response to prompts. The plaintext authenticator can be configured to support this as in this example: +.new .code fixed_login: driver = plaintext public_name = LOGIN server_prompts = User Name : Password server_condition = \ - ${if and {{eq{$1}{username}}{eq{$2}{mysecret}}}{yes}{no}} - server_set_id = $1 + ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}\ + {yes}{no}} + server_set_id = $auth1 .endd +.wen Because of the way plaintext operates, this authenticator accepts data supplied with the AUTH command (in contravention of the specification of LOGIN), but if the client does not supply it (as is the case for LOGIN clients), the prompt @@ -22331,17 +22556,19 @@ example, Outlook Express is reported to recognize only &"Username:"& and &"Password:"&. Here is an example of a LOGIN authenticator that uses those strings. It uses the &%ldapauth%& expansion condition to check the user name and password by binding to an LDAP server: +.new .code login: driver = plaintext public_name = LOGIN server_prompts = Username:: : Password:: server_condition = ${if ldapauth \ - {user="cn=${quote_ldap_dn:$1},ou=people,o=example.org" \ - pass=${quote:$2} \ + {user="cn=${quote_ldap_dn:$auth1},ou=people,o=example.org" \ + pass=${quote:$auth2} \ ldap://ldap.example.org/}{yes}{no}} - server_set_id = uid=$1,ou=people,o=example.org + server_set_id = uid=$auth1,ou=people,o=example.org .endd +.wen Note the use of the &%quote_ldap_dn%& operator to correctly quote the DN for authentication. However, the basic &%quote%& operator, rather than any of the LDAP quoting operators, is the correct one to use for the password, because @@ -22354,7 +22581,7 @@ LDAP level, the password is an uninterpreted string. A number of string expansion features are provided for the purpose of interfacing to different ways of user authentication. These include checking traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM, -Radius, &%ldapauth%&, and &'pwcheck'&. For details see section +Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section &<>&. @@ -22362,15 +22589,30 @@ Radius, &%ldapauth%&, and &'pwcheck'&. For details see section .section "Using plaintext in a client" .cindex "options" "&(plaintext)& authenticator (client)" -The &(plaintext)& authenticator has just one client option: - +The &(plaintext)& authenticator has two client options: +.new +.option client_ignore_invalid_base64 plaintext boolean false +If the client receives a server prompt that is not a valid base64 string, +authentication is abandoned by default. However, if this option is set true, +the error in the challenge is ignored and the client sends the response as +usual. +.wen .option client_send plaintext string&!! unset +.new The string is a colon-separated list of authentication data strings. Each string is independently expanded before being sent to the server. The first string is sent with the AUTH command; any more strings are sent in response -to prompts from the server. +to prompts from the server. Before each string is expanded, the value of the +most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting +with &$auth1$& for the first prompt. Up to three prompts are stored in this +way. Thus, the prompt that is received in response to sending the first string +(with the AUTH command) can be used in the expansion of the second string, and +so on. If an invalid base64 string is received when +&%client_ignore_invalid_base64%& is set, an empty string is put in the +&$auth$&<&'n'&> variable. +.wen &*Note*&: You cannot use expansion to create multiple strings, because splitting takes priority and happens first. @@ -22401,6 +22643,8 @@ fixed_login: The initial colon means that the first string is empty, so no data is sent with the AUTH command itself. The remaining strings are sent in response to prompts. +.ecindex IIDplaiauth1 +.ecindex IIDplaiauth2 @@ -22409,8 +22653,8 @@ prompts. . //////////////////////////////////////////////////////////////////////////// .chapter "The cram_md5 authenticator" -.cindex "&(cram_md5)& authenticator" -.cindex "authenticators" "&(cram_md5)&" +.scindex IIDcramauth1 "&(cram_md5)& authenticator" +.scindex IIDcramauth2 "authenticators" "&(cram_md5)&" .cindex "CRAM-MD5 authentication mechanism" .cindex "authentication" "CRAM-MD5 mechanism" The CRAM-MD5 authentication mechanism is described in RFC 2195. The server @@ -22430,34 +22674,45 @@ authenticator as a server: .option server_secret cram_md5 string&!! unset .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator" When the server receives the client's response, the user name is placed in -the expansion variable &$1$&, and &%server_secret%& is expanded to obtain the -password for that user. The server then computes the CRAM-MD5 digest that the -client should have sent, and checks that it received the correct string. If the -expansion of &%server_secret%& is forced to fail, authentication fails. If the -expansion fails for some other reason, a temporary error code is returned to -the client. +the expansion variable &new("&$auth1$&"), and &%server_secret%& is expanded to +obtain the password for that user. The server then computes the CRAM-MD5 digest +that the client should have sent, and checks that it received the correct +string. If the expansion of &%server_secret%& is forced to fail, authentication +fails. If the expansion fails for some other reason, a temporary error code is +returned to the client. + +.new +For compatibility with previous releases of Exim, the user name is also placed +in &$1$&. However, the use of this variables for this purpose is now +deprecated, as it can lead to confusion in string expansions that also use +numeric variables for other things. +.wen For example, the following authenticator checks that the user name given by the client is &"ph10"&, and if so, uses &"secret"& as the password. For any other user name, authentication fails. +.new .code fixed_cram: driver = cram_md5 public_name = CRAM-MD5 - server_secret = ${if eq{$1}{ph10}{secret}fail} - server_set_id = $1 + server_secret = ${if eq{$auth1}{ph10}{secret}fail} + server_set_id = $auth1 .endd +.wen .cindex "&$authenticated_id$&" If authentication succeeds, the setting of &%server_set_id%& preserves the user name in &$authenticated_id$&. A more tyical configuration might look up the secret string in a file, using the user name as the key. For example: +.new .code lookup_cram: driver = cram_md5 public_name = CRAM-MD5 - server_secret = ${lookup{$1}lsearch{/etc/authpwd}{$value}fail} - server_set_id = $1 + server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}{$value}fail} + server_set_id = $auth1 .endd +.wen Note that this expansion explicitly forces failure if the lookup fails because &$1$& contains an unknown user name. @@ -22496,6 +22751,8 @@ fixed_cram: client_name = ph10 client_secret = secret .endd +.ecindex IIDcramauth1 +.ecindex IIDcramauth2 @@ -22503,8 +22760,8 @@ fixed_cram: . //////////////////////////////////////////////////////////////////////////// .chapter "The cyrus_sasl authenticator" -.cindex "&(cyrus_sasl)& authenticator" -.cindex "authenticators" "&(cyrus_sasl)&" +.scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator" +.scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&" .cindex "Cyrus" "SASL library" The code for this authenticator was provided by Matthew Byng-Maddick of A L Digital Ltd (&url(http://www.aldigital.co.uk)). @@ -22528,8 +22785,15 @@ depending on the driver you are using. .section "Using cyrus_sasl as a server" -The &(cyrus_sasl)& authenticator has four private options. It puts the -username (on a successful authentication) into &$1$&. +.new +The &(cyrus_sasl)& authenticator has four private options. It puts the username +(on a successful authentication) into &$auth1$&. For compatibility with +previous releases of Exim, the username is also placed in &$1$&. However, the +use of this variable for this purpose is now deprecated, as it can lead to +confusion in string expansions that also use numeric variables for other +things. +.wen + .option server_hostname cyrus_sasl string&!! &`$primary_hostname`& This option selects the hostname that is used when communicating with @@ -22541,13 +22805,15 @@ this data. This option selects the authentication mechanism this driver should use. It allows you to use a different underlying mechanism from the advertised name. For example: +.new .code sasl: driver = cyrus_sasl public_name = X-ANYTHING server_mech = CRAM-MD5 - server_set_id = $1 + server_set_id = $auth1 .endd +.wen .option server_realm cyrus_sasl string unset This specifies the SASL realm that the server claims to be in. @@ -22561,20 +22827,24 @@ For straightforward cases, you do not need to set any of the authenticator's private options. All you need to do is to specify an appropriate mechanism as the public name. Thus, if you have a SASL library that supports CRAM-MD5 and PLAIN, you could have two authenticators as follows: +.new .code sasl_cram_md5: driver = cyrus_sasl public_name = CRAM-MD5 - server_set_id = $1 + server_set_id = $auth1 sasl_plain: driver = cyrus_sasl public_name = PLAIN - server_set_id = $1 + server_set_id = $auth1 .endd +.wen Cyrus SASL does implement the LOGIN authentication method, even though it is not a standard method. It is disabled by default in the source distribution, but it is present in many binary distributions. +.ecindex IIDcyrauth1 +.ecindex IIDcyrauth2 @@ -22582,9 +22852,9 @@ but it is present in many binary distributions. . //////////////////////////////////////////////////////////////////////////// . //////////////////////////////////////////////////////////////////////////// -.chapter "The spa authenticator" -.cindex "&(spa)& authenticator" -.cindex "authenticators" "&(spa)&" +.chapter "The spa authenticator" "CHAPspa" +.scindex IIDspaauth1 "&(spa)& authenticator" +.scindex IIDspaauth2 "authenticators" "&(spa)&" .cindex "authentication" "Microsoft Secure Password" .cindex "authentication" "NTLM" .cindex "Microsoft Secure Password Authentication" @@ -22617,15 +22887,21 @@ The &(spa)& authenticator has just one server option: .option server_password spa string&!! unset .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator" +.new This option is expanded, and the result must be the cleartext password for the -authenticating user, whose name is at this point in &$1$&. For example: +authenticating user, whose name is at this point in &$auth1$&. For +compatibility with previous releases of Exim, the user name is also placed in +&$1$&. However, the use of this variable for this purpose is now deprecated, as +it can lead to confusion in string expansions that also use numeric variables +for other things. For example: .code spa: driver = spa public_name = NTLM - server_password = ${lookup{$1}lsearch{/etc/exim/spa_clearpass}\ - {$value}fail} + server_password = \ + ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail} .endd +.wen If the expansion is forced to fail, authentication fails. Any other expansion failure causes a temporary error code to be returned. @@ -22659,6 +22935,8 @@ msn: client_password = msn_plaintext_password client_domain = DOMAIN_OR_UNSET .endd +.ecindex IIDspaauth1 +.ecindex IIDspaauth2 @@ -22669,8 +22947,8 @@ msn: .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&& "Encrypted SMTP connections" -.cindex "encryption" "on SMTP connection" -.cindex "SMTP" "encryption" +.scindex IIDencsmtp1 "encryption" "on SMTP connection" +.scindex IIDencsmtp2 "SMTP" "encryption" .cindex "TLS" "on SMTP connection" .cindex "OpenSSL" .cindex "GnuTLS" @@ -22790,7 +23068,6 @@ renamed once it is complete. It does not matter if several Exim processes do this simultaneously (apart from wasting a few resources). Once a file is in place, new Exim processes immediately start using it. -.new For maximum security, the parameters that are stored in this file should be recalculated periodically, the frequency depending on your paranoia level. Arranging this is easy in principle; just delete the file when you want new @@ -22820,7 +23097,6 @@ renaming. The relevant commands are something like this: .endd If Exim never has to generate the parameters itself, the possibility of stalling is removed. -.wen .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl" @@ -22944,26 +23220,33 @@ encryption. To make this work you need to set, in the server, tls_certificate = /some/file/name tls_privatekey = /some/file/name .endd -The first file contains the server's X509 certificate, and the second contains -the private key that goes with it. These files need to be readable by the Exim -user, and must always be given as full path names. They can be the same file if -both the certificate and the key are contained within it. If &%tls_privatekey%& -is not set, this is assumed to be the case. The certificate file may also -contain intermediate certificates that need to be sent to the client to enable -it to authenticate the server's certificate. +.new +These options are, in fact, expanded strings, so you can make them depend on +the identity of the client that is connected if you wish. The first file +contains the server's X509 certificate, and the second contains the private key +that goes with it. These files need to be readable by the Exim user, and must +always be given as full path names. They can be the same file if both the +certificate and the key are contained within it. If &%tls_privatekey%& is not +set, or if its expansion is forced to fail or results in an empty string, this +is assumed to be the case. The certificate file may also contain intermediate +certificates that need to be sent to the client to enable it to authenticate +the server's certificate. +.wen If you do not understand about certificates and keys, please try to find a source of this background information, which is not Exim-specific. (There are a few comments below in section &<>&.) +.new &*Note*&: These options do not apply when Exim is operating as a client &-- -they apply only in the case of a server. For a client, you must set the options -of the same name in an &(smtp)& transport. +they apply only in the case of a server. If you need to use a certificate in an +Exim client, you must set the options of the same names in an &(smtp)& +transport. -With just these options, Exim will work as a server with clients such as -Netscape. It does not require the client to have a certificate (but see below -for how to insist on this). There is one other option that may be needed in -other situations. If +With just these options, an Exim server will be able to use TLS. It does not +require the client to have a certificate (but see below for how to insist on +this). There is one other option that may be needed in other situations. If +.wen .code tls_dhparam = /some/file/name .endd @@ -22973,9 +23256,8 @@ suites that the server supports. See the command .code openssl dhparam .endd -for a way of generating this data. -At present, &%tls_dhparam%& is used only when Exim is linked with OpenSSL. It -is ignored if GnuTLS is being used. +for a way of generating this data. At present, &%tls_dhparam%& is used only +when Exim is linked with OpenSSL. It is ignored if GnuTLS is being used. The strings supplied for these three options are expanded every time a client host connects. It is therefore possible to use different certificates and keys @@ -23230,6 +23512,8 @@ For information on creating self-signed CA certificates and using them to sign user certificates, see the &'General implementation overview'& chapter of the Open-source PKI book, available online at &url(http://ospkibook.sourceforge.net/). +.ecindex IIDencsmtp1 +.ecindex IIDencsmtp2 @@ -23237,7 +23521,7 @@ Open-source PKI book, available online at . //////////////////////////////////////////////////////////////////////////// .chapter "Access control lists" "CHAPACL" -.cindex "&ACL;" "description" +.scindex IIDacl "&ACL;" "description" .cindex "control of incoming mail" .cindex "message" "controlling incoming" .cindex "policy control" "access control lists" @@ -23382,10 +23666,8 @@ session. For example, you can use ACL variables in other ACLs to count messages, recipients, etc., and log the totals at QUIT time using one or more &%logwrite%& modifiers on a &%warn%& verb. -.new &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because the &$acl_m$&&'x'& variables are reset at the end of each incoming message. -.wen You do not need to have a final &%accept%&, but if you do, you can use a &%message%& modifier to specify custom text that is sent as part of the 221 @@ -23507,8 +23789,8 @@ When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables that contain information about the host and the message's sender (for example, &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and -&$local_part$& are set from the argument address. &new("The entire SMTP command -is available in &$smtp_command$&.") +&$local_part$& are set from the argument address. The entire SMTP command +is available in &$smtp_command$&. When an ACL for the AUTH parameter of MAIL is running, the variables that contain information about the host are set, but &$sender_address$& is not yet @@ -23541,7 +23823,7 @@ of previously accepted recipients. At DATA time (for both the DATA ACLs), .cindex &$smtp_command$& When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY, the remainder of the SMTP command line is placed in &$smtp_command_argument$&, -&new("and the entire SMTP command is available in &$smtp_command$&.") +and the entire SMTP command is available in &$smtp_command$&. These variables can be tested using a &%condition%& condition. For example, here is an ACL for use with AUTH, which insists that either the session is encrypted, or the CRAM-MD5 authentication method is used. In other words, it @@ -23667,7 +23949,7 @@ passes to the next ACL statement. The text of the added header line and the log line are specified by modifiers; if they are not present, a &%warn%& verb just checks its conditions and obeys any &"immediate"& modifiers such as &%set%& and &%logwrite%&. There is more about adding header lines in section -&<>&. +&<>&. If any condition on a &%warn%& statement cannot be completed (that is, there is some sort of defer), no header lines are added and the configured log line is @@ -23713,12 +23995,13 @@ transports, and filters that are used to deliver a message. There are two sets of these variables: .ilist -The values of &$acl_c0$& to &$acl_c9$& persist throughout an SMTP connection. -They are never reset. Thus, a value that is set while receiving one message is -still available when receiving the next message on the same SMTP connection. +The values of &$acl_c0$& to &new(&$acl_c19$&) persist throughout an SMTP +connection. They are never reset. Thus, a value that is set while receiving one +message is still available when receiving the next message on the same SMTP +connection. .next -The values of &$acl_m0$& to &$acl_m9$& persist only while a message is being -received. They are reset afterwards. They are also reset by MAIL, RSET, +The values of &$acl_m0$& to &new(&$acl_m19$&) persist only while a message is +being received. They are reset afterwards. They are also reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session. .endlist @@ -23743,7 +24026,6 @@ An exclamation mark preceding a condition negates its result. For example: deny domains = *.dom.example !verify = recipient .endd -.new causes the ACL to return &"deny"& if the recipient domain ends in &'dom.example'& and the recipient address cannot be verified. Sometimes negation can be used on the right-hand side of a condition. For example, these @@ -23754,7 +24036,6 @@ deny !hosts = 192.168.3.4 .endd However, for many conditions (&%verify%& being a good example), only left-hand side negation of the whole condition is possible. -.wen The arguments of conditions and modifiers are expanded. A forced failure of an expansion causes a condition to be ignored, that is, it behaves as if the @@ -23816,6 +24097,13 @@ by which time Exim has set up the message. The ACL modifiers are as follows: .vlist +.new +.vitem &*add_header*&&~=&~<&'text'&> +This modifier specifies one of more header lines that are to be added to an +incoming message, assuming, of course, that the message is ultimately +accepted. For details, see section &<>&. +.wen + .vitem &*control*&&~=&~<&'text'&> .cindex "&%control%&" "ACL modifier" This modifier affects the subsequent processing of the SMTP connection or of an @@ -23978,12 +24266,6 @@ it processes &%message%&. If the expansion fails, or generates an empty string, the modifier is ignored. For ACLs that are triggered by SMTP commands, the message is returned as part of the SMTP error response. -The &%message%& modifier is also used with the &%warn%& verb to specify one or -more header lines to be added to an incoming message when all the conditions -are true. See section &<>& for more details. If &%message%& is -used with &%warn%& in an ACL that is not concerned with receiving a message, it -has no effect. - The text is literal; any quotes are taken as literals, but because the string is expanded, backslash escapes are processed anyway. If the message contains newlines, this gives rise to a multi-line SMTP response. Like &%log_message%&, @@ -23999,6 +24281,16 @@ wish. In particular, if you want the text from &%:fail:%& items in &(redirect)& routers to be passed back as part of the SMTP response, you should either not use a &%message%& modifier, or make use of &$acl_verify_message$&. +.new +For compatibility with previous releases of Exim, a &%message%& modifier that +is used with a &%warn%& verb behaves in a similar way to the &%add_header%& +modifier, but this usage is now deprecated. However, &%message%& acts only when +all the conditions are true, wherever it appears in an ACL command, whereas +&%add_header%& acts as soon as it is encountered. If &%message%& is used with +&%warn%& in an ACL that is not concerned with receiving a message, it has no +effect. +.wen + .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&> .cindex "&%set%&" "ACL modifier" This modifier puts a value into one of the ACL variables (see section @@ -24007,11 +24299,33 @@ This modifier puts a value into one of the ACL variables (see section + + .section "Use of the control modifier" "SECTcontrols" .cindex "&%control%&" "ACL modifier" The &%control%& modifier supports the following settings: .vlist +.new +.vitem &*control&~=&~allow_auth_unadvertised*& +This modifier allows a client host to use the SMTP AUTH command even when it +has not been advertised in response to EHLO. Furthermore, because there are +apparently some really broken clients that do this, Exim will accept AUTH after +HELO (rather than EHLO) when this control is set. It should be used only if you +really need it, and you should limit its use to those broken clients that do +not work without it. For example: +.code +warn hosts = 192.168.34.25 + control = allow_auth_unadvertised +.endd +Normally, when an Exim server receives an AUTH command, it checks the name of +the authentication mechanism that is given in the command to ensure that it +matches an advertised mechanism. When this control is set, the check that a +mechanism has been advertised is bypassed. Any configured mechanism can be used +by the client. This control is permitted only in the connection and HELO ACLs. +.wen + + .vitem &*control&~=&~caseful_local_part*& See below. @@ -24066,7 +24380,6 @@ synchronization checks for badly-behaved hosts that you nevertheless need to work with. -.new .vitem &*control&~=&~fakedefer/*&<&'message'&> .cindex "fake defer" .cindex "defer" "fake" @@ -24075,7 +24388,6 @@ except that it causes an SMTP 450 response after the message data instead of a 550 response. You must take care when using &%fakedefer%& because it causes the messages to be duplicated when the sender retries. Therefore, you should not use &%fakedefer%& if the message is to be delivered normally. -.wen .vitem &*control&~=&~fakereject/*&<&'message'&> .cindex "fake rejection" @@ -24105,6 +24417,14 @@ it is placed on Exim's queue and frozen. The control applies only to the current message, not to any subsequent ones that may be received in the same SMTP connection. +.new +This modifier can optionally be followed by &`/no_tell`&. If the global option +&%freeze_tell%& is set, it is ignored for the current message (that is, nobody +is told about the freezing), provided all the &*control=freeze*& modifiers that +are obeyed for the current message have the &`/no_tell`& option. +.wen + + .vitem &*control&~=&~no_mbox_unspool*& This control is available when Exim is compiled with the content scanning extension. Content scanning may require a copy of the current message, or parts @@ -24168,7 +24488,6 @@ submission mode; the available options for this control are described there. The control applies only to the current message, not to any subsequent ones that may be received in the same SMTP connection. -.new .vitem &*control&~=&~suppress_local_fixups*& .cindex "submission fixups" "suppressing" This control applies to locally submitted (non TCP/IP) messages, and is the @@ -24200,69 +24519,103 @@ Remotely submitted, no fixups applied: the default. .next Remotely submitted, fixups applied: use &`control`& &`=`& &`submission`&. .endlist -.wen - -.section "Adding header lines with the warn verb" "SECTaddheadwarn" +.new +.section "Adding header lines in ACLs" "SECTaddheadacl" .cindex "header lines" "adding in an ACL" .cindex "header lines" "position of added lines" -.cindex "&%warn%&" "ACL verb" .cindex "&%message%&" "ACL modifier" -The &%message%& modifier can be used on a &%warn%& statement to add an extra -header line to an incoming message, as in this example: +The &%add_header%& modifier can be used to add one or more extra header lines +to an incoming message, as in this example: .code -warn message = X-blacklisted-at: $dnslist_domain - dnslists = sbl.spamhaus.org : \ +warn dnslists = sbl.spamhaus.org : \ dialup.mail-abuse.org + add_header = X-blacklisted-at: $dnslist_domain .endd -If an identical header line is requested several times (provoked, for example, -by multiple RCPT commands), only one copy is actually added to the message. -If the text of the &%message%& modifier contains one or more newlines that are -not followed by a space or a tab, it is assumed to contain multiple header +The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA, +MIME, and non-SMTP ACLs (in other words, those that are concerned with +receiving a message). The message must ultimately be accepted for +&%add_header%& to have any significant effect. You can use &%add_header%& with +any ACL verb, including &%deny%& (though this is potentially useful only in a +RCPT ACL). + +If the data for the &%add_header%& modifier contains one or more newlines that +are not followed by a space or a tab, it is assumed to contain multiple header lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the front of any line that is not a valid header line. -By default, new lines are added at the end of the existing header lines. -However, you can specify that any particular header line should be added right -at the start (before all the &'Received:'& lines), immediately after the first -block of &'Received:'& lines, or immediately before any line that is not a -&'Received:'& or &'Resent-something:'& header. +Added header lines are accumulated during the MAIL, RCPT, and predata ACLs. +They are added to the message before processing the DATA and MIME ACLs. +However, if an identical header line is requested more than once, only one copy +is actually added to the message. Further header lines may be accumulated +during the DATA and MIME ACLs, after which they are added to the message, again +with duplicates suppressed. Thus, it is possible to add two identical header +lines to an SMTP message, but only if one is added before DATA and one after. +In the case of non-SMTP messages, new headers are accumulated during the +non-SMTP ACL, and added to the message at the end. If a message is rejected +after DATA or by the non-SMTP ACL, all added header lines are included in the +entry that is written to the reject log. + +.cindex "header lines" "added; visibility of" +Header lines are not visible in string expansions until they are added to the +message. It follows that header lines defined in the MAIL, RCPT, and predata +ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly, +header lines that are added by the DATA or MIME ACLs are not visible in those +ACLs. Because of this restriction, you cannot use header lines as a way of +passing data between (for example) the MAIL and RCPT ACLs. If you want to do +this, you can use ACL variables, as described in section +&<>&. + +The &%add_header%& modifier acts immediately it is encountered during the +processing of an ACL. Notice the difference between these two cases: +.display +&`accept add_header = ADDED: some text`& +&` `&<&'some condition'&> + +&`accept `&<&'some condition'&> +&` add_header = ADDED: some text`& +.endd +In the first case, the header line is always added, whether or not the +condition is true. In the second case, the header line is added only if the +condition is true. Multiple occurrences of &%add_header%& may occur in the same +ACL statement. All those that are encountered before a condition fails are +honoured. + +.cindex "&%warn%&" "ACL verb" +For compatibility with previous versions of Exim, a &%message%& modifier for a +&%warn%& verb acts in the same way as &%add_header%&, except that it takes +effect only if all the conditions are true, even if it appears before some of +them. Furthermore, only the last occurrence of &%message%& is honoured. This +usage of &%message%& is now deprecated. If both &%add_header%& and &%message%& +are present on a &%warn%& verb, both are processed according to their +specifications. + +By default, new header lines are added to a message at the end of the existing +header lines. However, you can specify that any particular header line should +be added right at the start (before all the &'Received:'& lines), immediately +after the first block of &'Received:'& lines, or immediately before any line +that is not a &'Received:'& or &'Resent-something:'& header. This is done by specifying &":at_start:"&, &":after_received:"&, or &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the header line, respectively. (Header text cannot start with a colon, as there has to be a header name first.) For example: .code -warn message = :after_received:X-My-Header: something or other... +warn add_header = \ + :after_received:X-My-Header: something or other... .endd -If more than one header is supplied in a single warn statement, each one is -treated independently and can therefore be placed differently. If you add -more than one line at the start, or after the Received: block, they will -end up in reverse order. +If more than one header line is supplied in a single &%add_header%& modifier, +each one is treated independently and can therefore be placed differently. If +you add more than one line at the start, or after the Received: block, they end +up in reverse order. &*Warning*&: This facility currently applies only to header lines that are added in an ACL. It does NOT work for header lines that are added in a system filter or in a router or transport. - -.new -.cindex "header lines" "added; visibility of" -Header lines that are added by an ACL at MAIL or RCPT time are not visible in -string expansions in ACLs for subsequent RCPT commands or in the -&%acl_smtp_predata%& ACL. However, they are visible in string expansions in the -ACL that is run after DATA is complete (the &%acl_smtp_data%& ACL). This is -also true for header lines that are added in the &%acl_smtp_predata%& ACL. -However, header lines that are added in the &%acl_smtp_data%& itself are not -visible during that ACL. If a message is rejected after DATA, all added header -lines are included in the entry that is written to the reject log. .wen -If you want to preserve data between MAIL, RCPT, and the -&%acl_smtp_predata%& ACLs, you can use ACL variables, as described in section -&<>&. - - @@ -24439,12 +24792,10 @@ content-scanning extension, and it is allowed only the the ACL defined by with any of the regular expressions. For details, see chapter &<>&. -.new .vitem &*ratelimit&~=&~*&<&'parameters'&> .cindex "rate limiting" This condition can be used to limit the rate at which a user or host submits messages. Details are given in section &<>&. -.wen .vitem &*recipients&~=&~*&<&'address&~list'&> .cindex "&%recipients%&" "ACL condition" @@ -24475,10 +24826,8 @@ lists. It is done this way so that, if this condition is used in an ACL for a RCPT command, the recipient's domain (which is in &$domain$&) can be used to influence the sender checking. -.new &*Warning*&: It is a bad idea to use this condition on its own as a control on relaying, because sender addresses are easily, and commonly, forged. -.wen .vitem &*senders&~=&~*&<&'address&~list'&> .cindex "&%senders%&" "ACL condition" @@ -24489,10 +24838,8 @@ for a bounce message, which has an empty sender, set .code senders = : .endd -.new &*Warning*&: It is a bad idea to use this condition on its own as a control on relaying, because sender addresses are easily, and commonly, forged. -.wen .vitem &*spam&~=&~*&<&'username'&> .cindex "&%spam%&" "ACL condition" @@ -24512,13 +24859,11 @@ certificate was received from the client, and the certificate was verified. The server requests a certificate only if the client matches &%tls_verify_hosts%& or &%tls_try_verify_hosts%& (see chapter &<>&). -.new .vitem &*verify&~=&~csa*& .cindex "CSA verification" This condition checks whether the sending host (the client) is authorized to send email. Details of how this works are given in section &<>&. -.wen .vitem &*verify&~=&~header_sender/*&<&'options'&> .cindex "&%verify%&" "ACL condition" @@ -24575,16 +24920,13 @@ common as they used to be. .cindex "EHLO" "verifying" .cindex "verifying" "EHLO" .cindex "verifying" "HELO" -.new This condition is true if a HELO or EHLO command has been received from the client host, and its contents have been verified. It there has been no previous attempt to verify the 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. -.wen -.new .vitem &*verify&~=&~not_blind*& .cindex "verifying" "not blind" .cindex "bcc recipients" "verifying none" @@ -24597,7 +24939,6 @@ used only in a DATA or non-SMTP ACL. There are, of course, many legitimate messages that make use of blind (bcc) recipients. This check should not be used on its own for blocking messages. -.wen .vitem &*verify&~=&~recipient/*&<&'options'&> @@ -24989,7 +25330,6 @@ deny condition = ${if isip4{$sender_host_address}} dnslists = some.list.example .endd -.new .section "Rate limiting senders" "SECTratelimiting" .cindex "rate limiting" "client sending" .cindex "limiting client sending rates" @@ -25006,7 +25346,6 @@ host. The syntax of the &%ratelimit%& condition is: If the average client sending rate is less than &'m'& messages per time period &'p'& then the condition is false; otherwise it is true. -.new As a side-effect, the &%ratelimit%& condition sets the expansion variable &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the configured value of &'m'&, and &$sender_rate_period$& to the configured value @@ -25037,7 +25376,6 @@ user, independent of the computer they are sending from, set the key to &$authenticated_id$&. You must ensure that the lookup key is meaningful; for example, &$authenticated_id$& is only meaningful if the client has authenticated, and you can check with with the &%authenticated%& ACL condition. -.wen Internally, Exim includes the smoothing constant &'p'& and the options in the lookup key because they alter the meaning of the stored data. This is not true @@ -25105,8 +25443,8 @@ warn ratelimit = 0 / 1h / strict log_message = Sender rate $sender_rate / $sender_rate_period -# Slow down fast senders; note the need to truncate $sender_rate at the -# decimal point. +# Slow down fast senders; note the need to truncate $sender_rate +# at the decimal point. warn ratelimit = 100 / 1h / per_rcpt / strict delay = ${eval: ${sg{$sender_rate}{[.].*}{}} - \ @@ -25138,7 +25476,6 @@ making your ACLs less complicated, you can reduce the problem by using a RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However this means that Exim will lose its hints data after a reboot (including retry hints, the callout cache, and ratelimit data). -.wen .section "Address verification" "SECTaddressverification" @@ -25173,7 +25510,6 @@ verification option as well as a suboption for callouts. The &%no_details%& option is covered in section &<>&, which discusses the reporting of sender address verification failures. .next -.new The &%success_on_redirect%& option causes verification always to succeed immediately after a successful redirection. By default, if a redirection generates just one address, that address is also verified. See further @@ -25194,7 +25530,6 @@ warn !verify = sender If you are writing your own custom rejection message or log message when denying access, you can use this variable to include information about the verification failure. -.wen In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as appropriate) contains one of the following words: @@ -25224,7 +25559,6 @@ rejections of MAIL and rejections of RCPT in callouts. .cindex "verifying address" "by callout" .cindex "callout" "verification" .cindex "SMTP" "callout verification" -.new For non-local addresses, routing verifies the domain, but is unable to do any checking of the local part. There are situations where some means of verifying the local part is desirable. One way this can be done is to make an SMTP @@ -25241,7 +25575,6 @@ described below. This facility should be used with care, because it can add a lot of resource usage to the cost of verifying an address. However, Exim does cache the results of callouts, which helps to reduce the cost. Details of caching are in section &<>&. -.wen Recipient callouts are usually used only between hosts that are controlled by the same administration. For example, a corporate gateway host could use @@ -25333,14 +25666,12 @@ When this parameter is present, failure to contact any host, or any other kind of temporary error, is treated as success by the ACL. However, the cache is not updated in this circumstance. -.new .vitem &*fullpostmaster*& .cindex "callout" "full postmaster check" This operates like the &%postmaster%& option (see below), but if the check for &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in accordance with the specification in RFC 2821. The RFC states that the unqualified address &'postmaster'& should be accepted. -.wen .vitem &*mailfrom&~=&~*&<&'email&~address'&> @@ -25426,13 +25757,11 @@ This parameter applies to recipient callouts only. For example: .code deny !verify = recipient/callout=use_postmaster .endd -.new .cindex "&$qualify_domain$&" It causes a non-empty postmaster address to be used in the MAIL command when performing the callout for the recipient, and also for a &"random"& check if that is configured. The local part of the address is &`postmaster`& and the domain is the contents of &$qualify_domain$&. -.wen .vitem &*use_sender*& This option applies to recipient callouts only. For example: @@ -25533,7 +25862,7 @@ RCPT TO: If more than one RCPT command fails in the same way, the details are given only for the first of them. However, some administrators do not want to send out this much information. You can suppress the details by adding -&"/no_details"& to the ACL statement that requests sender verification. For +&`/no_details`& to the ACL statement that requests sender verification. For example: .code verify = sender/no_details @@ -25568,7 +25897,6 @@ redirection generates more than one address, the behaviour is more like a mailing list, where the existence of the alias itself is sufficient for verification to succeed. -.new It is possible, however, to change the default behaviour so that all successful redirections count as successful verifications, however many new addresses are generated. This is specified by the &%success_on_redirect%& verification @@ -25578,12 +25906,10 @@ require verify = recipient/success_on_redirect/callout=10s .endd In this example, verification succeeds if a router generates a new address, and the callout does not occur, because no address was routed to a remote host. -.wen -.new .section "Client SMTP authorization (CSA)" "SECTverifyCSA" .cindex "CSA" "verifying" Client SMTP Authorization is a system that allows a site to advertise @@ -25666,7 +25992,7 @@ of outgoing messages have a cryptographic, timestamped &"tag"& added to them. Genuine incoming bounce messages should therefore always be addressed to recipients that have a valid tag. This scheme is a way of detecting unwanted bounce messages caused by sender address forgeries (often called &"collateral -spam"&), because the recipients of such messages will not include valid tags. +spam"&), because the recipients of such messages do not include valid tags. There are two expansion items to help with the implementation of the BATV &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs @@ -25714,10 +26040,23 @@ the third string (in this case &"1"&), whether or not the cryptographic and timeout checks succeed. The &$prvscheck_result$& variable contains the result of the checks (empty for failure, &"1"& for success). -Of course, when you accept a prvs-signed address, you have to ensure that the -routers accept it and deliver it correctly. The easiest way to handle this is -to use a &(redirect)& router to remove the signature with a configuration along -these lines: +.new +There are two more issues you must consider when implementing prvs-signing. +Firstly, you need to ensure that prvs-signed addresses are not blocked by your +ACLs. A prvs-signed address contains a slash character, but the default Exim +configuration contains this statement in the RCPT ACL: +.code +deny message = Restricted characters in address + domains = +local_domains + local_parts = ^[.] : ^.*[@%!/|] +.endd +This is a conservative rule that blocks local parts that contain slashes. You +should remove the slash in the last line. +.wen + +Secondly, you have to ensure that the routers accept prvs-signed addresses and +deliver them correctly. The easiest way to handle this is to use a &(redirect)& +router to remove the signature with a configuration along these lines: .code batv_redirect: driver = redirect @@ -25740,7 +26079,6 @@ external_smtp_batv: {$value}fail}}} .endd If no key can be found for the existing return path, no signing takes place. -.wen @@ -25823,7 +26161,7 @@ will see a normal telnet connection message and then quite a long delay. Be patient. The remote host is making an SMTP connection back to your host, and trying a number of common probes to test for open relay vulnerability. The results of the tests will eventually appear on your terminal. - +.ecindex IIDacl @@ -25831,30 +26169,26 @@ results of the tests will eventually appear on your terminal. . //////////////////////////////////////////////////////////////////////////// .chapter "Content scanning at ACL time" "CHAPexiscan" -.cindex "content scanning" "at ACL time" +.scindex IIDcosca "content scanning" "at ACL time" The extension of Exim to include content scanning at ACL time, formerly known as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code was integrated into the main source for Exim release 4.50, and Tom continues to maintain it. Most of the wording of this chapter is taken from Tom's specification. -.new It is also possible to scan the content of messages at other times. The &[local_scan()]& function (see chapter &<>&) allows for content scanning after all the ACLs have run. A transport filter can be used to scan messages at delivery time (see the &%transport_filter%& option, described in chapter &<>&). -.wen If you want to include the ACL-time content-scanning features when you compile Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your &_Local/Makefile_&. When you do that, the Exim binary is built with: .ilist -.new Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run for all MIME parts for SMTP and non-SMTP messages, respectively. -.wen .next Additional ACL conditions and modifiers: &%decode%&, &%malware%&, &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is @@ -26041,11 +26375,9 @@ The default path is &_/var/run/sophie_&, so if you are using this, you can omit the option. .endlist -.new When &%av_scanner%& is correctly set, you can use the &%malware%& condition in the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME ACL. -.wen The &%av_scanner%& option is expanded each time &%malware%& is called. This makes it possible to use different scanners. See further below for an example. @@ -26178,7 +26510,6 @@ right-hand side is expanded before being used, so you can put lookups or conditions there. When the right-hand side evaluates to &"0"& or &"false"&, no scanning is done and the condition fails immediately. -.new Scanning with SpamAssassin uses a lot of resources. If you scan every message, large ones may cause significant performance degredation. As most spam messages are quite small, it is recommended that you do not scan the big ones. For @@ -26188,7 +26519,6 @@ deny message = This message was classified as SPAM condition = ${if < {$message_size}{10K}} spam = nobody .endd -.wen The &%spam%& condition returns true if the threshold specified in the user's SpamAssassin profile has been matched or exceeded. If you want to use the @@ -26263,7 +26593,6 @@ deny message = This message scored $spam_score spam points. .cindex "content scanning" "MIME parts" .cindex "MIME content scanning" .cindex "&%acl_smtp_mime%&" -.new The &%acl_smtp_mime%& global option specifies an ACL that is called once for each MIME part of an SMTP message, including multipart types, in the sequence of their position in the message. Similarly, the &%acl_not_smtp_mime%& option @@ -26284,7 +26613,6 @@ only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%& condition to match against the raw MIME part. You can also use the &%mime_regex%& condition to match against the decoded MIME part (see section &<>&). -.wen At the start of a MIME ACL, a number of variables are set from the header information for the relevant MIME part. These are described below. The contents @@ -26583,6 +26911,7 @@ deny log_message = Another $found_extension file. demime = exe:doc control = freeze .endd +.ecindex IIDcosca @@ -26592,7 +26921,7 @@ deny log_message = Another $found_extension file. .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&& "Local scan function" -.cindex "&[local_scan()]& function" "description of" +.scindex IIDlosca "&[local_scan()]& function" "description of" .cindex "customizing" "input scan using C function" .cindex "policy control" "by local scan function" In these days of email worms, viruses, and ever-increasing spam, some sites @@ -27054,6 +27383,19 @@ finish and to collect its ending status. A timeout value of zero is usually fine in this circumstance. Unless you have made a mistake with the recipient addresses, you should get a return code of zero. + +.new +.vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&& + *sender_authentication)*& +This function is a more sophisticated version of &'child_open()'&. The command +that it runs is: +.display +&`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'& +.endd +The third argument may be NULL, in which case the &%-oMas%& option is omitted. +.wen + + .vitem &*void&~debug_printf(char&~*,&~...)*& This is Exim's debugging function, with arguments as for &'(printf()'&. The output is written to the standard error stream. If no debugging is selected, @@ -27063,6 +27405,7 @@ conditional on the &`local_scan`& debug selector by coding like this: if ((debug_selector & D_local_scan) != 0) debug_printf("xxx", ...); .endd + .vitem &*uschar&~*expand_string(uschar&~*string)*& This is an interface to Exim's string expansion code. The return value is the expanded string, or NULL if there was an expansion failure. @@ -27334,7 +27677,7 @@ The pool setting applies to all functions that get dynamic memory, including There is also a convenience function called &'store_get_perm()'& that gets a block of memory from the permanent pool while preserving the value of &%store_pool%&. - +.ecindex IIDlosca @@ -27343,9 +27686,9 @@ block of memory from the permanent pool while preserving the value of . //////////////////////////////////////////////////////////////////////////// .chapter "System-wide message filtering" "CHAPsystemfilter" -.cindex "filter" "system filter" -.cindex "filtering all mail" -.cindex "system filter" +.scindex IIDsysfil1 "filter" "system filter" +.scindex IIDsysfil2 "filtering all mail" +.scindex IIDsysfil3 "system filter" The previous chapters (on ACLs and the local scan function) describe checks that can be applied to messages before they are accepted by a host. There is also a mechanism for checking messages once they have been received, but before @@ -27630,6 +27973,9 @@ specify a significant delivery if the message is to go on to be delivered to its intended recipient. The router will not then claim to have dealt with the address, so it will be passed on to subsequent routers to be delivered in the normal way. +.ecindex IIDsysfil1 +.ecindex IIDsysfil2 +.ecindex IIDsysfil3 @@ -27640,7 +27986,7 @@ normal way. . //////////////////////////////////////////////////////////////////////////// .chapter "Message processing" "CHAPmsgproc" -.cindex "message" "general processing" +.scindex IIDmesproc "message" "general processing" Exim performs various transformations on the sender and recipient addresses of all messages that it handles, and also on the messages' header lines. Some of these are optional and configurable, while others always take place. All of @@ -27667,12 +28013,10 @@ that there are appropriate entries in your ACLs. .section "Submission mode for non-local messages" "SECTsubmodnon" .cindex "message" "submission" .cindex "submission mode" -.new Processing that happens automatically for locally-originated messages (unless &%suppress_local_fixups%& is set) can also be requested for messages that are received over TCP/IP. The term &"submission mode"& is used to describe this state. Submisssion mode is set by the modifier -.wen .code control = submission .endd @@ -27706,7 +28050,6 @@ example: .code control = submission/domain=some.domain .endd -.new The domain may be empty. How this value is used is described in sections &<>& and &<>&. There is also a &%name%& option that allows you to specify the user's full name for inclusion in a created @@ -27739,7 +28082,6 @@ untrusted sender address specified by the user, not the trusted sender address specified by submission mode. Although this might be slightly unexpected, it does mean that you can configure ACL checks to spot that a user is trying to spoof another's address. -.wen .section "Line endings" "SECTlineendings" .cindex "line endings" @@ -27898,13 +28240,13 @@ The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any .section "The Auto-Submitted: header line" -Whenever Exim generates a bounce or a delay warning message, it includes the -header line: .new +Whenever Exim generates an autoreply, a bounce, or a delay warning message, it +includes the header line: +.wen .code Auto-Submitted: auto-replied .endd -.wen .section "The Bcc: header line" .cindex "&'Bcc:'& header line" @@ -27916,11 +28258,9 @@ existing &'Bcc:'& is not removed. .section "The Date: header line" .cindex "&'Date:'& header line" -.new If a locally-generated or submission-mode message has no &'Date:'& header line, Exim adds one, using the current date and time, unless the &%suppress_local_fixups%& control has been specified. -.wen .section "The Delivery-date: header line" .cindex "&'Delivery-date:'& header line" @@ -27973,7 +28313,6 @@ If an empty domain is specified by the submission control, A non-empty envelope sender takes precedence. -.new If a locally-generated incoming message does not contain a &'From:'& header line, and the &%suppress_local_fixups%& control is not set, Exim adds one containing the sender's address. The calling user's login name and full name @@ -27981,7 +28320,6 @@ are used to construct the address, as described in section &<>&. They are obtained from the password data by calling &[getpwuid()]& (but see the &%unknown_login%& configuration option). The address is qualified with &%qualify_domain%&. -.wen For compatibility with Sendmail, if an incoming, non-SMTP message has a &'From:'& header line containing just the unqualified login name of the calling @@ -27993,7 +28331,6 @@ name as described in section &<>&. .cindex "&'Message-ID:'& header line" .cindex "message" "submission" .cindex "&%message_id_header_text%&" -.new If a locally-generated or submission-mode incoming message does not contain a &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the &%suppress_local_fixups%& control is not set, Exim adds a suitable header line @@ -28003,7 +28340,6 @@ message id, preceded by the letter E to ensure it starts with a letter, and followed by @ and the primary host name. Additional information can be included in this header line by setting the &%message_id_header_text%& and/or &%message_id_header_domain%& options. -.wen .section "The Received: header line" @@ -28022,6 +28358,21 @@ changed to the time of acceptance, which is (apart from a small delay while the -H spool file is written) the earliest time at which delivery could start. +.new +.section "The References: header line" +.cindex "&'References:'& header line" +Messages created by the &(autoreply)& transport include a &'References:'& +header line. This is constructed according to the rules that are described in +section 3.64 of RFC 2822 (which states that replies should contain such a +header line), and section 3.14 of RFC 3834 (which states that automatic +responses are not different in this respect). However, because some mail +processing software does not cope well with very long header lines, no more +than 12 message IDs are copied from the &'References:'& header line in the +incoming message. If there are more than 12, the first one and then the final +11 are copied, before adding the message ID of the incoming message. +.wen + + .section "The Return-path: header line" .cindex "&'Return-path:'& header line" @@ -28037,7 +28388,6 @@ default), Exim removes &'Return-path:'& header lines from incoming messages. .section "The Sender: header line" "SECTthesenhea" .cindex "&'Sender:'& header line" .cindex "message" "submission" -.new For a locally-originated message from an untrusted user, Exim may remove an existing &'Sender:'& header line, and it may add a new one. You can modify these actions by setting the &%local_sender_retain%& option true, the @@ -28053,7 +28403,6 @@ that is expected has the login name as the local part and the value of be permitted by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'& line is added to the message. -.wen If you set &%local_from_check%& false, this checking does not occur. However, the removal of an existing &'Sender:'& line still happens, unless you also set @@ -28088,12 +28437,10 @@ are different, a &'Sender:'& header line containing the created address is added. Prefixes and suffixes for the local part in &'From:'& can be permitted by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately. -.new .cindex "return path" "created from &'Sender:'&" &*Note*&: Whenever a &'Sender:'& header line is created, the return path for the message (the envelope sender address) is changed to be the same address, except in the case of submission mode when &%sender_retain%& is specified. -.wen @@ -28101,13 +28448,11 @@ except in the case of submission mode when &%sender_retain%& is specified. "SECTheadersaddrem" .cindex "header lines" "adding; in router or transport" .cindex "header lines" "removing; in router or transport" -.new When a message is delivered, the addition and removal of header lines can be specified in a system filter, or on any of the routers and transports that process the message. Section &<>& contains details about modifying headers in a system filter. Header lines can also be added in an ACL -as a message is received (see section &<>&). -.wen +as a message is received (see section &<>&). In contrast to what happens in a system filter, header modifications that are specified on routers and transports apply only to the particular recipient @@ -28116,11 +28461,9 @@ changes do not actually take place until a copy of the message is being transported. Therefore, they do not affect the basic set of header lines, and they do not affect the values of the variables that refer to header lines. -.new &*Note*&: In particular, this means that any expansions in the configuration of the transport cannot refer to the modified header lines, because such expansions all occur before the message is actually transported. -.wen For both routers and transports, the result of expanding a &%headers_add%& option must be in the form of one or more RFC 2822 header lines, separated by @@ -28303,14 +28646,16 @@ result of routing. However, doing this in practice would hold up many deliveries for unreasonable amounts of time, just because one address could not immediately be routed. Exim therefore does not delay other deliveries when routing of one or more addresses is deferred. +.ecindex IIDmesproc + . //////////////////////////////////////////////////////////////////////////// . //////////////////////////////////////////////////////////////////////////// .chapter "SMTP processing" "CHAPSMTP" -.cindex "SMTP" "processing details" -.cindex "LMTP" "processing details" +.scindex IIDsmtpproc1 "SMTP" "processing details" +.scindex IIDsmtpproc2 "LMTP" "processing details" Exim supports a number of different ways of using the SMTP protocol, and its LMTP variant, which is an interactive protocol for transferring messages into a closed mail store application. This chapter contains details of how SMTP is @@ -28569,57 +28914,6 @@ host error, in order not to delay other messages to the same host. - -.section "Variable Envelope Return Paths (VERP)" -.cindex "VERP" -.cindex "Variable Envelope Return Paths" -.cindex "envelope sender" -Variable Envelope Return Paths &-- see -&*ftp://koobera.math.uic.edu/www/proto/verp.txt*& &-- can be supported in Exim -by using the &%return_path%& generic transport option to rewrite the return -path at transport time. For example, the following could be used on an &(smtp)& -transport: -.code -return_path = \ - ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\ - {$1-request=$local_part%$domain@your.dom.example}fail} -.endd -This has the effect of rewriting the return path (envelope sender) on all -outgoing SMTP messages, if the local part of the original return path ends in -&"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the -local part and domain of the recipient into the return path. Suppose, for -example, that a message whose return path has been set to -&'somelist-request@your.dom.example'& is sent to -&'subscriber@other.dom.example'&. In the transport, the return path is -rewritten as -.code -somelist-request=subscriber%other.dom.example@your.dom.example -.endd -For this to work, you must arrange for outgoing messages that have &"-request"& -in their return paths to have just a single recipient. This can be done by -setting -.code -max_rcpt = 1 -.endd -.cindex "&$local_part$&" -in the &(smtp)& transport. Otherwise a single copy of a message might be -addressed to several different recipients in the same domain, in which case -&$local_part$& is not available (because it is not unique). Of course, if you -do start sending out messages with this kind of return path, you must also -configure Exim to accept the bounce messages that come back to those paths. -Typically this would be done by setting an &%local_part_suffix%& option for a -suitable router. - -The overhead incurred in using VERP depends very much on the size of the -message, the number of recipient addresses that resolve to the same remote -host, and the speed of the connection over which the message is being sent. If -a lot of addresses resolve to the same host and the connection is slow, sending -a separate copy of the message for each address may take substantially longer -than sending a single copy with many recipients (for which VERP cannot be -used). - - - .section "Incoming SMTP messages over TCP/IP" .cindex "SMTP" "incoming over TCP/IP" .cindex "incoming SMTP over TCP/IP" @@ -28960,6 +29254,8 @@ The rest of the batch was abandoned. The return code from Exim is zero only if there were no errors. It is 1 if some messages were accepted before an error was detected, and 2 if no messages were accepted. +.ecindex IIDsmtpproc1 +.ecindex IIDsmtpproc2 @@ -29289,6 +29585,107 @@ the address, giving a suitable error message. +.new +.section "Variable Envelope Return Paths (VERP)" "SECTverp" +.cindex "VERP" +.cindex "Variable Envelope Return Paths" +.cindex "envelope sender" +Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &-- +are a way of helping mailing list administrators discover which subscription +address is the cause of a particular delivery failure. The idea is to encode +the original recipient address in the outgoing envelope sender address, so that +if the message is forwarded by another host and then subsequently bounces, the +original recipient can be extracted from the recipient address of the bounce. + +.oindex &%errors_to%& +.oindex &%return_path%& +Envelope sender addresses can be modified by Exim using two different +facilities: the &%errors_to%& option on a router (as shown in previous mailing +list examples), or the &%return_path%& option on a transport. The second of +these is effective only if the message is successfully delivered to another +host; it is not used for errors detected on the local host (see the description +of &%return_path%& in chapter &<>&). Here is an example +of the use of &%return_path%& to implement VERP on an &(smtp)& transport: +.code +verp_smtp: + driver = smtp + max_rcpt = 1 + return_path = \ + ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\ + {$1-request=$local_part%$domain@your.dom.example}fail} +.endd +This has the effect of rewriting the return path (envelope sender) on outgoing +SMTP messages, if the local part of the original return path ends in +&"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the +local part and domain of the recipient into the return path. Suppose, for +example, that a message whose return path has been set to +&'somelist-request@your.dom.example'& is sent to +&'subscriber@other.dom.example'&. In the transport, the return path is +rewritten as +.code +somelist-request=subscriber%other.dom.example@your.dom.example +.endd +.cindex "&$local_part$&" +For this to work, you must also arrange for outgoing messages that have +&"-request"& in their return paths to have just a single recipient. That is +achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message +might be sent to several different recipients in the same domain, in which case +&$local_part$& is not available in the transport, because it is not unique. + +Unless your host is doing nothing but mailing list deliveries, you should +probably use a separate transport for the VERP deliveries, so as not to use +extra resources for the others. This can easily be done by expanding the +&%transport%& option in the router: +.code +dnslookup: + driver = dnslookup + domains = ! +local_domains + transport = \ + ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\ + {verp_smtp}{remote_smtp}} + no_more +.endd +If you want to change the return path using &%errors_to%& in a router instead +of using &%return_path%& in the transport, you need to set &%errors_to%& on all +routers that handle mailing list addresses. This will ensure that all delivery +errors, including those detected on the local host, are sent to the VERP +address. + +On a host that does no local deliveries and has no manual routing, only the +&(dnslookup)& router needs to be changed. A special transport is not needed for +SMTP deliveries. Every mailing list recipient has its own return path value, +and so Exim must hand them to the transport one at a time. Here is an example +of a &(dnslookup)& router that implements VERP: +.code +verp_dnslookup: + driver = dnslookup + domains = ! +local_domains + transport = remote_smtp + errors_to = \ + ${if match {$return_path}{^(.+?)-request@your.dom.example\$}} + {$1-request=$local_part%$domain@your.dom.example}fail} + no_more +.endd +Before you start sending out messages with VERPed return paths, you must also +configure Exim to accept the bounce messages that come back to those paths. +Typically this is done by setting a &%local_part_suffix%& option for a +router, and using this to route the messages to wherever you want to handle +them. + +The overhead incurred in using VERP depends very much on the size of the +message, the number of recipient addresses that resolve to the same remote +host, and the speed of the connection over which the message is being sent. If +a lot of addresses resolve to the same host and the connection is slow, sending +a separate copy of the message for each address may take substantially longer +than sending a single copy with many recipients (for which VERP cannot be +used). +.wen + + + + + + .section "Virtual domains" "SECTvirtualdomains" .cindex "virtual domains" .cindex "domain" "virtual" @@ -29642,8 +30039,8 @@ the advantages and disadvantages of running without root privilege. . //////////////////////////////////////////////////////////////////////////// .chapter "Log files" "CHAPlog" +.scindex IIDloggen "log" "general description" .cindex "log" "types of" -.cindex "log" "general description" Exim writes three different logs, referred to as the main log, the reject log, and the panic log: @@ -29989,7 +30386,6 @@ of Exim. .cindex "authentication" "logging" .cindex "AUTH" "logging" -.new For all messages, the P field specifies the protocol used to receive the message. This is the value that is stored in &$received_protocol$&. In the case of incoming SMTP messages, the value indicates whether or not any SMTP @@ -30004,7 +30400,6 @@ there is an additional item A= followed by the name of the authenticator that was used. If an authenticated identification was set up by the authenticator's &%server_set_id%& option, this is logged too, separated by a colon from the authenticator name. -.wen .cindex "size" "of message" The id field records the existing message id, if present. The size of the @@ -30251,6 +30646,7 @@ selection marked by asterisks: &`*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 @@ -30270,11 +30666,9 @@ More details on each of these items follows: .ilist .cindex "&%warn%& statement" "log when skipping" -.new &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of its conditions cannot be evaluated, a log line to this effect is written if this log selector is set. -.wen .next .cindex "log" "rewriting" .cindex "rewriting" "logging" @@ -30432,6 +30826,14 @@ and bounce line, tagged by F= (for &"from"&). This is the original sender that was received with the message; it is not necessarily the same as the outgoing return path. .next +.new +.cindex "log" "sender verify failure" +&%sender_verify_failure%&: If this selector is unset, the separate log line +that gives details of a sender verification failure is not written. Log lines +for the rejection of SMTP commands contain just &"sender verify failed"&, so +some detail is lost. +.wen +.next .cindex "log" "size rejection" &%size_reject%&: A log line is written whenever a message is rejected because it is too big. @@ -30521,11 +30923,9 @@ connection, the cipher suite used is added to the log line, preceded by X=. connection, and a certificate is supplied by the remote host, the peer DN is added to the log line, preceded by DN=. .next -.new .cindex "log" "DNS failure in list" &%unknown_in_list%&: This setting causes a log entry to be written when the result of a list match is failure because a DNS lookup failed. -.wen .endlist @@ -30546,14 +30946,14 @@ only with great care because they can fill up your disk very quickly. On a heavily loaded system, it may be desirable to disable the use of per-message logs, in order to reduce disk I/O. This can be done by setting the &%message_logs%& option false. - +.ecindex IIDloggen . //////////////////////////////////////////////////////////////////////////// . //////////////////////////////////////////////////////////////////////////// .chapter "Exim utilities" "CHAPutils" -.cindex "utilities" +.scindex IIDutils "utilities" A number of utility scripts and programs are supplied with Exim and are described in this chapter. There is also the Exim Monitor, which is covered in the next chapter. The utilities described here are: @@ -30579,11 +30979,9 @@ the next chapter. The utilities described here are: .row "" &<>& &'exim_lock'& "lock a mailbox file" .endtable -.new Another utility that might be of use to sites with many MTAs is Tom Kistner's &'exilog'&. It provides log visualizations across multiple Exim servers. See &url(http://duncanthrax.net/exilog/) for details. -.wen @@ -30732,14 +31130,12 @@ level"& addresses). "SECTextspeinf" .cindex "&'exigrep'&" .cindex "log" "extracts; grepping for" -.new The &'exigrep'& utility is a Perl script that searches one or more main log files for entries that match a given pattern. When it finds a match, it extracts all the log entries for the relevant message, not just those that match the pattern. Thus, &'exigrep'& can extract complete log entries for a given message, or all mail for a given user, or for a given host, for example. The input files can be in Exim log format or syslog format. -.wen If a matching log line is not associated with a specific message, it is always included in &'exigrep'&'s output. The usage is: @@ -30771,6 +31167,7 @@ exipick --help .section "Cycling log files (exicyclog)" "SECTcyclogfil" +.new .cindex "log" "cycling local files" .cindex "cycling logs" .cindex "&'exicyclog'&" @@ -30779,20 +31176,30 @@ The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and you are using log files with datestamps in their names (see section &<>&). Some operating systems have their own standard mechanisms for log cycling, and these can be used instead of &'exicyclog'& if preferred. +There are two command line options for &'exicyclog'&: +.ilist +&%-k%& <&'count'&> specifies the number of log files to keep, overriding the +default that is set when Exim is built. The default default is 10. +.next +&%-l%& <&'path'&> specifies the log file path, in the same format as Exim's +&%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again +overriding the script's default, which is to find the setting from Exim's +configuration. +.endlist Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes -&_mainlog.02_& and so on, up to a limit which is set in the script, and which -defaults to 10. Log files whose numbers exceed the limit are discarded. Reject +&_mainlog.02_& and so on, up to the limit that is set in the script or by the +&%-k%& option. Log files whose numbers exceed the limit are discarded. Reject logs are handled similarly. +.wen If the limit is greater than 99, the script uses 3-digit numbers such as &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99 to one that is greater, or &'vice versa'&, you will have to fix the names of any existing log files. - If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"& the end are deleted. All files with numbers greater than 01 are compressed, using a compression command which is configured by the COMPRESS_COMMAND @@ -31016,10 +31423,8 @@ second is the name of the database it is to operate on. These are as follows: for remote hosts .next &'callout'&: the callout cache -.new .next &'ratelimit'&: the data for implementing the ratelimit ACL condition -.wen .next &'misc'&: other hints data .endlist @@ -31074,7 +31479,6 @@ cross-references. .section "exim_tidydb" .cindex "&'exim_tidydb'&" -.new The &'exim_tidydb'& utility program is used to tidy up the contents of a hints database. If run with no options, it removes all records that are more than 30 days old. The age is calculated from the date and time that the record was last @@ -31082,7 +31486,6 @@ updated. Note that, in the case of the retry database, it is &'not'& the time since the first delivery failure. Information about a host that has been down for more than 30 days will remain in the database, provided that the record is updated sufficiently often. -.wen The cutoff date can be altered by means of the &%-t%& option, which must be followed by a time. For example, to remove all records older than a week from @@ -31239,14 +31642,14 @@ exim_lock -q /var/spool/mail/spqr \ .endd Note that if a command is supplied, it must be entirely contained within the second argument &-- hence the quotes. - +.ecindex IIDutils . //////////////////////////////////////////////////////////////////////////// . //////////////////////////////////////////////////////////////////////////// .chapter "The Exim monitor" "CHAPeximon" -.cindex "Exim monitor" "description" +.scindex IIDeximon "Exim monitor" "description" .cindex "X-windows" .cindex "&'eximon'&" .cindex "Local/eximon.conf" @@ -31575,7 +31978,7 @@ force an update of the display after one of these actions. In any text window that is displayed as result of a menu action, the normal cut-and-paste facility is available, and searching can be carried out using ^R and ^S, as described above for the log tail window. - +.ecindex IIDeximon @@ -31585,7 +31988,7 @@ and ^S, as described above for the log tail window. . //////////////////////////////////////////////////////////////////////////// .chapter "Security considerations" "CHAPsecurity" -.cindex "security" +.scindex IIDsecurcon "security" "discussion of" This chapter discusses a number of issues concerned with security, some of which are also covered in other parts of this manual. @@ -31970,6 +32373,7 @@ the format string itself, and checks the length of each conversion. .section "Use of strcat() and strcpy()" These are used only in cases where the output buffer is known to be large enough to hold the result. +.ecindex IIDsecurcon @@ -31978,9 +32382,9 @@ enough to hold the result. . //////////////////////////////////////////////////////////////////////////// .chapter "Format of spool files" "CHAPspool" -.cindex "format" "spool files" -.cindex "spool directory" "format of files" -.cindex "spool files" "format of" +.scindex IIDforspo1 "format" "spool files" +.scindex IIDforspo2 "spool directory" "format of files" +.scindex IIDforspo3 "spool files" "format of" .cindex "spool files" "editing" A message on Exim's queue consists of two files, whose names are the message id followed by -D and -H, respectively. The data portion of the message is kept in @@ -31995,7 +32399,6 @@ need to be extremely careful if you do this; it is not recommended and you are on your own if you do it. Here are some of the pitfalls: .ilist -.new You must ensure that Exim does not try to deliver the message while you are fiddling with it. The safest way is to take out a write lock on the -D file, which is what Exim itself does, using &[fcntl()]&. If you update the file in @@ -32007,7 +32410,6 @@ If you change the number of lines in the file, the value of &$body_linecount$&, which is stored in the -H file, will be incorrect. At present, this value is not used by Exim, but there is no guarantee that this will always be the case. -.wen .next If the message is in MIME format, you must take care not to break it. .next @@ -32050,12 +32452,29 @@ order, and are omitted when not relevant: .vlist .vitem "&%-acl%& <&'number'&> <&'length'&>" -A line of this form is present for every ACL variable that is not empty. The -number identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 -and the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length -of the data string for the variable. The string itself starts at the beginning -of the next line, and is followed by a newline character. It may contain -internal newlines. +.new +This item is obsolete, and is not generated from Exim release 4.61 onwards; +&%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still +recognized, to provide backward compatibility. In the old format, a line of +this form is present for every ACL variable that is not empty. The number +identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and +the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of +the data string for the variable. The string itself starts at the beginning of +the next line, and is followed by a newline character. It may contain internal +newlines. + +.vitem "&%-aclc%& <&'number'&> <&'length'&>" +A line of this form is present for every ACL connection variable that is not +empty. The number identifies the variable. The length is the length of the data +string for the variable. The string itself starts at the beginning of the next +line, and is followed by a newline character. It may contain internal newlines. + +.vitem "&%-aclm%& <&'number'&> <&'length'&>" +A line of this form is present for every ACL message variable that is not +empty. The number identifies the variable. The length is the length of the data +string for the variable. The string itself starts at the beginning of the next +line, and is followed by a newline character. It may contain internal newlines. +.wen .vitem "&%-active_hostname%& <&'hostname'&>" This is present if, when the message was received over SMTP, the value of @@ -32268,6 +32687,9 @@ darcy@austen.fict.example, editor@thesaurus.ref.example The asterisked headers indicate that the envelope sender, &'From:'& header, and &'To:'& header have been rewritten, the last one because routing expanded the unqualified domain &'foundation'&. +.ecindex IIDforspo1 +.ecindex IIDforspo2 +.ecindex IIDforspo3 diff --git a/doc/doc-docbook/x2man b/doc/doc-docbook/x2man index 9765ded0d..474d068a3 100755 --- a/doc/doc-docbook/x2man +++ b/doc/doc-docbook/x2man @@ -1,6 +1,6 @@ #! /usr/bin/perl -w -# $Cambridge: exim/doc/doc-docbook/x2man,v 1.2 2006/02/01 11:01:02 ph10 Exp $ +# $Cambridge: exim/doc/doc-docbook/x2man,v 1.3 2006/04/04 14:03:49 ph10 Exp $ # Script to find the command line options in the DocBook source of the Exim # spec, and turn them into a man page, because people like that. @@ -96,7 +96,7 @@ while ($next) # Start of new option - if (/^(-.*?)<\/term>$/) + if (/^(?=