a7fef970fa9bf7445ccadb05cdccb942ea51fc58
[exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.96"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .set drivernamemax "64"
55
56 .macro copyyear
57 2022
58 .endmacro
59
60 . /////////////////////////////////////////////////////////////////////////////
61 . Additional xfpt markup used by this document, over and above the default
62 . provided in the xfpt library.
63 . /////////////////////////////////////////////////////////////////////////////
64
65 . --- Override the &$ flag to automatically insert a $ with the variable name.
66
67 .flag &$  $&   "<varname>$"  "</varname>"
68
69 . --- Short flags for daggers in option headings. They will always be inside
70 . --- an italic string, but we want the daggers to be in Roman.
71
72 .flag &!!      "</emphasis>&dagger;<emphasis>"
73 .flag &!?      "</emphasis>&Dagger;<emphasis>"
74
75 . --- A macro for an Exim option definition heading, generating a one-line
76 . --- table with four columns. For cases when the option name is given with
77 . --- a space, so that it can be split, a fifth argument is used for the
78 . --- index entry.
79
80 .macro option
81 .arg 5
82 .oindex "&%$5%&"
83 .endarg
84 .arg -5
85 .oindex "&%$1%&"
86 .endarg
87 .itable all 0 0 4 8* left 6* center 6* center 6* right
88 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
89 .endtable
90 .endmacro
91
92 . --- A macro for the common 2-column tables. The width of the first column
93 . --- is suitable for the many tables at the start of the main options chapter;
94 . --- a small number of other 2-column tables override it.
95
96 .macro table2 196pt 254pt
97 .itable none 0 0 2 $1 left $2 left
98 .endmacro
99
100
101 . --- A macro for a plain variable, including the .vitem and .vindex
102 .macro var
103 .vitem $1
104 .vindex $1
105 .endmacro
106
107 . --- A macro for a "tainted" marker, done as a one-element table
108 .macro tmark
109 .itable none 0 0 1 10pt left
110 .row &'Tainted'&
111 .endtable
112 .endmacro
113
114 . --- A macro for a tainted variable, adding a taint-marker
115 .macro tvar
116 .var $1
117 .tmark
118 .endmacro
119
120 . --- A macro for a cmdline option, including a .oindex
121 . --- 1st arg is the option name, undecorated (we do that here).
122 . --- 2nd arg, optional, text (decorated as needed) to be appended to the name
123 .macro cmdopt
124 .vitem  &%$1%&$=2+&~$2+
125 .oindex &%$1%&
126 .endmacro
127
128 . --- A macro that generates .row, but puts &I; at the start of the first
129 . --- argument, thus indenting it. Assume a minimum of two arguments, and
130 . --- allow up to four arguments, which is as many as we'll ever need.
131
132 .macro irow
133 .arg 4
134 .row "&I;$1" "$2" "$3" "$4"
135 .endarg
136 .arg -4
137 .arg 3
138 .row "&I;$1" "$2" "$3"
139 .endarg
140 .arg -3
141 .row "&I;$1" "$2"
142 .endarg
143 .endarg
144 .endmacro
145
146 . --- Macros for option, variable, and concept index entries. For a "range"
147 . --- style of entry, use .scindex for the start and .ecindex for the end. The
148 . --- first argument of .scindex and the only argument of .ecindex must be the
149 . --- ID that ties them together.
150 . --- The index entry points to the most-recent chapter head, section or subsection
151 . --- head, or list-item.
152
153 .macro cindex
154 &<indexterm role="concept">&
155 &<primary>&$1&</primary>&
156 .arg 2
157 &<secondary>&$2&</secondary>&
158 .endarg
159 &</indexterm>&
160 .endmacro
161
162 .macro scindex
163 &<indexterm role="concept" id="$1" class="startofrange">&
164 &<primary>&$2&</primary>&
165 .arg 3
166 &<secondary>&$3&</secondary>&
167 .endarg
168 &</indexterm>&
169 .endmacro
170
171 .macro ecindex
172 &<indexterm role="concept" startref="$1" class="endofrange"/>&
173 .endmacro
174
175 .macro oindex
176 &<indexterm role="option">&
177 &<primary>&$1&</primary>&
178 .arg 2
179 &<secondary>&$2&</secondary>&
180 .endarg
181 &</indexterm>&
182 .endmacro
183
184 . --- The index entry points to the most-recent chapter head, section or subsection
185 . --- head, or varlist item.
186
187 .macro vindex
188 &<indexterm role="variable">&
189 &<primary>&$1&</primary>&
190 .arg 2
191 &<secondary>&$2&</secondary>&
192 .endarg
193 &</indexterm>&
194 .endmacro
195
196 .macro index
197 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
198 .endmacro
199
200
201 . use this for a concept-index entry for a header line
202 .macro chindex
203 .cindex "&'$1'& header line"
204 .cindex "header lines" $1
205 .endmacro
206 . ////////////////////////////////////////////////////////////////////////////
207
208
209 . ////////////////////////////////////////////////////////////////////////////
210 . The <bookinfo> element is removed from the XML before processing for ASCII
211 . output formats.
212 . ////////////////////////////////////////////////////////////////////////////
213
214 .literal xml
215 <bookinfo>
216 <title>Specification of the Exim Mail Transfer Agent</title>
217 <titleabbrev>The Exim MTA</titleabbrev>
218 <date>
219 .fulldate
220 </date>
221 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
222 <authorinitials>EM</authorinitials>
223 <revhistory><revision>
224 .versiondatexml
225   <authorinitials>EM</authorinitials>
226 </revision></revhistory>
227 <copyright><year>
228 .copyyear
229            </year><holder>The Exim Maintainers</holder></copyright>
230 </bookinfo>
231 .literal off
232
233
234 . /////////////////////////////////////////////////////////////////////////////
235 . These implement index entries of the form "x, see y" and "x, see also y".
236 . However, the DocBook DTD doesn't allow <indexterm> entries
237 . at the top level, so we have to put the .chapter directive first.
238 . /////////////////////////////////////////////////////////////////////////////
239
240 .chapter "Introduction" "CHID1"
241
242 .macro seeother
243 .literal xml
244 <indexterm role="$2">
245   <primary>$3</primary>
246 .arg 5
247   <secondary>$5</secondary>
248 .endarg
249   <$1><emphasis>$4</emphasis></$1>
250 </indexterm>
251 .literal off
252 .endmacro
253
254 . NB: for the 4-arg variant the ordering is awkward
255 .macro see
256 .seeother see "$1" "$2" "$3" "$4"
257 .endmacro
258 .macro seealso
259 .seeother seealso "$1" "$2" "$3" "$4"
260 .endmacro
261
262 .see     variable "<emphasis>$1</emphasis>, <emphasis>$2</emphasis>, etc." "numerical variables"
263 .see     concept address        rewriting                       rewriting
264 .see     concept "Bounce Address Tag Validation"        BATV
265 .see     concept "Client SMTP Authorization"            CSA
266 .see     concept "CR character" "carriage return"
267 .see     concept CRL            "certificate revocation list"
268 .seealso concept de-tainting    "tainted data"
269 .see     concept delivery       "bounce message"                "failure report"
270 .see     concept dialup         "intermittently connected hosts"
271 .see     concept exiscan        "content scanning"
272 .see     concept fallover       fallback
273 .see     concept filter         "Sieve filter"                  Sieve
274 .see     concept headers        "header lines"
275 .see     concept ident          "RFC 1413"
276 .see     concept "LF character" "linefeed"
277 .seealso concept maximum        limit
278 .see     concept monitor        "Exim monitor"
279 .see     concept "no_<emphasis>xxx</emphasis>"          "entry for xxx"
280 .see     concept NUL            "binary zero"
281 .see     concept "passwd file"  "/etc/passwd"
282 .see     concept "process id"   pid
283 .see     concept RBL            "DNS list"
284 .see     concept redirection    "address redirection"
285 .see     concept "return path"  "envelope sender"
286 .see     concept scanning       "content scanning"
287 .see     concept SSL            TLS
288 .see     concept string         expansion expansion
289 .see     concept "top bit"      "8-bit characters"
290 .see     concept variables      "expansion, variables"
291 .see     concept "zero, binary" "binary zero"
292
293
294 . /////////////////////////////////////////////////////////////////////////////
295 . This is the real start of the first chapter. See the comment above as to why
296 . we can't have the .chapter line here.
297 . chapter "Introduction"
298 . /////////////////////////////////////////////////////////////////////////////
299
300 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
301 Unix-like operating systems. It was designed on the assumption that it would be
302 run on hosts that are permanently connected to the Internet. However, it can be
303 used on intermittently connected hosts with suitable configuration adjustments.
304
305 Configuration files currently exist for the following operating systems: AIX,
306 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
307 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
308 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
309 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
310 Some of these operating systems are no longer current and cannot easily be
311 tested, so the configuration files may no longer work in practice.
312
313 There are also configuration files for compiling Exim in the Cygwin environment
314 that can be installed on systems running Windows. However, this document does
315 not contain any information about running Exim in the Cygwin environment.
316
317 The terms and conditions for the use and distribution of Exim are contained in
318 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
319 Public Licence, a copy of which may be found in the file &_LICENCE_&.
320
321 The use, supply, or promotion of Exim for the purpose of sending bulk,
322 unsolicited electronic mail is incompatible with the basic aims of Exim,
323 which revolve around the free provision of a service that enhances the quality
324 of personal communications. The author of Exim regards indiscriminate
325 mass-mailing as an antisocial, irresponsible abuse of the Internet.
326
327 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
328 experience of running and working on the Smail 3 code, I could never have
329 contemplated starting to write a new MTA. Many of the ideas and user interfaces
330 were originally taken from Smail 3, though the actual code of Exim is entirely
331 new, and has developed far beyond the initial concept.
332
333 Many people, both in Cambridge and around the world, have contributed to the
334 development and the testing of Exim, and to porting it to various operating
335 systems. I am grateful to them all. The distribution now contains a file called
336 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
337 contributors.
338
339
340 .section "Exim documentation" "SECID1"
341 . Keep this example change bar when updating the documentation!
342
343 .new
344 .cindex "documentation"
345 This edition of the Exim specification applies to version &version() of Exim.
346 Substantive changes from the &previousversion; edition are marked in some
347 renditions of this document; this paragraph is so marked if the rendition is
348 capable of showing a change indicator.
349 .wen
350
351 This document is very much a reference manual; it is not a tutorial. The reader
352 is expected to have some familiarity with the SMTP mail transfer protocol and
353 with general Unix system administration. Although there are some discussions
354 and examples in places, the information is mostly organized in a way that makes
355 it easy to look up, rather than in a natural order for sequential reading.
356 Furthermore, this manual aims to cover every aspect of Exim in detail, including
357 a number of rarely-used, special-purpose features that are unlikely to be of
358 very wide interest.
359
360 .cindex "books about Exim"
361 An &"easier"& discussion of Exim which provides more in-depth explanatory,
362 introductory, and tutorial material can be found in a book entitled &'The Exim
363 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
364 (&url(https://www.uit.co.uk/exim-book/)).
365
366 The book also contains a chapter that gives a general introduction to SMTP and
367 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
368 with the latest release of Exim. (Note that the earlier book about Exim,
369 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
370
371 .cindex "Debian" "information sources"
372 If you are using a Debian distribution of Exim, you will find information about
373 Debian-specific features in the file
374 &_/usr/share/doc/exim4-base/README.Debian_&.
375 The command &(man update-exim.conf)& is another source of Debian-specific
376 information.
377
378 .cindex "&_doc/NewStuff_&"
379 .cindex "&_doc/ChangeLog_&"
380 .cindex "change log"
381 As Exim develops, there may be features in newer versions that have not
382 yet made it into this document, which is updated only when the most significant
383 digit of the fractional part of the version number changes. Specifications of
384 new features that are not yet in this manual are placed in the file
385 &_doc/NewStuff_& in the Exim distribution.
386
387 Some features may be classified as &"experimental"&. These may change
388 incompatibly while they are developing, or even be withdrawn. For this reason,
389 they are not documented in this manual. Information about experimental features
390 can be found in the file &_doc/experimental.txt_&.
391
392 All changes to Exim (whether new features, bug fixes, or other kinds of
393 change) are noted briefly in the file called &_doc/ChangeLog_&.
394
395 .cindex "&_doc/spec.txt_&"
396 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
397 that it can easily be searched with a text editor. Other files in the &_doc_&
398 directory are:
399
400 .table2 100pt
401 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
402 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
403 .row &_exim.8_&              "a man page of Exim's command line options"
404 .row &_experimental.txt_&    "documentation of experimental features"
405 .row &_filter.txt_&          "specification of the filter language"
406 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
407 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
408 .row &_openssl.txt_&         "installing a current OpenSSL release"
409 .endtable
410
411 The main specification and the specification of the filtering language are also
412 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
413 &<<SECTavail>>& below tells you how to get hold of these.
414
415
416
417 .section "FTP site and websites" "SECID2"
418 .cindex "website"
419 .cindex "FTP site"
420 The primary site for Exim source distributions is the &%exim.org%& FTP site,
421 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
422 website, are hosted at the University of Cambridge.
423
424 .cindex "wiki"
425 .cindex "FAQ"
426 As well as Exim distribution tar files, the Exim website contains a number of
427 differently formatted versions of the documentation. A recent addition to the
428 online information is the Exim wiki (&url(https://wiki.exim.org)),
429 which contains what used to be a separate FAQ, as well as various other
430 examples, tips, and know-how that have been contributed by Exim users.
431 The wiki site should always redirect to the correct place, which is currently
432 provided by GitHub, and is open to editing by anyone with a GitHub account.
433
434 .cindex Bugzilla
435 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
436 this to report bugs, and also to add items to the wish list. Please search
437 first to check that you are not duplicating a previous entry.
438 Please do not ask for configuration help in the bug-tracker.
439
440
441 .section "Mailing lists" "SECID3"
442 .cindex "mailing lists" "for Exim users"
443 The following Exim mailing lists exist:
444
445 .table2 140pt
446 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
447 .row &'exim-users@exim.org'&      "General discussion list"
448 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
449 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
450 .endtable
451
452 You can subscribe to these lists, change your existing subscriptions, and view
453 or search the archives via the mailing lists link on the Exim home page.
454 .cindex "Debian" "mailing list for"
455 If you are using a Debian distribution of Exim, you may wish to subscribe to
456 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
457 via this web page:
458 .display
459 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
460 .endd
461 Please ask Debian-specific questions on that list and not on the general Exim
462 lists.
463
464 .section "Bug reports" "SECID5"
465 .cindex "bug reports"
466 .cindex "reporting bugs"
467 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
468 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
469 whether some behaviour is a bug or not, the best thing to do is to post a
470 message to the &'exim-dev'& mailing list and have it discussed.
471
472
473
474 .section "Where to find the Exim distribution" "SECTavail"
475 .cindex "FTP site"
476 .cindex "HTTPS download site"
477 .cindex "distribution" "FTP site"
478 .cindex "distribution" "https site"
479 The master distribution site for the Exim distribution is
480 .display
481 &url(https://downloads.exim.org/)
482 .endd
483 The service is available over HTTPS, HTTP and FTP.
484 We encourage people to migrate to HTTPS.
485
486 The content served at &url(https://downloads.exim.org/) is identical to the
487 content served at &url(https://ftp.exim.org/pub/exim) and
488 &url(ftp://ftp.exim.org/pub/exim).
489
490 If accessing via a hostname containing &'ftp'&, then the file references that
491 follow are relative to the &_exim_& directories at these sites.
492 If accessing via the hostname &'downloads'& then the subdirectories described
493 here are top-level directories.
494
495 There are now quite a number of independent mirror sites around
496 the world. Those that I know about are listed in the file called &_Mirrors_&.
497
498 Within the top exim directory there are subdirectories called &_exim3_& (for
499 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
500 distributions), and &_Testing_& for testing versions. In the &_exim4_&
501 subdirectory, the current release can always be found in files called
502 .display
503 &_exim-n.nn.tar.xz_&
504 &_exim-n.nn.tar.gz_&
505 &_exim-n.nn.tar.bz2_&
506 .endd
507 where &'n.nn'& is the highest such version number in the directory. The three
508 files contain identical data; the only difference is the type of compression.
509 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
510 most portable to old systems.
511
512 .cindex "distribution" "signing details"
513 .cindex "distribution" "public key"
514 .cindex "public key for signed distribution"
515 The distributions will be PGP signed by an individual key of the Release
516 Coordinator.  This key will have a uid containing an email address in the
517 &'exim.org'& domain and will have signatures from other people, including
518 other Exim maintainers.  We expect that the key will be in the "strong set" of
519 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
520 PGP keys, a version of which can be found in the release directory in the file
521 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
522 such as &'pool.sks-keyservers.net'&.
523
524 At the time of the last update, releases were being made by Jeremy Harris and signed
525 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
526 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
527 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
528
529 The signatures for the tar bundles are in:
530 .display
531 &_exim-n.nn.tar.xz.asc_&
532 &_exim-n.nn.tar.gz.asc_&
533 &_exim-n.nn.tar.bz2.asc_&
534 .endd
535 For each released version, the log of changes is made available in a
536 separate file in the directory &_ChangeLogs_& so that it is possible to
537 find out what has changed without having to download the entire distribution.
538
539 .cindex "documentation" "available formats"
540 The main distribution contains ASCII versions of this specification and other
541 documentation; other formats of the documents are available in separate files
542 inside the &_exim4_& directory of the FTP site:
543 .display
544 &_exim-html-n.nn.tar.gz_&
545 &_exim-pdf-n.nn.tar.gz_&
546 &_exim-postscript-n.nn.tar.gz_&
547 &_exim-texinfo-n.nn.tar.gz_&
548 .endd
549 These tar files contain only the &_doc_& directory, not the complete
550 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
551
552
553 .section "Limitations" "SECID6"
554 .ilist
555 .cindex "limitations of Exim"
556 .cindex "bang paths" "not handled by Exim"
557 Exim is designed for use as an Internet MTA, and therefore handles addresses in
558 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
559 simple two-component bang paths can be converted by a straightforward rewriting
560 configuration. This restriction does not prevent Exim from being interfaced to
561 UUCP as a transport mechanism, provided that domain addresses are used.
562 .next
563 .cindex "domainless addresses"
564 .cindex "address" "without domain"
565 Exim insists that every address it handles has a domain attached. For incoming
566 local messages, domainless addresses are automatically qualified with a
567 configured domain value. Configuration options specify from which remote
568 systems unqualified addresses are acceptable. These are then qualified on
569 arrival.
570 .next
571 .cindex "transport" "external"
572 .cindex "external transports"
573 The only external transport mechanisms that are currently implemented are SMTP
574 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
575 transport is available, and there are facilities for writing messages to files
576 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
577 to send messages to other transport mechanisms such as UUCP, provided they can
578 handle domain-style addresses. Batched SMTP input is also catered for.
579 .next
580 Exim is not designed for storing mail for dial-in hosts. When the volumes of
581 such mail are large, it is better to get the messages &"delivered"& into files
582 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
583 other means.
584 .next
585 Although Exim does have basic facilities for scanning incoming messages, these
586 are not comprehensive enough to do full virus or spam scanning. Such operations
587 are best carried out using additional specialized software packages. If you
588 compile Exim with the content-scanning extension, straightforward interfaces to
589 a number of common scanners are provided.
590 .endlist
591
592
593 .section "Runtime configuration" "SECID7"
594 Exim's runtime configuration is held in a single text file that is divided
595 into a number of sections. The entries in this file consist of keywords and
596 values, in the style of Smail 3 configuration files. A default configuration
597 file which is suitable for simple online installations is provided in the
598 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
599
600
601 .section "Calling interface" "SECID8"
602 .cindex "Sendmail compatibility" "command line interface"
603 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
604 can be a straight replacement for &_/usr/lib/sendmail_& or
605 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
606 about Sendmail in order to run Exim. For actions other than sending messages,
607 Sendmail-compatible options also exist, but those that produce output (for
608 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
609 format. There are also some additional options that are compatible with Smail
610 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
611 documents all Exim's command line options. This information is automatically
612 made into the man page that forms part of the Exim distribution.
613
614 Control of messages in the queue can be done via certain privileged command
615 line options. There is also an optional monitor program called &'eximon'&,
616 which displays current information in an X window, and which contains a menu
617 interface to Exim's command line administration options.
618
619
620
621 .section "Terminology" "SECID9"
622 .cindex "terminology definitions"
623 .cindex "body of message" "definition of"
624 The &'body'& of a message is the actual data that the sender wants to transmit.
625 It is the last part of a message and is separated from the &'header'& (see
626 below) by a blank line.
627
628 .cindex "bounce message" "definition of"
629 When a message cannot be delivered, it is normally returned to the sender in a
630 delivery failure message or a &"non-delivery report"& (NDR). The term
631 &'bounce'& is commonly used for this action, and the error reports are often
632 called &'bounce messages'&. This is a convenient shorthand for &"delivery
633 failure error report"&. Such messages have an empty sender address in the
634 message's &'envelope'& (see below) to ensure that they cannot themselves give
635 rise to further bounce messages.
636
637 The term &'default'& appears frequently in this manual. It is used to qualify a
638 value which is used in the absence of any setting in the configuration. It may
639 also qualify an action which is taken unless a configuration setting specifies
640 otherwise.
641
642 The term &'defer'& is used when the delivery of a message to a specific
643 destination cannot immediately take place for some reason (a remote host may be
644 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
645 until a later time.
646
647 The word &'domain'& is sometimes used to mean all but the first component of a
648 host's name. It is &'not'& used in that sense here, where it normally refers to
649 the part of an email address following the @ sign.
650
651 .cindex "envelope, definition of"
652 .cindex "sender" "definition of"
653 A message in transit has an associated &'envelope'&, as well as a header and a
654 body. The envelope contains a sender address (to which bounce messages should
655 be delivered), and any number of recipient addresses. References to the
656 sender or the recipients of a message usually mean the addresses in the
657 envelope. An MTA uses these addresses for delivery, and for returning bounce
658 messages, not the addresses that appear in the header lines.
659
660 .cindex "message" "header, definition of"
661 .cindex "header section" "definition of"
662 The &'header'& of a message is the first part of a message's text, consisting
663 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
664 &'Subject:'&, etc. Long header lines can be split over several text lines by
665 indenting the continuations. The header is separated from the body by a blank
666 line.
667
668 .cindex "local part" "definition of"
669 .cindex "domain" "definition of"
670 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
671 part of an email address that precedes the @ sign. The part that follows the
672 @ sign is called the &'domain'& or &'mail domain'&.
673
674 .cindex "local delivery" "definition of"
675 .cindex "remote delivery, definition of"
676 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
677 delivery to a file or a pipe on the local host from delivery by SMTP over
678 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
679 host it is running on are &'remote'&.
680
681 .cindex "return path" "definition of"
682 &'Return path'& is another name that is used for the sender address in a
683 message's envelope.
684
685 .cindex "queue" "definition of"
686 The term &'queue'& is used to refer to the set of messages awaiting delivery
687 because this term is in widespread use in the context of MTAs. However, in
688 Exim's case, the reality is more like a pool than a queue, because there is
689 normally no ordering of waiting messages.
690
691 .cindex "queue runner" "definition of"
692 The term &'queue runner'& is used to describe a process that scans the queue
693 and attempts to deliver those messages whose retry times have come. This term
694 is used by other MTAs and also relates to the command &%runq%&, but in Exim
695 the waiting messages are normally processed in an unpredictable order.
696
697 .cindex "spool directory" "definition of"
698 The term &'spool directory'& is used for a directory in which Exim keeps the
699 messages in its queue &-- that is, those that it is in the process of
700 delivering. This should not be confused with the directory in which local
701 mailboxes are stored, which is called a &"spool directory"& by some people. In
702 the Exim documentation, &"spool"& is always used in the first sense.
703
704
705
706
707
708
709 . ////////////////////////////////////////////////////////////////////////////
710 . ////////////////////////////////////////////////////////////////////////////
711
712 .chapter "Incorporated code" "CHID2"
713 .cindex "incorporated code"
714 .cindex "regular expressions" "library"
715 .cindex "PCRE2"
716 .cindex "OpenDMARC"
717 A number of pieces of external code are included in the Exim distribution.
718
719 .ilist
720 Regular expressions are supported in the main Exim program and in the
721 Exim monitor using the freely-distributable PCRE2 library, copyright
722 &copy; University of Cambridge. The source to PCRE2 is not longer shipped with
723 Exim, so you will need to use the version of PCRE2 shipped with your system,
724 or obtain and install the full version of the library from
725 &url(https://github.com/PhilipHazel/pcre2/releases).
726 .next
727 .cindex "cdb" "acknowledgment"
728 Support for the cdb (Constant DataBase) lookup method is provided by code
729 contributed by Nigel Metheringham of (at the time he contributed it) Planet
730 Online Ltd. The implementation is completely contained within the code of Exim.
731 It does not link against an external cdb library. The code contains the
732 following statements:
733
734 .blockquote
735 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
736
737 This program is free software; you can redistribute it and/or modify it under
738 the terms of the GNU General Public License as published by the Free Software
739 Foundation; either version 2 of the License, or (at your option) any later
740 version.
741 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
742 the spec and sample code for cdb can be obtained from
743 &url(https://cr.yp.to/cdb.html). This implementation borrows
744 some code from Dan Bernstein's implementation (which has no license
745 restrictions applied to it).
746 .endblockquote
747 .next
748 .cindex "SPA authentication"
749 .cindex "Samba project"
750 .cindex "Microsoft Secure Password Authentication"
751 Client support for Microsoft's &'Secure Password Authentication'& is provided
752 by code contributed by Marc Prud'hommeaux. Server support was contributed by
753 Tom Kistner. This includes code taken from the Samba project, which is released
754 under the Gnu GPL.
755 .next
756 .cindex "Cyrus"
757 .cindex "&'pwcheck'& daemon"
758 .cindex "&'pwauthd'& daemon"
759 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
760 by code taken from the Cyrus-SASL library and adapted by Alexander S.
761 Sabourenkov. The permission notice appears below, in accordance with the
762 conditions expressed therein.
763
764 .blockquote
765 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
766
767 Redistribution and use in source and binary forms, with or without
768 modification, are permitted provided that the following conditions
769 are met:
770
771 .olist
772 Redistributions of source code must retain the above copyright
773 notice, this list of conditions and the following disclaimer.
774 .next
775 Redistributions in binary form must reproduce the above copyright
776 notice, this list of conditions and the following disclaimer in
777 the documentation and/or other materials provided with the
778 distribution.
779 .next
780 The name &"Carnegie Mellon University"& must not be used to
781 endorse or promote products derived from this software without
782 prior written permission. For permission or any other legal
783 details, please contact
784 .display
785               Office of Technology Transfer
786               Carnegie Mellon University
787               5000 Forbes Avenue
788               Pittsburgh, PA  15213-3890
789               (412) 268-4387, fax: (412) 268-7395
790               tech-transfer@andrew.cmu.edu
791 .endd
792 .next
793 Redistributions of any form whatsoever must retain the following
794 acknowledgment:
795
796 &"This product includes software developed by Computing Services
797 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
798
799 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
800 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
801 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
802 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
803 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
804 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
805 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
806 .endlist
807 .endblockquote
808
809 .next
810 .cindex "Exim monitor" "acknowledgment"
811 .cindex "X-windows"
812 .cindex "Athena"
813 The Exim Monitor program, which is an X-Window application, includes
814 modified versions of the Athena StripChart and TextPop widgets.
815 This code is copyright by DEC and MIT, and their permission notice appears
816 below, in accordance with the conditions expressed therein.
817
818 .blockquote
819 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
820 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
821
822 All Rights Reserved
823
824 Permission to use, copy, modify, and distribute this software and its
825 documentation for any purpose and without fee is hereby granted,
826 provided that the above copyright notice appear in all copies and that
827 both that copyright notice and this permission notice appear in
828 supporting documentation, and that the names of Digital or MIT not be
829 used in advertising or publicity pertaining to distribution of the
830 software without specific, written prior permission.
831
832 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
833 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
834 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
835 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
836 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
837 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
838 SOFTWARE.
839 .endblockquote
840
841 .next
842 .cindex "opendmarc" "acknowledgment"
843 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
844 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
845 derived code are indicated in the respective source files. The full OpenDMARC
846 license is provided in the LICENSE.opendmarc file contained in the distributed
847 source code.
848
849 .next
850 Many people have contributed code fragments, some large, some small, that were
851 not covered by any specific license requirements. It is assumed that the
852 contributors are happy to see their code incorporated into Exim under the GPL.
853 .endlist
854
855
856
857
858
859 . ////////////////////////////////////////////////////////////////////////////
860 . ////////////////////////////////////////////////////////////////////////////
861
862 .chapter "How Exim receives and delivers mail" "CHID11" &&&
863          "Receiving and delivering mail"
864
865
866 .section "Overall philosophy" "SECID10"
867 .cindex "design philosophy"
868 Exim is designed to work efficiently on systems that are permanently connected
869 to the Internet and are handling a general mix of mail. In such circumstances,
870 most messages can be delivered immediately. Consequently, Exim does not
871 maintain independent queues of messages for specific domains or hosts, though
872 it does try to send several messages in a single SMTP connection after a host
873 has been down, and it also maintains per-host retry information.
874
875
876 .section "Policy control" "SECID11"
877 .cindex "policy control" "overview"
878 Policy controls are now an important feature of MTAs that are connected to the
879 Internet. Perhaps their most important job is to stop MTAs from being abused as
880 &"open relays"& by misguided individuals who send out vast amounts of
881 unsolicited junk and want to disguise its source. Exim provides flexible
882 facilities for specifying policy controls on incoming mail:
883
884 .ilist
885 .cindex "&ACL;" "introduction"
886 Exim 4 (unlike previous versions of Exim) implements policy controls on
887 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
888 series of statements that may either grant or deny access. ACLs can be used at
889 several places in the SMTP dialogue while receiving a message from a remote
890 host. However, the most common places are after each RCPT command, and at the
891 very end of the message. The sysadmin can specify conditions for accepting or
892 rejecting individual recipients or the entire message, respectively, at these
893 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
894 error code.
895 .next
896 An ACL is also available for locally generated, non-SMTP messages. In this
897 case, the only available actions are to accept or deny the entire message.
898 .next
899 When Exim is compiled with the content-scanning extension, facilities are
900 provided in the ACL mechanism for passing the message to external virus and/or
901 spam scanning software. The result of such a scan is passed back to the ACL,
902 which can then use it to decide what to do with the message.
903 .next
904 When a message has been received, either from a remote host or from the local
905 host, but before the final acknowledgment has been sent, a locally supplied C
906 function called &[local_scan()]& can be run to inspect the message and decide
907 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
908 is accepted, the list of recipients can be modified by the function.
909 .next
910 Using the &[local_scan()]& mechanism is another way of calling external scanner
911 software. The &%SA-Exim%& add-on package works this way. It does not require
912 Exim to be compiled with the content-scanning extension.
913 .next
914 After a message has been accepted, a further checking mechanism is available in
915 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
916 runs at the start of every delivery process.
917 .endlist
918
919
920
921 .section "User filters" "SECID12"
922 .cindex "filter" "introduction"
923 .cindex "Sieve filter"
924 In a conventional Exim configuration, users are able to run private filters by
925 setting up appropriate &_.forward_& files in their home directories. See
926 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
927 configuration needed to support this, and the separate document entitled
928 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
929 of filtering are available:
930
931 .ilist
932 Sieve filters are written in the standard filtering language that is defined
933 by RFC 3028.
934 .next
935 Exim filters are written in a syntax that is unique to Exim, but which is more
936 powerful than Sieve, which it pre-dates.
937 .endlist
938
939 User filters are run as part of the routing process, described below.
940
941
942
943 .section "Message identification" "SECTmessiden"
944 .cindex "message ids" "details of format"
945 .cindex "format" "of message id"
946 .cindex "id of message"
947 .cindex "base62"
948 .cindex "base36"
949 .cindex "Darwin"
950 .cindex "Cygwin"
951 Every message handled by Exim is given a &'message id'& which is sixteen
952 characters long. It is divided into three parts, separated by hyphens, for
953 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
954 normally encoding numbers in base 62. However, in the Darwin operating
955 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
956 (avoiding the use of lower case letters) is used instead, because the message
957 id is used to construct filenames, and the names of files in those systems are
958 not always case-sensitive.
959
960 .cindex "pid (process id)" "re-use of"
961 The detail of the contents of the message id have changed as Exim has evolved.
962 Earlier versions relied on the operating system not re-using a process id (pid)
963 within one second. On modern operating systems, this assumption can no longer
964 be made, so the algorithm had to be changed. To retain backward compatibility,
965 the format of the message id was retained, which is why the following rules are
966 somewhat eccentric:
967
968 .ilist
969 The first six characters of the message id are the time at which the message
970 started to be received, to a granularity of one second. That is, this field
971 contains the number of seconds since the start of the epoch (the normal Unix
972 way of representing the date and time of day).
973 .next
974 After the first hyphen, the next six characters are the id of the process that
975 received the message.
976 .next
977 There are two different possibilities for the final two characters:
978 .olist
979 .oindex "&%localhost_number%&"
980 If &%localhost_number%& is not set, this value is the fractional part of the
981 time of reception, normally in units of 1/2000 of a second, but for systems
982 that must use base 36 instead of base 62 (because of case-insensitive file
983 systems), the units are 1/1000 of a second.
984 .next
985 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
986 the fractional part of the time, which in this case is in units of 1/200
987 (1/100) of a second.
988 .endlist
989 .endlist
990
991 After a message has been received, Exim waits for the clock to tick at the
992 appropriate resolution before proceeding, so that if another message is
993 received by the same process, or by another process with the same (re-used)
994 pid, it is guaranteed that the time will be different. In most cases, the clock
995 will already have ticked while the message was being received.
996
997
998 .section "Receiving mail" "SECID13"
999 .cindex "receiving mail"
1000 .cindex "message" "reception"
1001 The only way Exim can receive mail from another host is using SMTP over
1002 TCP/IP, in which case the sender and recipient addresses are transferred using
1003 SMTP commands. However, from a locally running process (such as a user's MUA),
1004 there are several possibilities:
1005
1006 .ilist
1007 If the process runs Exim with the &%-bm%& option, the message is read
1008 non-interactively (usually via a pipe), with the recipients taken from the
1009 command line, or from the body of the message if &%-t%& is also used.
1010 .next
1011 If the process runs Exim with the &%-bS%& option, the message is also read
1012 non-interactively, but in this case the recipients are listed at the start of
1013 the message in a series of SMTP RCPT commands, terminated by a DATA
1014 command. This is called &"batch SMTP"& format,
1015 but it isn't really SMTP. The SMTP commands are just another way of passing
1016 envelope addresses in a non-interactive submission.
1017 .next
1018 If the process runs Exim with the &%-bs%& option, the message is read
1019 interactively, using the SMTP protocol. A two-way pipe is normally used for
1020 passing data between the local process and the Exim process.
1021 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1022 example, the ACLs for SMTP commands are used for this form of submission.
1023 .next
1024 A local process may also make a TCP/IP call to the host's loopback address
1025 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1026 does not treat the loopback address specially. It treats all such connections
1027 in the same way as connections from other hosts.
1028 .endlist
1029
1030
1031 .cindex "message sender, constructed by Exim"
1032 .cindex "sender" "constructed by Exim"
1033 In the three cases that do not involve TCP/IP, the sender address is
1034 constructed from the login name of the user that called Exim and a default
1035 qualification domain (which can be set by the &%qualify_domain%& configuration
1036 option). For local or batch SMTP, a sender address that is passed using the
1037 SMTP MAIL command is ignored. However, the system administrator may allow
1038 certain users (&"trusted users"&) to specify a different sender addresses
1039 unconditionally, or all users to specify certain forms of different sender
1040 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1041 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1042 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1043 users to change sender addresses.
1044
1045 Messages received by either of the non-interactive mechanisms are subject to
1046 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1047 (either over TCP/IP or interacting with a local process) can be checked by a
1048 number of ACLs that operate at different times during the SMTP session. Either
1049 individual recipients or the entire message can be rejected if local policy
1050 requirements are not met. The &[local_scan()]& function (see chapter
1051 &<<CHAPlocalscan>>&) is run for all incoming messages.
1052
1053 Exim can be configured not to start a delivery process when a message is
1054 received; this can be unconditional, or depend on the number of incoming SMTP
1055 connections or the system load. In these situations, new messages wait on the
1056 queue until a queue runner process picks them up. However, in standard
1057 configurations under normal conditions, delivery is started as soon as a
1058 message is received.
1059
1060
1061
1062
1063
1064 .section "Handling an incoming message" "SECID14"
1065 .cindex "spool directory" "files that hold a message"
1066 .cindex "file" "how a message is held"
1067 When Exim accepts a message, it writes two files in its spool directory. The
1068 first contains the envelope information, the current status of the message, and
1069 the header lines, and the second contains the body of the message. The names of
1070 the two spool files consist of the message id, followed by &`-H`& for the
1071 file containing the envelope and header, and &`-D`& for the data file.
1072
1073 .cindex "spool directory" "&_input_& sub-directory"
1074 By default, all these message files are held in a single directory called
1075 &_input_& inside the general Exim spool directory. Some operating systems do
1076 not perform very well if the number of files in a directory gets large; to
1077 improve performance in such cases, the &%split_spool_directory%& option can be
1078 used. This causes Exim to split up the input files into 62 sub-directories
1079 whose names are single letters or digits. When this is done, the queue is
1080 processed one sub-directory at a time instead of all at once, which can improve
1081 overall performance even when there are not enough files in each directory to
1082 affect file system performance.
1083
1084 The envelope information consists of the address of the message's sender and
1085 the addresses of the recipients. This information is entirely separate from
1086 any addresses contained in the header lines. The status of the message includes
1087 a list of recipients who have already received the message. The format of the
1088 first spool file is described in chapter &<<CHAPspool>>&.
1089
1090 .cindex "rewriting" "addresses"
1091 Address rewriting that is specified in the rewrite section of the configuration
1092 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1093 both in the header lines and the envelope, at the time the message is accepted.
1094 If during the course of delivery additional addresses are generated (for
1095 example, via aliasing), these new addresses are rewritten as soon as they are
1096 generated. At the time a message is actually delivered (transported) further
1097 rewriting can take place; because this is a transport option, it can be
1098 different for different forms of delivery. It is also possible to specify the
1099 addition or removal of certain header lines at the time the message is
1100 delivered (see chapters &<<CHAProutergeneric>>& and
1101 &<<CHAPtransportgeneric>>&).
1102
1103
1104
1105 .section "Life of a message" "SECID15"
1106 .cindex "message" "life of"
1107 .cindex "message" "frozen"
1108 A message remains in the spool directory until it is completely delivered to
1109 its recipients or to an error address, or until it is deleted by an
1110 administrator or by the user who originally created it. In cases when delivery
1111 cannot proceed &-- for example when a message can neither be delivered to its
1112 recipients nor returned to its sender, the message is marked &"frozen"& on the
1113 spool, and no more deliveries are attempted.
1114
1115 .cindex "frozen messages" "thawing"
1116 .cindex "message" "thawing frozen"
1117 An administrator can &"thaw"& such messages when the problem has been
1118 corrected, and can also freeze individual messages by hand if necessary. In
1119 addition, an administrator can force a delivery error, causing a bounce message
1120 to be sent.
1121
1122 .oindex "&%timeout_frozen_after%&"
1123 .oindex "&%ignore_bounce_errors_after%&"
1124 There are options called &%ignore_bounce_errors_after%& and
1125 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1126 The first applies only to frozen bounces, the second to all frozen messages.
1127
1128 .cindex "message" "log file for"
1129 .cindex "log" "file for each message"
1130 While Exim is working on a message, it writes information about each delivery
1131 attempt to its main log file. This includes successful, unsuccessful, and
1132 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1133 lines are also written to a separate &'message log'& file for each message.
1134 These logs are solely for the benefit of the administrator and are normally
1135 deleted along with the spool files when processing of a message is complete.
1136 The use of individual message logs can be disabled by setting
1137 &%no_message_logs%&; this might give an improvement in performance on very busy
1138 systems.
1139
1140 .cindex "journal file"
1141 .cindex "file" "journal"
1142 All the information Exim itself needs to set up a delivery is kept in the first
1143 spool file, along with the header lines. When a successful delivery occurs, the
1144 address is immediately written at the end of a journal file, whose name is the
1145 message id followed by &`-J`&. At the end of a delivery run, if there are some
1146 addresses left to be tried again later, the first spool file (the &`-H`& file)
1147 is updated to indicate which these are, and the journal file is then deleted.
1148 Updating the spool file is done by writing a new file and renaming it, to
1149 minimize the possibility of data loss.
1150
1151 Should the system or Exim crash after a successful delivery but before
1152 the spool file has been updated, the journal is left lying around. The next
1153 time Exim attempts to deliver the message, it reads the journal file and
1154 updates the spool file before proceeding. This minimizes the chances of double
1155 deliveries caused by crashes.
1156
1157
1158
1159 .section "Processing an address for delivery" "SECTprocaddress"
1160 .cindex "drivers" "definition of"
1161 .cindex "router" "definition of"
1162 .cindex "transport" "definition of"
1163 The main delivery processing elements of Exim are called &'routers'& and
1164 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1165 number of them is provided in the source distribution, and compile-time options
1166 specify which ones are included in the binary. Runtime options specify which
1167 ones are actually used for delivering messages.
1168
1169 .cindex "drivers" "instance definition"
1170 Each driver that is specified in the runtime configuration is an &'instance'&
1171 of that particular driver type. Multiple instances are allowed; for example,
1172 you can set up several different &(smtp)& transports, each with different
1173 option values that might specify different ports or different timeouts. Each
1174 instance has its own identifying name. In what follows we will normally use the
1175 instance name when discussing one particular instance (that is, one specific
1176 configuration of the driver), and the generic driver name when discussing
1177 the driver's features in general.
1178
1179 A &'router'& is a driver that operates on an address, either determining how
1180 its delivery should happen, by assigning it to a specific transport, or
1181 converting the address into one or more new addresses (for example, via an
1182 alias file). A router may also explicitly choose to fail an address, causing it
1183 to be bounced.
1184
1185 A &'transport'& is a driver that transmits a copy of the message from Exim's
1186 spool to some destination. There are two kinds of transport: for a &'local'&
1187 transport, the destination is a file or a pipe on the local host, whereas for a
1188 &'remote'& transport the destination is some other host. A message is passed
1189 to a specific transport as a result of successful routing. If a message has
1190 several recipients, it may be passed to a number of different transports.
1191
1192 .cindex "preconditions" "definition of"
1193 An address is processed by passing it to each configured router instance in
1194 turn, subject to certain preconditions, until a router accepts the address or
1195 specifies that it should be bounced. We will describe this process in more
1196 detail shortly. First, as a simple example, we consider how each recipient
1197 address in a message is processed in a small configuration of three routers.
1198
1199 To make this a more concrete example, it is described in terms of some actual
1200 routers, but remember, this is only an example. You can configure Exim's
1201 routers in many different ways, and there may be any number of routers in a
1202 configuration.
1203
1204 The first router that is specified in a configuration is often one that handles
1205 addresses in domains that are not recognized specifically by the local host.
1206 Typically these are addresses for arbitrary domains on the Internet. A precondition
1207 is set up which looks for the special domains known to the host (for example,
1208 its own domain name), and the router is run for addresses that do &'not'&
1209 match. Typically, this is a router that looks up domains in the DNS in order to
1210 find the hosts to which this address routes. If it succeeds, the address is
1211 assigned to a suitable SMTP transport; if it does not succeed, the router is
1212 configured to fail the address.
1213
1214 The second router is reached only when the domain is recognized as one that
1215 &"belongs"& to the local host. This router does redirection &-- also known as
1216 aliasing and forwarding. When it generates one or more new addresses from the
1217 original, each of them is routed independently from the start. Otherwise, the
1218 router may cause an address to fail, or it may simply decline to handle the
1219 address, in which case the address is passed to the next router.
1220
1221 The final router in many configurations is one that checks to see if the
1222 address belongs to a local mailbox. The precondition may involve a check to
1223 see if the local part is the name of a login account, or it may look up the
1224 local part in a file or a database. If its preconditions are not met, or if
1225 the router declines, we have reached the end of the routers. When this happens,
1226 the address is bounced.
1227
1228
1229
1230 .section "Processing an address for verification" "SECID16"
1231 .cindex "router" "for verification"
1232 .cindex "verifying address" "overview"
1233 As well as being used to decide how to deliver to an address, Exim's routers
1234 are also used for &'address verification'&. Verification can be requested as
1235 one of the checks to be performed in an ACL for incoming messages, on both
1236 sender and recipient addresses, and it can be tested using the &%-bv%& and
1237 &%-bvs%& command line options.
1238
1239 When an address is being verified, the routers are run in &"verify mode"&. This
1240 does not affect the way the routers work, but it is a state that can be
1241 detected. By this means, a router can be skipped or made to behave differently
1242 when verifying. A common example is a configuration in which the first router
1243 sends all messages to a message-scanning program unless they have been
1244 previously scanned. Thus, the first router accepts all addresses without any
1245 checking, making it useless for verifying. Normally, the &%no_verify%& option
1246 would be set for such a router, causing it to be skipped in verify mode.
1247
1248
1249
1250
1251 .section "Running an individual router" "SECTrunindrou"
1252 .cindex "router" "running details"
1253 .cindex "preconditions" "checking"
1254 .cindex "router" "result of running"
1255 As explained in the example above, a number of preconditions are checked before
1256 running a router. If any are not met, the router is skipped, and the address is
1257 passed to the next router. When all the preconditions on a router &'are'& met,
1258 the router is run. What happens next depends on the outcome, which is one of
1259 the following:
1260
1261 .ilist
1262 &'accept'&: The router accepts the address, and either assigns it to a
1263 transport or generates one or more &"child"& addresses. Processing the
1264 original address ceases
1265 .oindex "&%unseen%&"
1266 unless the &%unseen%& option is set on the router. This option
1267 can be used to set up multiple deliveries with different routing (for example,
1268 for keeping archive copies of messages). When &%unseen%& is set, the address is
1269 passed to the next router. Normally, however, an &'accept'& return marks the
1270 end of routing.
1271
1272 Any child addresses generated by the router are processed independently,
1273 starting with the first router by default. It is possible to change this by
1274 setting the &%redirect_router%& option to specify which router to start at for
1275 child addresses. Unlike &%pass_router%& (see below) the router specified by
1276 &%redirect_router%& may be anywhere in the router configuration.
1277 .next
1278 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1279 requests that the address be passed to another router. By default, the address
1280 is passed to the next router, but this can be changed by setting the
1281 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1282 must be below the current router (to avoid loops).
1283 .next
1284 &'decline'&: The router declines to accept the address because it does not
1285 recognize it at all. By default, the address is passed to the next router, but
1286 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1287 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1288 &'decline'& into &'fail'&.
1289 .next
1290 &'fail'&: The router determines that the address should fail, and queues it for
1291 the generation of a bounce message. There is no further processing of the
1292 original address unless &%unseen%& is set on the router.
1293 .next
1294 &'defer'&: The router cannot handle the address at the present time. (A
1295 database may be offline, or a DNS lookup may have timed out.) No further
1296 processing of the address happens in this delivery attempt. It is tried again
1297 next time the message is considered for delivery.
1298 .next
1299 &'error'&: There is some error in the router (for example, a syntax error in
1300 its configuration). The action is as for defer.
1301 .endlist
1302
1303 If an address reaches the end of the routers without having been accepted by
1304 any of them, it is bounced as unrouteable. The default error message in this
1305 situation is &"unrouteable address"&, but you can set your own message by
1306 making use of the &%cannot_route_message%& option. This can be set for any
1307 router; the value from the last router that &"saw"& the address is used.
1308
1309 Sometimes while routing you want to fail a delivery when some conditions are
1310 met but others are not, instead of passing the address on for further routing.
1311 You can do this by having a second router that explicitly fails the delivery
1312 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1313 facility for this purpose.
1314
1315
1316 .section "Duplicate addresses" "SECID17"
1317 .cindex "case of local parts"
1318 .cindex "address duplicate, discarding"
1319 .cindex "duplicate addresses"
1320 Once routing is complete, Exim scans the addresses that are assigned to local
1321 and remote transports and discards any duplicates that it finds. During this
1322 check, local parts are treated case-sensitively. This happens only when
1323 actually delivering a message; when testing routers with &%-bt%&, all the
1324 routed addresses are shown.
1325
1326
1327
1328 .section "Router preconditions" "SECTrouprecon"
1329 .cindex "router" "preconditions, order of processing"
1330 .cindex "preconditions" "order of processing"
1331 The preconditions that are tested for each router are listed below, in the
1332 order in which they are tested. The individual configuration options are
1333 described in more detail in chapter &<<CHAProutergeneric>>&.
1334
1335 .olist
1336 .cindex affix "router precondition"
1337 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1338 the local parts handled by the router may or must have certain prefixes and/or
1339 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1340 skipped. These conditions are tested first. When an affix is present, it is
1341 removed from the local part before further processing, including the evaluation
1342 of any other conditions.
1343 .next
1344 Routers can be designated for use only when not verifying an address, that is,
1345 only when routing it for delivery (or testing its delivery routing). If the
1346 &%verify%& option is set false, the router is skipped when Exim is verifying an
1347 address.
1348 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1349 &%verify_recipient%&, which independently control the use of the router for
1350 sender and recipient verification. You can set these options directly if
1351 you want a router to be used for only one type of verification.
1352 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1353 .next
1354 If the &%address_test%& option is set false, the router is skipped when Exim is
1355 run with the &%-bt%& option to test an address routing. This can be helpful
1356 when the first router sends all new messages to a scanner of some sort; it
1357 makes it possible to use &%-bt%& to test subsequent delivery routing without
1358 having to simulate the effect of the scanner.
1359 .next
1360 Routers can be designated for use only when verifying an address, as
1361 opposed to routing it for delivery. The &%verify_only%& option controls this.
1362 Again, cutthrough delivery counts as a verification.
1363 .next
1364 Individual routers can be explicitly skipped when running the routers to
1365 check an address given in the SMTP EXPN command (see the &%expn%& option).
1366
1367 .next
1368 If the &%domains%& option is set, the domain of the address must be in the set
1369 of domains that it defines.
1370 .cindex "tainted data" "de-tainting"
1371 .cindex "de-tainting" "using router domains option"
1372 A match verifies the variable &$domain$& (which carries tainted data)
1373 and assigns an untainted value to the &$domain_data$& variable.
1374 Such an untainted value is often needed in the transport.
1375 For specifics of the matching operation and the resulting untainted value,
1376 refer to section &<<SECTdomainlist>>&.
1377
1378 When an untainted value is wanted, use this option
1379 rather than the generic &%condition%& option.
1380
1381 .next
1382 .vindex "&$local_part_prefix$&"
1383 .vindex "&$local_part_prefix_v$&"
1384 .vindex "&$local_part$&"
1385 .vindex "&$local_part_suffix$&"
1386 .vindex "&$local_part_suffix_v$&"
1387 .cindex affix "router precondition"
1388 If the &%local_parts%& option is set, the local part of the address must be in
1389 the set of local parts that it defines.
1390 A match verifies the variable &$local_part$& (which carries tainted data)
1391 and assigns an untainted value to the &$local_part_data$& variable.
1392 Such an untainted value is often needed in the transport.
1393 For specifics of the matching operation and the resulting untainted value,
1394 refer to section &<<SECTlocparlis>>&.
1395
1396 When an untainted value is wanted, use this option
1397 rather than the generic &%condition%& option.
1398
1399 If &%local_part_prefix%& or
1400 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1401 part before this check. If you want to do precondition tests on local parts
1402 that include affixes, you can do so by using a &%condition%& option (see below)
1403 that uses the variables &$local_part$&, &$local_part_prefix$&,
1404 &$local_part_prefix_v$&, &$local_part_suffix$&
1405 and &$local_part_suffix_v$& as necessary.
1406
1407 .next
1408 .vindex "&$local_user_uid$&"
1409 .vindex "&$local_user_gid$&"
1410 .vindex "&$home$&"
1411 If the &%check_local_user%& option is set, the local part must be the name of
1412 an account on the local host. If this check succeeds, the uid and gid of the
1413 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1414 user's home directory is placed in &$home$&; these values can be used in the
1415 remaining preconditions.
1416
1417 .next
1418 If the &%router_home_directory%& option is set, it is expanded at this point,
1419 because it overrides the value of &$home$&. If this expansion were left till
1420 later, the value of &$home$& as set by &%check_local_user%& would be used in
1421 subsequent tests. Having two different values of &$home$& in the same router
1422 could lead to confusion.
1423
1424 .next
1425 If the &%senders%& option is set, the envelope sender address must be in the
1426 set of addresses that it defines.
1427
1428 .next
1429 If the &%require_files%& option is set, the existence or non-existence of
1430 specified files is tested.
1431
1432 .next
1433 .cindex "customizing" "precondition"
1434 If the &%condition%& option is set, it is evaluated and tested. This option
1435 uses an expanded string to allow you to set up your own custom preconditions.
1436 Expanded strings are described in chapter &<<CHAPexpand>>&.
1437
1438 Note that while using
1439 this option for address matching technically works,
1440 it does not set any de-tainted values.
1441 Such values are often needed, either for router-specific options or
1442 for transport options.
1443 Using the &%domains%& and &%local_parts%& options is usually the most
1444 convenient way to obtain them.
1445 .endlist
1446
1447
1448 Note that &%require_files%& comes near the end of the list, so you cannot use
1449 it to check for the existence of a file in which to lookup up a domain, local
1450 part, or sender. However, as these options are all expanded, you can use the
1451 &%exists%& expansion condition to make such tests within each condition. The
1452 &%require_files%& option is intended for checking files that the router may be
1453 going to use internally, or which are needed by a specific transport (for
1454 example, &_.procmailrc_&).
1455
1456
1457
1458 .section "Delivery in detail" "SECID18"
1459 .cindex "delivery" "in detail"
1460 When a message is to be delivered, the sequence of events is as follows:
1461
1462 .olist
1463 If a system-wide filter file is specified, the message is passed to it. The
1464 filter may add recipients to the message, replace the recipients, discard the
1465 message, cause a new message to be generated, or cause the message delivery to
1466 fail. The format of the system filter file is the same as for Exim user filter
1467 files, described in the separate document entitled &'Exim's interfaces to mail
1468 filtering'&.
1469 .cindex "Sieve filter" "not available for system filter"
1470 (&*Note*&: Sieve cannot be used for system filter files.)
1471
1472 Some additional features are available in system filters &-- see chapter
1473 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1474 filter only once per delivery attempt, however many recipients it has. However,
1475 if there are several delivery attempts because one or more addresses could not
1476 be immediately delivered, the system filter is run each time. The filter
1477 condition &%first_delivery%& can be used to detect the first run of the system
1478 filter.
1479 .next
1480 Each recipient address is offered to each configured router, in turn, subject to
1481 its preconditions, until one is able to handle it. If no router can handle the
1482 address, that is, if they all decline, the address is failed. Because routers
1483 can be targeted at particular domains, several locally handled domains can be
1484 processed entirely independently of each other.
1485 .next
1486 .cindex "routing" "loops in"
1487 .cindex "loop" "while routing"
1488 A router that accepts an address may assign it to a local or a remote
1489 transport. However, the transport is not run at this time. Instead, the address
1490 is placed on a list for the particular transport, which will be run later.
1491 Alternatively, the router may generate one or more new addresses (typically
1492 from alias, forward, or filter files). New addresses are fed back into this
1493 process from the top, but in order to avoid loops, a router ignores any address
1494 which has an identically-named ancestor that was processed by itself.
1495 .next
1496 When all the routing has been done, addresses that have been successfully
1497 handled are passed to their assigned transports. When local transports are
1498 doing real local deliveries, they handle only one address at a time, but if a
1499 local transport is being used as a pseudo-remote transport (for example, to
1500 collect batched SMTP messages for transmission by some other means) multiple
1501 addresses can be handled. Remote transports can always handle more than one
1502 address at a time, but can be configured not to do so, or to restrict multiple
1503 addresses to the same domain.
1504 .next
1505 Each local delivery to a file or a pipe runs in a separate process under a
1506 non-privileged uid, and these deliveries are run one at a time. Remote
1507 deliveries also run in separate processes, normally under a uid that is private
1508 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1509 run in parallel. The maximum number of simultaneous remote deliveries for any
1510 one message is set by the &%remote_max_parallel%& option.
1511 The order in which deliveries are done is not defined, except that all local
1512 deliveries happen before any remote deliveries.
1513 .next
1514 .cindex "queue runner"
1515 When it encounters a local delivery during a queue run, Exim checks its retry
1516 database to see if there has been a previous temporary delivery failure for the
1517 address before running the local transport. If there was a previous failure,
1518 Exim does not attempt a new delivery until the retry time for the address is
1519 reached. However, this happens only for delivery attempts that are part of a
1520 queue run. Local deliveries are always attempted when delivery immediately
1521 follows message reception, even if retry times are set for them. This makes for
1522 better behaviour if one particular message is causing problems (for example,
1523 causing quota overflow, or provoking an error in a filter file).
1524 .next
1525 .cindex "delivery" "retry in remote transports"
1526 Remote transports do their own retry handling, since an address may be
1527 deliverable to one of a number of hosts, each of which may have a different
1528 retry time. If there have been previous temporary failures and no host has
1529 reached its retry time, no delivery is attempted, whether in a queue run or
1530 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1531 .next
1532 If there were any permanent errors, a bounce message is returned to an
1533 appropriate address (the sender in the common case), with details of the error
1534 for each failing address. Exim can be configured to send copies of bounce
1535 messages to other addresses.
1536 .next
1537 .cindex "delivery" "deferral"
1538 If one or more addresses suffered a temporary failure, the message is left on
1539 the queue, to be tried again later. Delivery of these addresses is said to be
1540 &'deferred'&.
1541 .next
1542 When all the recipient addresses have either been delivered or bounced,
1543 handling of the message is complete. The spool files and message log are
1544 deleted, though the message log can optionally be preserved if required.
1545 .endlist
1546
1547
1548
1549
1550 .section "Retry mechanism" "SECID19"
1551 .cindex "delivery" "retry mechanism"
1552 .cindex "retry" "description of mechanism"
1553 .cindex "queue runner"
1554 Exim's mechanism for retrying messages that fail to get delivered at the first
1555 attempt is the queue runner process. You must either run an Exim daemon that
1556 uses the &%-q%& option with a time interval to start queue runners at regular
1557 intervals or use some other means (such as &'cron'&) to start them. If you do
1558 not arrange for queue runners to be run, messages that fail temporarily at the
1559 first attempt will remain in your queue forever. A queue runner process works
1560 its way through the queue, one message at a time, trying each delivery that has
1561 passed its retry time.
1562 You can run several queue runners at once.
1563
1564 Exim uses a set of configured rules to determine when next to retry the failing
1565 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1566 should give up trying to deliver to the address, at which point it generates a
1567 bounce message. If no retry rules are set for a particular host, address, and
1568 error combination, no retries are attempted, and temporary errors are treated
1569 as permanent.
1570
1571
1572
1573 .subsection "Temporary delivery failure" SECID20
1574 .cindex "delivery" "temporary failure"
1575 There are many reasons why a message may not be immediately deliverable to a
1576 particular address. Failure to connect to a remote machine (because it, or the
1577 connection to it, is down) is one of the most common. Temporary failures may be
1578 detected during routing as well as during the transport stage of delivery.
1579 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1580 is on a file system where the user is over quota. Exim can be configured to
1581 impose its own quotas on local mailboxes; where system quotas are set they will
1582 also apply.
1583
1584 If a host is unreachable for a period of time, a number of messages may be
1585 waiting for it by the time it recovers, and sending them in a single SMTP
1586 connection is clearly beneficial. Whenever a delivery to a remote host is
1587 deferred,
1588 .cindex "hints database" "deferred deliveries"
1589 Exim makes a note in its hints database, and whenever a successful
1590 SMTP delivery has happened, it looks to see if any other messages are waiting
1591 for the same host. If any are found, they are sent over the same SMTP
1592 connection, subject to a configuration limit as to the maximum number in any
1593 one connection.
1594
1595
1596
1597 .subsection "Permanent delivery failure" SECID21
1598 .cindex "delivery" "permanent failure"
1599 .cindex "bounce message" "when generated"
1600 When a message cannot be delivered to some or all of its intended recipients, a
1601 bounce message is generated. Temporary delivery failures turn into permanent
1602 errors when their timeout expires. All the addresses that fail in a given
1603 delivery attempt are listed in a single message. If the original message has
1604 many recipients, it is possible for some addresses to fail in one delivery
1605 attempt and others to fail subsequently, giving rise to more than one bounce
1606 message. The wording of bounce messages can be customized by the administrator.
1607 See chapter &<<CHAPemsgcust>>& for details.
1608
1609 .cindex "&'X-Failed-Recipients:'& header line"
1610 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1611 failed addresses, for the benefit of programs that try to analyse such messages
1612 automatically.
1613
1614 .cindex "bounce message" "recipient of"
1615 A bounce message is normally sent to the sender of the original message, as
1616 obtained from the message's envelope. For incoming SMTP messages, this is the
1617 address given in the MAIL command. However, when an address is expanded via a
1618 forward or alias file, an alternative address can be specified for delivery
1619 failures of the generated addresses. For a mailing list expansion (see section
1620 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1621 of the list.
1622
1623
1624
1625 .subsection "Failures to deliver bounce messages" SECID22
1626 .cindex "bounce message" "failure to deliver"
1627 If a bounce message (either locally generated or received from a remote host)
1628 itself suffers a permanent delivery failure, the message is left in the queue,
1629 but it is frozen, awaiting the attention of an administrator. There are options
1630 that can be used to make Exim discard such failed messages, or to keep them
1631 for only a short time (see &%timeout_frozen_after%& and
1632 &%ignore_bounce_errors_after%&).
1633
1634
1635
1636
1637
1638 . ////////////////////////////////////////////////////////////////////////////
1639 . ////////////////////////////////////////////////////////////////////////////
1640
1641 .chapter "Building and installing Exim" "CHID3"
1642 .scindex IIDbuex "building Exim"
1643
1644 .section "Unpacking" "SECID23"
1645 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1646 creates a directory with the name of the current release (for example,
1647 &_exim-&version()_&) into which the following files are placed:
1648
1649 .table2 140pt
1650 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1651 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1652   documented"
1653 .irow &_LICENCE_&         "the GNU General Public Licence"
1654 .irow &_Makefile_&        "top-level make file"
1655 .irow &_NOTICE_&          "conditions for the use of Exim"
1656 .irow &_README_&          "list of files, directories and simple build &&&
1657   instructions"
1658 .endtable
1659
1660 Other files whose names begin with &_README_& may also be present. The
1661 following subdirectories are created:
1662
1663 .table2 140pt
1664 .irow &_Local_&           "an empty directory for local configuration files"
1665 .irow &_OS_&              "OS-specific files"
1666 .irow &_doc_&             "documentation files"
1667 .irow &_exim_monitor_&    "source files for the Exim monitor"
1668 .irow &_scripts_&         "scripts used in the build process"
1669 .irow &_src_&             "remaining source files"
1670 .irow &_util_&            "independent utilities"
1671 .endtable
1672
1673 The main utility programs are contained in the &_src_& directory and are built
1674 with the Exim binary. The &_util_& directory contains a few optional scripts
1675 that may be useful to some sites.
1676
1677
1678 .section "Multiple machine architectures and operating systems" "SECID24"
1679 .cindex "building Exim" "multiple OS/architectures"
1680 The building process for Exim is arranged to make it easy to build binaries for
1681 a number of different architectures and operating systems from the same set of
1682 source files. Compilation does not take place in the &_src_& directory.
1683 Instead, a &'build directory'& is created for each architecture and operating
1684 system.
1685 .cindex "symbolic link" "to build directory"
1686 Symbolic links to the sources are installed in this directory, which is where
1687 the actual building takes place. In most cases, Exim can discover the machine
1688 architecture and operating system for itself, but the defaults can be
1689 overridden if necessary.
1690 .cindex compiler requirements
1691 .cindex compiler version
1692 A C99-capable compiler will be required for the build.
1693
1694
1695 .section "PCRE2 library" "SECTpcre"
1696 .cindex "PCRE2 library"
1697 Exim no longer has an embedded regular-expression library as the vast majority of
1698 modern systems include PCRE2 as a system library, although you may need to
1699 install the PCRE2 package or the PCRE2 development package for your operating
1700 system. If your system has a normal PCRE2 installation the Exim build
1701 process will need no further configuration. If the library or the
1702 headers are in an unusual location you will need to either set the PCRE2_LIBS
1703 and INCLUDE directives appropriately,
1704 or set PCRE2_CONFIG=yes to use the installed &(pcre-config)& command.
1705 If your operating system has no
1706 PCRE2 support then you will need to obtain and build the current PCRE2
1707 from &url(https://github.com/PhilipHazel/pcre2/releases).
1708 More information on PCRE2 is available at &url(https://www.pcre.org/).
1709
1710 .section "DBM libraries" "SECTdb"
1711 .cindex "DBM libraries" "discussion of"
1712 .cindex "hints database" "DBM files used for"
1713 Even if you do not use any DBM files in your configuration, Exim still needs a
1714 DBM library in order to operate, because it uses indexed files for its hints
1715 databases. Unfortunately, there are a number of DBM libraries in existence, and
1716 different operating systems often have different ones installed.
1717
1718 .cindex "Solaris" "DBM library for"
1719 .cindex "IRIX, DBM library for"
1720 .cindex "BSD, DBM library for"
1721 .cindex "Linux, DBM library for"
1722 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1723 Linux distribution, the DBM configuration should happen automatically, and you
1724 may be able to ignore this section. Otherwise, you may have to learn more than
1725 you would like about DBM libraries from what follows.
1726
1727 .cindex "&'ndbm'& DBM library"
1728 Licensed versions of Unix normally contain a library of DBM functions operating
1729 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1730 versions of Unix seem to vary in what they contain as standard. In particular,
1731 some early versions of Linux have no default DBM library, and different
1732 distributors have chosen to bundle different libraries with their packaged
1733 versions. However, the more recent releases seem to have standardized on the
1734 Berkeley DB library.
1735
1736 Different DBM libraries have different conventions for naming the files they
1737 use. When a program opens a file called &_dbmfile_&, there are several
1738 possibilities:
1739
1740 .olist
1741 A traditional &'ndbm'& implementation, such as that supplied as part of
1742 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1743 .next
1744 .cindex "&'gdbm'& DBM library"
1745 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1746 compatibility interface it makes two different hard links to it with names
1747 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1748 filename is used unmodified.
1749 .next
1750 .cindex "Berkeley DB library"
1751 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1752 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1753 programmer exactly the same as the traditional &'ndbm'& implementation.
1754 .next
1755 If the Berkeley package is used in its native mode, it operates on a single
1756 file called &_dbmfile_&; the programmer's interface is somewhat different to
1757 the traditional &'ndbm'& interface.
1758 .next
1759 To complicate things further, there are several very different versions of the
1760 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1761 2.&'x'& and 3.&'x'& were current for a while,
1762 but the latest versions when Exim last revamped support were numbered 5.&'x'&.
1763 Maintenance of some of the earlier releases has ceased,
1764 and Exim no longer supports versions before 3.&'x'&.
1765 All versions of Berkeley DB could be obtained from
1766 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1767 page with far newer versions listed.
1768 It is probably wise to plan to move your storage configurations away from
1769 Berkeley DB format, as today there are smaller and simpler alternatives more
1770 suited to Exim's usage model.
1771 .next
1772 .cindex "&'tdb'& DBM library"
1773 Yet another DBM library, called &'tdb'&, is available from
1774 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1775 operates on a single file.
1776 .endlist
1777
1778 .cindex "USE_DB"
1779 .cindex "DBM libraries" "configuration for building"
1780 Exim and its utilities can be compiled to use any of these interfaces. In order
1781 to use any version of the Berkeley DB package in native mode, you must set
1782 USE_DB in an appropriate configuration file (typically
1783 &_Local/Makefile_&). For example:
1784 .code
1785 USE_DB=yes
1786 .endd
1787 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1788 error is diagnosed if you set more than one of these.
1789 You can set USE_NDBM if needed to override an operating system default.
1790
1791 At the lowest level, the build-time configuration sets none of these options,
1792 thereby assuming an interface of type (1). However, some operating system
1793 configuration files (for example, those for the BSD operating systems and
1794 Linux) assume type (4) by setting USE_DB as their default, and the
1795 configuration files for Cygwin set USE_GDBM. Anything you set in
1796 &_Local/Makefile_&, however, overrides these system defaults.
1797
1798 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1799 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1800 in one of these lines:
1801 .code
1802 DBMLIB = -ldb
1803 DBMLIB = -ltdb
1804 DBMLIB = -lgdbm -lgdbm_compat
1805 .endd
1806 The last of those was for a Linux having GDBM provide emulated NDBM facilities.
1807 Settings like that will work if the DBM library is installed in the standard
1808 place. Sometimes it is not, and the library's header file may also not be in
1809 the default path. You may need to set INCLUDE to specify where the header
1810 file is, and to specify the path to the library more fully in DBMLIB, as in
1811 this example:
1812 .code
1813 INCLUDE=-I/usr/local/include/db-4.1
1814 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1815 .endd
1816 There is further detailed discussion about the various DBM libraries in the
1817 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1818
1819
1820
1821 .section "Pre-building configuration" "SECID25"
1822 .cindex "building Exim" "pre-building configuration"
1823 .cindex "configuration for building Exim"
1824 .cindex "&_Local/Makefile_&"
1825 .cindex "&_src/EDITME_&"
1826 Before building Exim, a local configuration file that specifies options
1827 independent of any operating system has to be created with the name
1828 &_Local/Makefile_&. A template for this file is supplied as the file
1829 &_src/EDITME_&, and it contains full descriptions of all the option settings
1830 therein. These descriptions are therefore not repeated here. If you are
1831 building Exim for the first time, the simplest thing to do is to copy
1832 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1833
1834 There are three settings that you must supply, because Exim will not build
1835 without them. They are the location of the runtime configuration file
1836 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1837 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1838 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1839 a colon-separated list of filenames; Exim uses the first of them that exists.
1840
1841 There are a few other parameters that can be specified either at build time or
1842 at runtime, to enable the same binary to be used on a number of different
1843 machines. However, if the locations of Exim's spool directory and log file
1844 directory (if not within the spool directory) are fixed, it is recommended that
1845 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1846 detected early in Exim's execution (such as a malformed configuration file) can
1847 be logged.
1848
1849 .cindex "content scanning" "specifying at build time"
1850 Exim's interfaces for calling virus and spam scanning software directly from
1851 access control lists are not compiled by default. If you want to include these
1852 facilities, you need to set
1853 .code
1854 WITH_CONTENT_SCAN=yes
1855 .endd
1856 in your &_Local/Makefile_&. For details of the facilities themselves, see
1857 chapter &<<CHAPexiscan>>&.
1858
1859
1860 .cindex "&_Local/eximon.conf_&"
1861 .cindex "&_exim_monitor/EDITME_&"
1862 If you are going to build the Exim monitor, a similar configuration process is
1863 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1864 your installation and saved under the name &_Local/eximon.conf_&. If you are
1865 happy with the default settings described in &_exim_monitor/EDITME_&,
1866 &_Local/eximon.conf_& can be empty, but it must exist.
1867
1868 This is all the configuration that is needed in straightforward cases for known
1869 operating systems. However, the building process is set up so that it is easy
1870 to override options that are set by default or by operating-system-specific
1871 configuration files, for example, to change the C compiler, which
1872 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1873 do this.
1874
1875
1876
1877 .section "Support for iconv()" "SECID26"
1878 .cindex "&[iconv()]& support"
1879 .cindex "RFC 2047"
1880 The contents of header lines in messages may be encoded according to the rules
1881 described RFC 2047. This makes it possible to transmit characters that are not
1882 in the ASCII character set, and to label them as being in a particular
1883 character set. When Exim is inspecting header lines by means of the &%$h_%&
1884 mechanism, it decodes them, and translates them into a specified character set
1885 (default is set at build time). The translation is possible only if the operating system
1886 supports the &[iconv()]& function.
1887
1888 However, some of the operating systems that supply &[iconv()]& do not support
1889 very many conversions. The GNU &%libiconv%& library (available from
1890 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1891 systems to remedy this deficiency, as well as on systems that do not supply
1892 &[iconv()]& at all. After installing &%libiconv%&, you should add
1893 .code
1894 HAVE_ICONV=yes
1895 .endd
1896 to your &_Local/Makefile_& and rebuild Exim.
1897
1898
1899
1900 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1901 .cindex "TLS" "including support for TLS"
1902 .cindex "encryption" "including support for"
1903 .cindex "OpenSSL" "building Exim with"
1904 .cindex "GnuTLS" "building Exim with"
1905 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1906 command as per RFC 2487. It can also support clients that expect to
1907 start a TLS session immediately on connection to a non-standard port (see the
1908 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1909 line option).
1910
1911 If you want to build Exim with TLS support, you must first install either the
1912 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1913 implementing SSL.
1914
1915 If you do not want TLS support you should set
1916 .code
1917 DISABLE_TLS=yes
1918 .endd
1919 in &_Local/Makefile_&.
1920
1921 If OpenSSL is installed, you should set
1922 .code
1923 USE_OPENSL=yes
1924 TLS_LIBS=-lssl -lcrypto
1925 .endd
1926 in &_Local/Makefile_&. You may also need to specify the locations of the
1927 OpenSSL library and include files. For example:
1928 .code
1929 USE_OPENSSL=yes
1930 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1931 TLS_INCLUDE=-I/usr/local/openssl/include/
1932 .endd
1933 .cindex "pkg-config" "OpenSSL"
1934 If you have &'pkg-config'& available, then instead you can just use:
1935 .code
1936 USE_OPENSSL=yes
1937 USE_OPENSSL_PC=openssl
1938 .endd
1939 .cindex "USE_GNUTLS"
1940 If GnuTLS is installed, you should set
1941 .code
1942 USE_GNUTLS=yes
1943 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1944 .endd
1945 in &_Local/Makefile_&, and again you may need to specify the locations of the
1946 library and include files. For example:
1947 .code
1948 USE_GNUTLS=yes
1949 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1950 TLS_INCLUDE=-I/usr/gnu/include
1951 .endd
1952 .cindex "pkg-config" "GnuTLS"
1953 If you have &'pkg-config'& available, then instead you can just use:
1954 .code
1955 USE_GNUTLS=yes
1956 USE_GNUTLS_PC=gnutls
1957 .endd
1958
1959 You do not need to set TLS_INCLUDE if the relevant directory is already
1960 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1961 given in chapter &<<CHAPTLS>>&.
1962
1963
1964
1965
1966 .section "Use of tcpwrappers" "SECID27"
1967
1968 .cindex "tcpwrappers, building Exim to support"
1969 .cindex "USE_TCP_WRAPPERS"
1970 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1971 .cindex "tcp_wrappers_daemon_name"
1972 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1973 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1974 alternative to Exim's own checking facilities for installations that are
1975 already making use of &'tcpwrappers'& for other purposes. To do this, you
1976 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1977 &_tcpd.h_& to be available at compile time, and also ensure that the library
1978 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1979 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1980 you might have
1981 .code
1982 USE_TCP_WRAPPERS=yes
1983 CFLAGS=-O -I/usr/local/include
1984 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1985 .endd
1986 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1987 files is &"exim"&. For example, the line
1988 .code
1989 exim : LOCAL  192.168.1.  .friendly.domain.example
1990 .endd
1991 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1992 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1993 All other connections are denied. The daemon name used by &'tcpwrappers'&
1994 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1995 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1996 configure file. Consult the &'tcpwrappers'& documentation for
1997 further details.
1998
1999
2000 .section "Including support for IPv6" "SECID28"
2001 .cindex "IPv6" "including support for"
2002 Exim contains code for use on systems that have IPv6 support. Setting
2003 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
2004 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
2005 where the IPv6 support is not fully integrated into the normal include and
2006 library files.
2007
2008 Two different types of DNS record for handling IPv6 addresses have been
2009 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2010 currently seen as the mainstream. Another record type called A6 was proposed
2011 as better than AAAA because it had more flexibility. However, it was felt to be
2012 over-complex, and its status was reduced to &"experimental"&.
2013 Exim used to
2014 have a compile option for including A6 record support but this has now been
2015 withdrawn.
2016
2017
2018
2019 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2020 .cindex "lookup modules"
2021 .cindex "dynamic modules"
2022 .cindex ".so building"
2023 On some platforms, Exim supports not compiling all lookup types directly into
2024 the main binary, instead putting some into external modules which can be loaded
2025 on demand.
2026 This permits packagers to build Exim with support for lookups with extensive
2027 library dependencies without requiring all users to install all of those
2028 dependencies.
2029 Most, but not all, lookup types can be built this way.
2030
2031 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2032 installed; Exim will only load modules from that directory, as a security
2033 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2034 for your OS; see &_OS/Makefile-Linux_& for an example.
2035 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2036 see &_src/EDITME_& for details.
2037
2038 Then, for each module to be loaded dynamically, define the relevant
2039 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2040 For example, this will build in lsearch but load sqlite and mysql support
2041 on demand:
2042 .code
2043 LOOKUP_LSEARCH=yes
2044 LOOKUP_SQLITE=2
2045 LOOKUP_MYSQL=2
2046 .endd
2047
2048
2049 .section "The building process" "SECID29"
2050 .cindex "build directory"
2051 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2052 created, run &'make'& at the top level. It determines the architecture and
2053 operating system types, and creates a build directory if one does not exist.
2054 For example, on a Sun system running Solaris 8, the directory
2055 &_build-SunOS5-5.8-sparc_& is created.
2056 .cindex "symbolic link" "to source files"
2057 Symbolic links to relevant source files are installed in the build directory.
2058
2059 If this is the first time &'make'& has been run, it calls a script that builds
2060 a make file inside the build directory, using the configuration files from the
2061 &_Local_& directory. The new make file is then passed to another instance of
2062 &'make'&. This does the real work, building a number of utility scripts, and
2063 then compiling and linking the binaries for the Exim monitor (if configured), a
2064 number of utility programs, and finally Exim itself. The command &`make
2065 makefile`& can be used to force a rebuild of the make file in the build
2066 directory, should this ever be necessary.
2067
2068 If you have problems building Exim, check for any comments there may be in the
2069 &_README_& file concerning your operating system, and also take a look at the
2070 FAQ, where some common problems are covered.
2071
2072
2073
2074 .section 'Output from &"make"&' "SECID283"
2075 The output produced by the &'make'& process for compile lines is often very
2076 unreadable, because these lines can be very long. For this reason, the normal
2077 output is suppressed by default, and instead output similar to that which
2078 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2079 each module that is being compiled or linked. However, it is still possible to
2080 get the full output, by calling &'make'& like this:
2081 .code
2082 FULLECHO='' make -e
2083 .endd
2084 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2085 command reflection in &'make'&. When you ask for the full output, it is
2086 given in addition to the short output.
2087
2088
2089
2090 .section "Overriding build-time options for Exim" "SECToverride"
2091 .cindex "build-time options, overriding"
2092 The main make file that is created at the beginning of the building process
2093 consists of the concatenation of a number of files which set configuration
2094 values, followed by a fixed set of &'make'& instructions. If a value is set
2095 more than once, the last setting overrides any previous ones. This provides a
2096 convenient way of overriding defaults. The files that are concatenated are, in
2097 order:
2098 .display
2099 &_OS/Makefile-Default_&
2100 &_OS/Makefile-_&<&'ostype'&>
2101 &_Local/Makefile_&
2102 &_Local/Makefile-_&<&'ostype'&>
2103 &_Local/Makefile-_&<&'archtype'&>
2104 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2105 &_OS/Makefile-Base_&
2106 .endd
2107 .cindex "&_Local/Makefile_&"
2108 .cindex "building Exim" "operating system type"
2109 .cindex "building Exim" "architecture type"
2110 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2111 architecture type. &_Local/Makefile_& is required to exist, and the building
2112 process fails if it is absent. The other three &_Local_& files are optional,
2113 and are often not needed.
2114
2115 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2116 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2117 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2118 values are used, thereby providing a means of forcing particular settings.
2119 Otherwise, the scripts try to get values from the &%uname%& command. If this
2120 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2121 of &'ad hoc'& transformations are then applied, to produce the standard names
2122 that Exim expects. You can run these scripts directly from the shell in order
2123 to find out what values are being used on your system.
2124
2125
2126 &_OS/Makefile-Default_& contains comments about the variables that are set
2127 therein. Some (but not all) are mentioned below. If there is something that
2128 needs changing, review the contents of this file and the contents of the make
2129 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2130 default values are.
2131
2132
2133 .cindex "building Exim" "overriding default settings"
2134 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2135 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2136 need to change the original files. Instead, you should make the changes by
2137 putting the new values in an appropriate &_Local_& file. For example,
2138 .cindex "Tru64-Unix build-time settings"
2139 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2140 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2141 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2142 called with the option &%-std1%&, to make it recognize some of the features of
2143 Standard C that Exim uses. (Most other compilers recognize Standard C by
2144 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2145 containing the lines
2146 .code
2147 CC=cc
2148 CFLAGS=-std1
2149 .endd
2150 If you are compiling for just one operating system, it may be easier to put
2151 these lines directly into &_Local/Makefile_&.
2152
2153 Keeping all your local configuration settings separate from the distributed
2154 files makes it easy to transfer them to new versions of Exim simply by copying
2155 the contents of the &_Local_& directory.
2156
2157
2158 .cindex "NIS lookup type" "including support for"
2159 .cindex "NIS+ lookup type" "including support for"
2160 .cindex "LDAP" "including support for"
2161 .cindex "lookup" "inclusion in binary"
2162 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2163 lookup, but not all systems have these components installed, so the default is
2164 not to include the relevant code in the binary. All the different kinds of file
2165 and database lookup that Exim supports are implemented as separate code modules
2166 which are included only if the relevant compile-time options are set. In the
2167 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2168 .code
2169 LOOKUP_LDAP=yes
2170 LOOKUP_NIS=yes
2171 LOOKUP_NISPLUS=yes
2172 .endd
2173 and similar settings apply to the other lookup types. They are all listed in
2174 &_src/EDITME_&. In many cases the relevant include files and interface
2175 libraries need to be installed before compiling Exim.
2176 .cindex "cdb" "including support for"
2177 However, there are some optional lookup types (such as cdb) for which
2178 the code is entirely contained within Exim, and no external include
2179 files or libraries are required. When a lookup type is not included in the
2180 binary, attempts to configure Exim to use it cause runtime configuration
2181 errors.
2182
2183 .cindex "pkg-config" "lookups"
2184 .cindex "pkg-config" "authenticators"
2185 Many systems now use a tool called &'pkg-config'& to encapsulate information
2186 about how to compile against a library; Exim has some initial support for
2187 being able to use pkg-config for lookups and authenticators.  For any given
2188 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2189 variable with the &`_PC`& suffix in the name and assign as the value the
2190 name of the package to be queried.  The results of querying via the
2191 &'pkg-config'& command will be added to the appropriate Makefile variables
2192 with &`+=`& directives, so your version of &'make'& will need to support that
2193 syntax.  For instance:
2194 .code
2195 LOOKUP_SQLITE=yes
2196 LOOKUP_SQLITE_PC=sqlite3
2197 AUTH_GSASL=yes
2198 AUTH_GSASL_PC=libgsasl
2199 AUTH_HEIMDAL_GSSAPI=yes
2200 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2201 .endd
2202
2203 .cindex "Perl" "including support for"
2204 Exim can be linked with an embedded Perl interpreter, allowing Perl
2205 subroutines to be called during string expansion. To enable this facility,
2206 .code
2207 EXIM_PERL=perl.o
2208 .endd
2209 must be defined in &_Local/Makefile_&. Details of this facility are given in
2210 chapter &<<CHAPperl>>&.
2211
2212 .cindex "X11 libraries, location of"
2213 The location of the X11 libraries is something that varies a lot between
2214 operating systems, and there may be different versions of X11 to cope
2215 with. Exim itself makes no use of X11, but if you are compiling the Exim
2216 monitor, the X11 libraries must be available.
2217 The following three variables are set in &_OS/Makefile-Default_&:
2218 .code
2219 X11=/usr/X11R6
2220 XINCLUDE=-I$(X11)/include
2221 XLFLAGS=-L$(X11)/lib
2222 .endd
2223 These are overridden in some of the operating-system configuration files. For
2224 example, in &_OS/Makefile-SunOS5_& there is
2225 .code
2226 X11=/usr/openwin
2227 XINCLUDE=-I$(X11)/include
2228 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2229 .endd
2230 If you need to override the default setting for your operating system, place a
2231 definition of all three of these variables into your
2232 &_Local/Makefile-<ostype>_& file.
2233
2234 .cindex "EXTRALIBS"
2235 If you need to add any extra libraries to the link steps, these can be put in a
2236 variable called EXTRALIBS, which appears in all the link commands, but by
2237 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2238 command for linking the main Exim binary, and not for any associated utilities.
2239
2240 .cindex "DBM libraries" "configuration for building"
2241 There is also DBMLIB, which appears in the link commands for binaries that
2242 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2243 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2244 binary, and which can be used, for example, to include additional X11
2245 libraries.
2246
2247 .cindex "configuration file" "editing"
2248 The make file copes with rebuilding Exim correctly if any of the configuration
2249 files are edited. However, if an optional configuration file is deleted, it is
2250 necessary to touch the associated non-optional file (that is,
2251 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2252
2253
2254 .section "OS-specific header files" "SECID30"
2255 .cindex "&_os.h_&"
2256 .cindex "building Exim" "OS-specific C header files"
2257 The &_OS_& directory contains a number of files with names of the form
2258 &_os.h-<ostype>_&. These are system-specific C header files that should not
2259 normally need to be changed. There is a list of macro settings that are
2260 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2261 are porting Exim to a new operating system.
2262
2263
2264
2265 .section "Overriding build-time options for the monitor" "SECID31"
2266 .cindex "building Eximon"
2267 A similar process is used for overriding things when building the Exim monitor,
2268 where the files that are involved are
2269 .display
2270 &_OS/eximon.conf-Default_&
2271 &_OS/eximon.conf-_&<&'ostype'&>
2272 &_Local/eximon.conf_&
2273 &_Local/eximon.conf-_&<&'ostype'&>
2274 &_Local/eximon.conf-_&<&'archtype'&>
2275 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2276 .endd
2277 .cindex "&_Local/eximon.conf_&"
2278 As with Exim itself, the final three files need not exist, and in this case the
2279 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2280 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2281 variables of the same name, preceded by EXIMON_. For example, setting
2282 EXIMON_LOG_DEPTH in the environment overrides the value of
2283 LOG_DEPTH at runtime.
2284 .ecindex IIDbuex
2285
2286
2287 .section "Installing Exim binaries and scripts" "SECID32"
2288 .cindex "installing Exim"
2289 .cindex "BIN_DIRECTORY"
2290 The command &`make install`& runs the &(exim_install)& script with no
2291 arguments. The script copies binaries and utility scripts into the directory
2292 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2293 .cindex "setuid" "installing Exim with"
2294 The install script copies files only if they are newer than the files they are
2295 going to replace. The Exim binary is required to be owned by root and have the
2296 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2297 install`& as root so that it can set up the Exim binary in this way. However, in
2298 some special situations (for example, if a host is doing no local deliveries)
2299 it may be possible to run Exim without making the binary setuid root (see
2300 chapter &<<CHAPsecurity>>& for details).
2301
2302 .cindex "CONFIGURE_FILE"
2303 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2304 in &_Local/Makefile_&. If this names a single file, and the file does not
2305 exist, the default configuration file &_src/configure.default_& is copied there
2306 by the installation script. If a runtime configuration file already exists, it
2307 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2308 alternative files, no default is installed.
2309
2310 .cindex "system aliases file"
2311 .cindex "&_/etc/aliases_&"
2312 One change is made to the default configuration file when it is installed: the
2313 default configuration contains a router that references a system aliases file.
2314 The path to this file is set to the value specified by
2315 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2316 If the system aliases file does not exist, the installation script creates it,
2317 and outputs a comment to the user.
2318
2319 The created file contains no aliases, but it does contain comments about the
2320 aliases a site should normally have. Mail aliases have traditionally been
2321 kept in &_/etc/aliases_&. However, some operating systems are now using
2322 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2323 Exim's configuration if necessary.
2324
2325 The default configuration uses the local host's name as the only local domain,
2326 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2327 running as the local user. System aliases and &_.forward_& files in users' home
2328 directories are supported, but no NIS or NIS+ support is configured. Domains
2329 other than the name of the local host are routed using the DNS, with delivery
2330 over SMTP.
2331
2332 It is possible to install Exim for special purposes (such as building a binary
2333 distribution) in a private part of the file system. You can do this by a
2334 command such as
2335 .code
2336 make DESTDIR=/some/directory/ install
2337 .endd
2338 This has the effect of pre-pending the specified directory to all the file
2339 paths, except the name of the system aliases file that appears in the default
2340 configuration. (If a default alias file is created, its name &'is'& modified.)
2341 For backwards compatibility, ROOT is used if DESTDIR is not set,
2342 but this usage is deprecated.
2343
2344 .cindex "installing Exim" "what is not installed"
2345 Running &'make install'& does not copy the Exim 4 conversion script
2346 &'convert4r4'&. You will probably run this only once if you are
2347 upgrading from Exim 3. None of the documentation files in the &_doc_&
2348 directory are copied, except for the info files when you have set
2349 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2350
2351 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2352 to their names. The Exim binary itself, however, is handled differently. It is
2353 installed under a name that includes the version number and the compile number,
2354 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2355 called &_exim_& to point to the binary. If you are updating a previous version
2356 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2357 from the directory (as seen by other processes).
2358
2359 .cindex "installing Exim" "testing the script"
2360 If you want to see what the &'make install'& will do before running it for
2361 real, you can pass the &%-n%& option to the installation script by this
2362 command:
2363 .code
2364 make INSTALL_ARG=-n install
2365 .endd
2366 The contents of the variable INSTALL_ARG are passed to the installation
2367 script. You do not need to be root to run this test. Alternatively, you can run
2368 the installation script directly, but this must be from within the build
2369 directory. For example, from the top-level Exim directory you could use this
2370 command:
2371 .code
2372 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2373 .endd
2374 .cindex "installing Exim" "install script options"
2375 There are two other options that can be supplied to the installation script.
2376
2377 .ilist
2378 &%-no_chown%& bypasses the call to change the owner of the installed binary
2379 to root, and the call to make it a setuid binary.
2380 .next
2381 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2382 installed binary.
2383 .endlist
2384
2385 INSTALL_ARG can be used to pass these options to the script. For example:
2386 .code
2387 make INSTALL_ARG=-no_symlink install
2388 .endd
2389 The installation script can also be given arguments specifying which files are
2390 to be copied. For example, to install just the Exim binary, and nothing else,
2391 without creating the symbolic link, you could use:
2392 .code
2393 make INSTALL_ARG='-no_symlink exim' install
2394 .endd
2395
2396
2397
2398 .section "Installing info documentation" "SECTinsinfdoc"
2399 .cindex "installing Exim" "&'info'& documentation"
2400 Not all systems use the GNU &'info'& system for documentation, and for this
2401 reason, the Texinfo source of Exim's documentation is not included in the main
2402 distribution. Instead it is available separately from the FTP site (see section
2403 &<<SECTavail>>&).
2404
2405 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2406 source of the documentation is found in the source tree, running &`make
2407 install`& automatically builds the info files and installs them.
2408
2409
2410
2411 .section "Setting up the spool directory" "SECID33"
2412 .cindex "spool directory" "creating"
2413 When it starts up, Exim tries to create its spool directory if it does not
2414 exist. The Exim uid and gid are used for the owner and group of the spool
2415 directory. Sub-directories are automatically created in the spool directory as
2416 necessary.
2417
2418
2419
2420
2421 .section "Testing" "SECID34"
2422 .cindex "testing" "installation"
2423 Having installed Exim, you can check that the runtime configuration file is
2424 syntactically valid by running the following command, which assumes that the
2425 Exim binary directory is within your PATH environment variable:
2426 .code
2427 exim -bV
2428 .endd
2429 If there are any errors in the configuration file, Exim outputs error messages.
2430 Otherwise it outputs the version number and build date,
2431 the DBM library that is being used, and information about which drivers and
2432 other optional code modules are included in the binary.
2433 Some simple routing tests can be done by using the address testing option. For
2434 example,
2435 .display
2436 &`exim -bt`& <&'local username'&>
2437 .endd
2438 should verify that it recognizes a local mailbox, and
2439 .display
2440 &`exim -bt`& <&'remote address'&>
2441 .endd
2442 a remote one. Then try getting it to deliver mail, both locally and remotely.
2443 This can be done by passing messages directly to Exim, without going through a
2444 user agent. For example:
2445 .code
2446 exim -v postmaster@your.domain.example
2447 From: user@your.domain.example
2448 To: postmaster@your.domain.example
2449 Subject: Testing Exim
2450
2451 This is a test message.
2452 ^D
2453 .endd
2454 The &%-v%& option causes Exim to output some verification of what it is doing.
2455 In this case you should see copies of three log lines, one for the message's
2456 arrival, one for its delivery, and one containing &"Completed"&.
2457
2458 .cindex "delivery" "problems with"
2459 If you encounter problems, look at Exim's log files (&'mainlog'& and
2460 &'paniclog'&) to see if there is any relevant information there. Another source
2461 of information is running Exim with debugging turned on, by specifying the
2462 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2463 with debugging turned on by a command of the form
2464 .display
2465 &`exim -d -M`& <&'exim-message-id'&>
2466 .endd
2467 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2468 produces rather a lot of output, but you can cut this down to specific areas.
2469 For example, if you use &%-d-all+route%& only the debugging information
2470 relevant to routing is included. (See the &%-d%& option in chapter
2471 &<<CHAPcommandline>>& for more details.)
2472
2473 .cindex '&"sticky"& bit'
2474 .cindex "lock files"
2475 One specific problem that has shown up on some sites is the inability to do
2476 local deliveries into a shared mailbox directory, because it does not have the
2477 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2478 writing to a mailbox file, and if it cannot create the lock file, the delivery
2479 is deferred. You can get round this either by setting the &"sticky bit"& on the
2480 directory, or by setting a specific group for local deliveries and allowing
2481 that group to create files in the directory (see the comments above the
2482 &(local_delivery)& transport in the default configuration file). Another
2483 approach is to configure Exim not to use lock files, but just to rely on
2484 &[fcntl()]& locking instead. However, you should do this only if all user
2485 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2486 see chapter &<<CHAPappendfile>>&.
2487
2488 One thing that cannot be tested on a system that is already running an MTA is
2489 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2490 &%-oX%& option can be used to run an Exim daemon that listens on some other
2491 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2492 &'exim_checkaccess'& utility can be used to check out policy controls on
2493 incoming SMTP mail.
2494
2495 Testing a new version on a system that is already running Exim can most easily
2496 be done by building a binary with a different CONFIGURE_FILE setting. From
2497 within the runtime configuration, all other file and directory names
2498 that Exim uses can be altered, in order to keep it entirely clear of the
2499 production version.
2500
2501
2502 .section "Replacing another MTA with Exim" "SECID35"
2503 .cindex "replacing another MTA"
2504 Building and installing Exim for the first time does not of itself put it in
2505 general use. The name by which the system's MTA is called by mail user agents
2506 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2507 operating system), and it is necessary to make this name point to the &'exim'&
2508 binary in order to get the user agents to pass messages to Exim. This is
2509 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2510 or &_/usr/lib/sendmail_&
2511 .cindex "symbolic link" "to &'exim'& binary"
2512 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2513 privilege and executable status from the old MTA. It is then necessary to stop
2514 and restart the mailer daemon, if one is running.
2515
2516 .cindex "FreeBSD, MTA indirection"
2517 .cindex "&_/etc/mail/mailer.conf_&"
2518 Some operating systems have introduced alternative ways of switching MTAs. For
2519 example, if you are running FreeBSD, you need to edit the file
2520 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2521 described. A typical example of the contents of this file for running Exim is
2522 as follows:
2523 .code
2524 sendmail            /usr/exim/bin/exim
2525 send-mail           /usr/exim/bin/exim
2526 mailq               /usr/exim/bin/exim -bp
2527 newaliases          /usr/bin/true
2528 .endd
2529 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2530 your Exim installation is &"live"&. Check it by sending a message from your
2531 favourite user agent.
2532
2533 You should consider what to tell your users about the change of MTA. Exim may
2534 have different capabilities to what was previously running, and there are
2535 various operational differences such as the text of messages produced by
2536 command line options and in bounce messages. If you allow your users to make
2537 use of Exim's filtering capabilities, you should make the document entitled
2538 &'Exim's interface to mail filtering'& available to them.
2539
2540
2541
2542 .section "Running the daemon" SECTdaemonLaunch
2543 The most common command line for launching the Exim daemon looks like
2544 .code
2545 exim -bd -q5m
2546 .endd
2547 This starts a daemon which
2548 .ilist
2549 listens for incoming smtp connections, launching handler processes for
2550 each new one
2551 .next
2552 starts a queue-runner process every five minutes, to inspect queued messages
2553 and run delivery attempts on any that have arrived at their retry time
2554 .endlist
2555 Should a queue run take longer than the time between queue-runner starts,
2556 they will run in parallel.
2557 Numbers of jobs of the various types are subject to policy controls
2558 defined in the configuration.
2559
2560
2561 .section "Upgrading Exim" "SECID36"
2562 .cindex "upgrading Exim"
2563 If you are already running Exim on your host, building and installing a new
2564 version automatically makes it available to MUAs, or any other programs that
2565 call the MTA directly. However, if you are running an Exim daemon, you do need
2566 .cindex restart "on HUP signal"
2567 .cindex signal "HUP, to restart"
2568 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2569 new binary. You do not need to stop processing mail in order to install a new
2570 version of Exim. The install script does not modify an existing runtime
2571 configuration file.
2572
2573
2574
2575
2576 .section "Stopping the Exim daemon on Solaris" "SECID37"
2577 .cindex "Solaris" "stopping Exim on"
2578 The standard command for stopping the mailer daemon on Solaris is
2579 .code
2580 /etc/init.d/sendmail stop
2581 .endd
2582 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2583 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2584 for the text &"sendmail"&; this is not present because the actual program name
2585 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2586 solution is to replace the line that finds the process id with something like
2587 .code
2588 pid=`cat /var/spool/exim/exim-daemon.pid`
2589 .endd
2590 to obtain the daemon's pid directly from the file that Exim saves it in.
2591
2592 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2593 still be received from local processes, and if automatic delivery is configured
2594 (the normal case), deliveries will still occur.
2595
2596
2597
2598
2599 . ////////////////////////////////////////////////////////////////////////////
2600 . ////////////////////////////////////////////////////////////////////////////
2601
2602 .chapter "The Exim command line" "CHAPcommandline"
2603 .scindex IIDclo1 "command line" "options"
2604 .scindex IIDclo2 "options" "command line"
2605 Exim's command line takes the standard Unix form of a sequence of options,
2606 each starting with a hyphen character, followed by a number of arguments. The
2607 options are compatible with the main options of Sendmail, and there are also
2608 some additional options, some of which are compatible with Smail 3. Certain
2609 combinations of options do not make sense, and provoke an error if used.
2610 The form of the arguments depends on which options are set.
2611
2612
2613 .section "Setting options by program name" "SECID38"
2614 .cindex "&'mailq'&"
2615 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2616 were present before any other options.
2617 The &%-bp%& option requests a listing of the contents of the mail queue on the
2618 standard output.
2619 This feature is for compatibility with some systems that contain a command of
2620 that name in one of the standard libraries, symbolically linked to
2621 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2622
2623 .cindex "&'rsmtp'&"
2624 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2625 were present before any other options, for compatibility with Smail. The
2626 &%-bS%& option is used for reading in a number of messages in batched SMTP
2627 format.
2628
2629 .cindex "&'rmail'&"
2630 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2631 &%-oee%& options were present before any other options, for compatibility with
2632 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2633
2634 .cindex "&'runq'&"
2635 .cindex "queue runner"
2636 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2637 were present before any other options, for compatibility with Smail. The &%-q%&
2638 option causes a single queue runner process to be started.
2639
2640 .cindex "&'newaliases'&"
2641 .cindex "alias file" "building"
2642 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2643 If Exim is called under the name &'newaliases'& it behaves as if the option
2644 &%-bi%& were present before any other options, for compatibility with Sendmail.
2645 This option is used for rebuilding Sendmail's alias file. Exim does not have
2646 the concept of a single alias file, but can be configured to run a given
2647 command if called with the &%-bi%& option.
2648
2649
2650 .section "Trusted and admin users" "SECTtrustedadmin"
2651 Some Exim options are available only to &'trusted users'& and others are
2652 available only to &'admin users'&. In the description below, the phrases &"Exim
2653 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2654 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2655 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2656
2657 .ilist
2658 .cindex "trusted users" "definition of"
2659 .cindex "user" "trusted definition of"
2660 The trusted users are root, the Exim user, any user listed in the
2661 &%trusted_users%& configuration option, and any user whose current group or any
2662 supplementary group is one of those listed in the &%trusted_groups%&
2663 configuration option. Note that the Exim group is not automatically trusted.
2664
2665 .cindex '&"From"& line'
2666 .cindex "envelope from"
2667 .cindex "envelope sender"
2668 Trusted users are always permitted to use the &%-f%& option or a leading
2669 &"From&~"& line to specify the envelope sender of a message that is passed to
2670 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2671 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2672 users to set envelope senders.
2673
2674 .chindex From:
2675 .chindex Sender:
2676 For a trusted user, there is never any check on the contents of the &'From:'&
2677 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2678 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2679
2680 Trusted users may also specify a host name, host address, interface address,
2681 protocol name, ident value, and authentication data when submitting a message
2682 locally. Thus, they are able to insert messages into Exim's queue locally that
2683 have the characteristics of messages received from a remote host. Untrusted
2684 users may in some circumstances use &%-f%&, but can never set the other values
2685 that are available to trusted users.
2686 .next
2687 .cindex "user" "admin definition of"
2688 .cindex "admin user" "definition of"
2689 The admin users are root, the Exim user, and any user that is a member of the
2690 Exim group or of any group listed in the &%admin_groups%& configuration option.
2691 The current group does not have to be one of these groups.
2692
2693 Admin users are permitted to list the queue, and to carry out certain
2694 operations on messages, for example, to force delivery failures. It is also
2695 necessary to be an admin user in order to see the full information provided by
2696 the Exim monitor, and full debugging output.
2697
2698 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2699 Exim to attempt delivery of messages on its queue is restricted to admin users.
2700 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2701 option false (that is, specifying &%no_prod_requires_admin%&).
2702
2703 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2704 is restricted to admin users unless &%queue_list_requires_admin%& is set
2705 false.
2706 .endlist
2707
2708
2709 &*Warning*&: If you configure your system so that admin users are able to
2710 edit Exim's configuration file, you are giving those users an easy way of
2711 getting root. There is further discussion of this issue at the start of chapter
2712 &<<CHAPconf>>&.
2713
2714
2715
2716
2717 .section "Command line options" "SECID39"
2718 Exim's command line options are described in alphabetical order below. If none
2719 of the options that specifies a specific action (such as starting the daemon or
2720 a queue runner, or testing an address, or receiving a message in a specific
2721 format, or listing the queue) are present, and there is at least one argument
2722 on the command line, &%-bm%& (accept a local message on the standard input,
2723 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2724 outputs a brief message about itself and exits.
2725
2726 . ////////////////////////////////////////////////////////////////////////////
2727 . Insert a stylized XML comment here, to identify the start of the command line
2728 . options. This is for the benefit of the Perl script that automatically
2729 . creates a man page for the options.
2730 . ////////////////////////////////////////////////////////////////////////////
2731
2732 .literal xml
2733 <!-- === Start of command line options === -->
2734 .literal off
2735
2736
2737 .vlist
2738 .cmdopt "--" "--"
2739 .cindex "options" "command line; terminating"
2740 This is a pseudo-option whose only purpose is to terminate the options and
2741 therefore to cause subsequent command line items to be treated as arguments
2742 rather than options, even if they begin with hyphens.
2743
2744 .cmdopt --help
2745 This option causes Exim to output a few sentences stating what it is.
2746 The same output is generated if the Exim binary is called with no options and
2747 no arguments.
2748
2749 .cmdopt --version
2750 This option is an alias for &%-bV%& and causes version information to be
2751 displayed.
2752
2753 .vitem &%-Ac%& &&&
2754        &%-Am%&
2755 .oindex "&%-Ac%&"
2756 .oindex "&%-Am%&"
2757 These options are used by Sendmail for selecting configuration files and are
2758 ignored by Exim.
2759
2760 .cmdopt -B <&'type'&>
2761 .oindex "&%-B%&"
2762 .cindex "8-bit characters"
2763 .cindex "Sendmail compatibility" "8-bit characters"
2764 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2765 clean; it ignores this option.
2766
2767 .cmdopt -bd
2768 .cindex "daemon"
2769 .cindex "SMTP" "listener"
2770 .cindex "queue runner"
2771 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2772 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2773 that the daemon should also initiate periodic queue runs.
2774
2775 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2776 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2777 disconnect from the controlling terminal. When running this way, it can be
2778 stopped by pressing ctrl-C.
2779
2780 By default, Exim listens for incoming connections to the standard SMTP port on
2781 all the host's running interfaces. However, it is possible to listen on other
2782 ports, on multiple ports, and only on specific interfaces. Chapter
2783 &<<CHAPinterfaces>>& contains a description of the options that control this.
2784
2785 When a listening daemon
2786 .cindex "daemon" "process id (pid)"
2787 .cindex "pid (process id)" "of daemon"
2788 is started without the use of &%-oX%& (that is, without overriding the normal
2789 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2790 in Exim's spool directory. This location can be overridden by setting
2791 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2792 running as root.
2793
2794 When &%-oX%& is used on the command line to start a listening daemon, the
2795 process id is not written to the normal pid file path. However, &%-oP%& can be
2796 used to specify a path on the command line if a pid file is required.
2797
2798 The SIGHUP signal
2799 .cindex "SIGHUP"
2800 .cindex restart "on HUP signal"
2801 .cindex signal "HUP, to restart"
2802 .cindex "daemon" "restarting"
2803 .cindex signal "to reload configuration"
2804 .cindex daemon "reload configuration"
2805 .cindex reload configuration
2806 can be used to cause the daemon to re-execute itself. This should be done
2807 whenever Exim's configuration file, or any file that is incorporated into it by
2808 means of the &%.include%& facility, is changed, and also whenever a new version
2809 of Exim is installed. It is not necessary to do this when other files that are
2810 referenced from the configuration (for example, alias files) are changed,
2811 because these are reread each time they are used.
2812
2813 .cmdopt -bdf
2814 This option has the same effect as &%-bd%& except that it never disconnects
2815 from the controlling terminal, even when no debugging is specified.
2816
2817 .cmdopt -be
2818 .cindex "testing" "string expansion"
2819 .cindex "expansion" "testing"
2820 Run Exim in expansion testing mode. Exim discards its root privilege, to
2821 prevent ordinary users from using this mode to read otherwise inaccessible
2822 files. If no arguments are given, Exim runs interactively, prompting for lines
2823 of data. Otherwise, it processes each argument in turn.
2824
2825 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2826 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2827 used without command line arguments. If successful, it uses the &[readline()]&
2828 function, which provides extensive line-editing facilities, for reading the
2829 test data. A line history is supported.
2830
2831 Long expansion expressions can be split over several lines by using backslash
2832 continuations. As in Exim's runtime configuration, white space at the start of
2833 continuation lines is ignored. Each argument or data line is passed through the
2834 string expansion mechanism, and the result is output. Variable values from the
2835 configuration file (for example, &$qualify_domain$&) are available, but no
2836 message-specific values (such as &$message_exim_id$&) are set, because no message
2837 is being processed (but see &%-bem%& and &%-Mset%&).
2838
2839 &*Note*&: If you use this mechanism to test lookups, and you change the data
2840 files or databases you are using, you must exit and restart Exim before trying
2841 the same lookup again. Otherwise, because each Exim process caches the results
2842 of lookups, you will just get the same result as before.
2843
2844 Macro processing is done on lines before string-expansion: new macros can be
2845 defined and macros will be expanded.
2846 Because macros in the config file are often used for secrets, those are only
2847 available to admin users.
2848
2849 .new
2850 The word &"set"& at the start of a line, followed by a single space,
2851 is recognised specially as defining a value for a variable.
2852 The syntax is otherwise the same as the ACL modifier &"set ="&.
2853 .wen
2854
2855 .cmdopt -bem <&'filename'&>
2856 .cindex "testing" "string expansion"
2857 .cindex "expansion" "testing"
2858 This option operates like &%-be%& except that it must be followed by the name
2859 of a file. For example:
2860 .code
2861 exim -bem /tmp/testmessage
2862 .endd
2863 The file is read as a message (as if receiving a locally-submitted non-SMTP
2864 message) before any of the test expansions are done. Thus, message-specific
2865 variables such as &$message_size$& and &$header_from:$& are available. However,
2866 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2867 recipients are read from the headers in the normal way, and are shown in the
2868 &$recipients$& variable. Note that recipients cannot be given on the command
2869 line, because further arguments are taken as strings to expand (just like
2870 &%-be%&).
2871
2872 .cmdopt -bF <&'filename'&>
2873 .cindex "system filter" "testing"
2874 .cindex "testing" "system filter"
2875 This option is the same as &%-bf%& except that it assumes that the filter being
2876 tested is a system filter. The additional commands that are available only in
2877 system filters are recognized.
2878
2879 .cmdopt -bf <&'filename'&>
2880 .cindex "filter" "testing"
2881 .cindex "testing" "filter file"
2882 .cindex "forward file" "testing"
2883 .cindex "testing" "forward file"
2884 .cindex "Sieve filter" "testing"
2885 This option runs Exim in user filter testing mode; the file is the filter file
2886 to be tested, and a test message must be supplied on the standard input. If
2887 there are no message-dependent tests in the filter, an empty file can be
2888 supplied.
2889
2890 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2891 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2892 filter and a user filter in the same run. For example:
2893 .code
2894 exim -bF /system/filter -bf /user/filter </test/message
2895 .endd
2896 This is helpful when the system filter adds header lines or sets filter
2897 variables that are used by the user filter.
2898
2899 If the test filter file does not begin with one of the special lines
2900 .code
2901 # Exim filter
2902 # Sieve filter
2903 .endd
2904 it is taken to be a normal &_.forward_& file, and is tested for validity under
2905 that interpretation. See sections &<<SECTitenonfilred>>& to
2906 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2907 redirection lists.
2908
2909 The result of an Exim command that uses &%-bf%&, provided no errors are
2910 detected, is a list of the actions that Exim would try to take if presented
2911 with the message for real. More details of filter testing are given in the
2912 separate document entitled &'Exim's interfaces to mail filtering'&.
2913
2914 When testing a filter file,
2915 .cindex "&""From""& line"
2916 .cindex "envelope from"
2917 .cindex "envelope sender"
2918 .oindex "&%-f%&" "for filter testing"
2919 the envelope sender can be set by the &%-f%& option,
2920 or by a &"From&~"& line at the start of the test message. Various parameters
2921 that would normally be taken from the envelope recipient address of the message
2922 can be set by means of additional command line options (see the next four
2923 options).
2924
2925 .cmdopt -bfd <&'domain'&>
2926 .vindex "&$qualify_domain$&"
2927 This sets the domain of the recipient address when a filter file is being
2928 tested by means of the &%-bf%& option. The default is the value of
2929 &$qualify_domain$&.
2930
2931 .cmdopt -bfl <&'local&~part'&>
2932 This sets the local part of the recipient address when a filter file is being
2933 tested by means of the &%-bf%& option. The default is the username of the
2934 process that calls Exim. A local part should be specified with any prefix or
2935 suffix stripped, because that is how it appears to the filter when a message is
2936 actually being delivered.
2937
2938 .cmdopt -bfp <&'prefix'&>
2939 .cindex affix "filter testing"
2940 This sets the prefix of the local part of the recipient address when a filter
2941 file is being tested by means of the &%-bf%& option. The default is an empty
2942 prefix.
2943
2944 .cmdopt -bfs <&'suffix'&>
2945 .cindex affix "filter testing"
2946 This sets the suffix of the local part of the recipient address when a filter
2947 file is being tested by means of the &%-bf%& option. The default is an empty
2948 suffix.
2949
2950 .cmdopt -bh <&'IP&~address'&>
2951 .cindex "testing" "incoming SMTP"
2952 .cindex "SMTP" "testing incoming"
2953 .cindex "testing" "relay control"
2954 .cindex "relaying" "testing configuration"
2955 .cindex "policy control" "testing"
2956 .cindex "debugging" "&%-bh%& option"
2957 This option runs a fake SMTP session as if from the given IP address, using the
2958 standard input and output. The IP address may include a port number at the end,
2959 after a full stop. For example:
2960 .code
2961 exim -bh 10.9.8.7.1234
2962 exim -bh fe80::a00:20ff:fe86:a061.5678
2963 .endd
2964 When an IPv6 address is given, it is converted into canonical form. In the case
2965 of the second example above, the value of &$sender_host_address$& after
2966 conversion to the canonical form is
2967 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2968
2969 Comments as to what is going on are written to the standard error file. These
2970 include lines beginning with &"LOG"& for anything that would have been logged.
2971 This facility is provided for testing configuration options for incoming
2972 messages, to make sure they implement the required policy. For example, you can
2973 test your relay controls using &%-bh%&.
2974
2975 &*Warning 1*&:
2976 .cindex "RFC 1413"
2977 You can test features of the configuration that rely on ident (RFC 1413)
2978 information by using the &%-oMt%& option. However, Exim cannot actually perform
2979 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2980 connection.
2981
2982 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2983 are also skipped when testing using &%-bh%&. If you want these callouts to
2984 occur, use &%-bhc%& instead.
2985
2986 Messages supplied during the testing session are discarded, and nothing is
2987 written to any of the real log files. There may be pauses when DNS (and other)
2988 lookups are taking place, and of course these may time out. The &%-oMi%& option
2989 can be used to specify a specific IP interface and port if this is important,
2990 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2991 session were authenticated.
2992
2993 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2994 output just states whether a given recipient address from a given host is
2995 acceptable or not. See section &<<SECTcheckaccess>>&.
2996
2997 Features such as authentication and encryption, where the client input is not
2998 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2999 specialized SMTP test program such as
3000 &url(https://www.jetmore.org/john/code/swaks/,swaks).
3001
3002 .cmdopt -bhc <&'IP&~address'&>
3003 This option operates in the same way as &%-bh%&, except that address
3004 verification callouts are performed if required. This includes consulting and
3005 updating the callout cache database.
3006
3007 .cmdopt -bi
3008 .cindex "alias file" "building"
3009 .cindex "building alias file"
3010 .cindex "Sendmail compatibility" "&%-bi%& option"
3011 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
3012 Exim does not have the concept of a single alias file, and so it cannot mimic
3013 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
3014 tend to appear in various scripts such as NIS make files, so the option must be
3015 recognized.
3016
3017 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3018 configuration option is run, under the uid and gid of the caller of Exim. If
3019 the &%-oA%& option is used, its value is passed to the command as an argument.
3020 The command set by &%bi_command%& may not contain arguments. The command can
3021 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3022 if this is required. If the &%bi_command%& option is not set, calling Exim with
3023 &%-bi%& is a no-op.
3024
3025 . // Keep :help first, then the rest in alphabetical order
3026 .cmdopt -bI:help
3027 .cindex "querying exim information"
3028 We shall provide various options starting &`-bI:`& for querying Exim for
3029 information.  The output of many of these will be intended for machine
3030 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3031 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3032 options shall cause Exim to exit after producing the requested output.
3033
3034 .cmdopt -bI:dscp
3035 .cindex "DSCP" "values"
3036 This option causes Exim to emit an alphabetically sorted list of all
3037 recognised DSCP names.
3038
3039 .cmdopt -bI:sieve
3040 .cindex "Sieve filter" "capabilities"
3041 This option causes Exim to emit an alphabetically sorted list of all supported
3042 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3043 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3044 &`SIEVE`& capability response line.  As the precise list may depend upon
3045 compile-time build options, which this option will adapt to, this is the only
3046 way to guarantee a correct response.
3047
3048 .cmdopt -bm
3049 .cindex "local message reception"
3050 This option runs an Exim receiving process that accepts an incoming,
3051 locally-generated message on the standard input. The recipients are given as the
3052 command arguments (except when &%-t%& is also present &-- see below). Each
3053 argument can be a comma-separated list of RFC 2822 addresses. This is the
3054 default option for selecting the overall action of an Exim call; it is assumed
3055 if no other conflicting option is present.
3056
3057 If any addresses in the message are unqualified (have no domain), they are
3058 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3059 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3060 suppressing this for special cases.
3061
3062 Policy checks on the contents of local messages can be enforced by means of
3063 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3064
3065 .cindex "return code" "for &%-bm%&"
3066 The return code is zero if the message is successfully accepted. Otherwise, the
3067 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3068
3069 The format
3070 .cindex "message" "format"
3071 .cindex "format" "message"
3072 .cindex "&""From""& line"
3073 .cindex "UUCP" "&""From""& line"
3074 .cindex "Sendmail compatibility" "&""From""& line"
3075 of the message must be as defined in RFC 2822, except that, for
3076 compatibility with Sendmail and Smail, a line in one of the forms
3077 .code
3078 From sender Fri Jan  5 12:55 GMT 1997
3079 From sender Fri, 5 Jan 97 12:55:01
3080 .endd
3081 (with the weekday optional, and possibly with additional text after the date)
3082 is permitted to appear at the start of the message. There appears to be no
3083 authoritative specification of the format of this line. Exim recognizes it by
3084 matching against the regular expression defined by the &%uucp_from_pattern%&
3085 option, which can be changed if necessary.
3086
3087 .oindex "&%-f%&" "overriding &""From""& line"
3088 The specified sender is treated as if it were given as the argument to the
3089 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3090 preference to the address taken from the message. The caller of Exim must be a
3091 trusted user for the sender of a message to be set in this way.
3092
3093 .cmdopt -bmalware <&'filename'&>
3094 .cindex "testing", "malware"
3095 .cindex "malware scan test"
3096 This debugging option causes Exim to scan the given file or directory
3097 (depending on the used scanner interface),
3098 using the malware scanning framework.  The option of &%av_scanner%& influences
3099 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3100 the expansion should have defaults which apply to this invocation.  ACLs are
3101 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3102 will never be populated and &%-bmalware%& will fail.
3103
3104 Exim will have changed working directory before resolving the filename, so
3105 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3106 user when it tries to open the file, rather than as the invoking user.
3107 This option requires admin privileges.
3108
3109 The &%-bmalware%& option will not be extended to be more generally useful,
3110 there are better tools for file-scanning.  This option exists to help
3111 administrators verify their Exim and AV scanner configuration.
3112
3113 .cmdopt -bnq
3114 .cindex "address qualification, suppressing"
3115 By default, Exim automatically qualifies unqualified addresses (those
3116 without domains) that appear in messages that are submitted locally (that
3117 is, not over TCP/IP). This qualification applies both to addresses in
3118 envelopes, and addresses in header lines. Sender addresses are qualified using
3119 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3120 defaults to the value of &%qualify_domain%&).
3121
3122 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3123 being used to re-submit messages that originally came from remote hosts after
3124 content scanning, you probably do not want to qualify unqualified addresses in
3125 header lines. (Such lines will be present only if you have not enabled a header
3126 syntax check in the appropriate ACL.)
3127
3128 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3129 messages that originate on the local host. When this is used, unqualified
3130 addresses in the envelope provoke errors (causing message rejection) and
3131 unqualified addresses in header lines are left alone.
3132
3133
3134 .cmdopt -bP
3135 .cindex "configuration options" "extracting"
3136 .cindex "options" "configuration &-- extracting"
3137 If this option is given with no arguments, it causes the values of all Exim's
3138 main configuration options to be written to the standard output. The values
3139 of one or more specific options can be requested by giving their names as
3140 arguments, for example:
3141 .code
3142 exim -bP qualify_domain hold_domains
3143 .endd
3144 .cindex "hiding configuration option values"
3145 .cindex "configuration options" "hiding value of"
3146 .cindex "options" "hiding value of"
3147 However, any option setting that is preceded by the word &"hide"& in the
3148 configuration file is not shown in full, except to an admin user. For other
3149 users, the output is as in this example:
3150 .code
3151 mysql_servers = <value not displayable>
3152 .endd
3153 If &%config%& is given as an argument, the config is
3154 output, as it was parsed, any include file resolved, any comment removed.
3155
3156 If &%config_file%& is given as an argument, the name of the runtime
3157 configuration file is output. (&%configure_file%& works too, for
3158 backward compatibility.)
3159 If a list of configuration files was supplied, the value that is output here
3160 is the name of the file that was actually used.
3161
3162 .cindex "options" "hiding name of"
3163 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3164 name will not be output.
3165
3166 .cindex "daemon" "process id (pid)"
3167 .cindex "pid (process id)" "of daemon"
3168 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3169 directories where log files and daemon pid files are written are output,
3170 respectively. If these values are unset, log files are written in a
3171 sub-directory of the spool directory called &%log%&, and the pid file is
3172 written directly into the spool directory.
3173
3174 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3175 .code
3176 exim -bP +local_domains
3177 .endd
3178 it searches for a matching named list of any type (domain, host, address, or
3179 local part) and outputs what it finds.
3180
3181 .cindex "options" "router &-- extracting"
3182 .cindex "options" "transport &-- extracting"
3183 .cindex "options" "authenticator &-- extracting"
3184 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3185 followed by the name of an appropriate driver instance, the option settings for
3186 that driver are output. For example:
3187 .code
3188 exim -bP transport local_delivery
3189 .endd
3190 The generic driver options are output first, followed by the driver's private
3191 options. A list of the names of drivers of a particular type can be obtained by
3192 using one of the words &%router_list%&, &%transport_list%&, or
3193 &%authenticator_list%&, and a complete list of all drivers with their option
3194 settings can be obtained by using &%routers%&, &%transports%&, or
3195 &%authenticators%&.
3196
3197 .cindex "environment"
3198 If &%environment%& is given as an argument, the set of environment
3199 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3200 variables.
3201
3202 .cindex "options" "macro &-- extracting"
3203 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3204 are available, similarly to the drivers.  Because macros are sometimes used
3205 for storing passwords, this option is restricted.
3206 The output format is one item per line.
3207 For the "-bP macro <name>" form, if no such macro is found
3208 the exit status will be nonzero.
3209
3210 .cmdopt -bp
3211 .cindex "queue" "listing messages in"
3212 .cindex "listing" "messages in the queue"
3213 This option requests a listing of the contents of the mail queue on the
3214 standard output. If the &%-bp%& option is followed by a list of message ids,
3215 just those messages are listed. By default, this option can be used only by an
3216 admin user. However, the &%queue_list_requires_admin%& option can be set false
3217 to allow any user to see the queue.
3218
3219 Each message in the queue is displayed as in the following example:
3220 .code
3221 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3222           red.king@looking-glass.fict.example
3223           <other addresses>
3224 .endd
3225 .cindex "message" "size in queue listing"
3226 .cindex "size" "of message"
3227 The first line contains the length of time the message has been in the queue
3228 (in this case 25 minutes), the size of the message (2.9K), the unique local
3229 identifier for the message, and the message sender, as contained in the
3230 envelope. For bounce messages, the sender address is empty, and appears as
3231 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3232 the default sender address, the user's login name is shown in parentheses
3233 before the sender address.
3234
3235 .cindex "frozen messages" "in queue listing"
3236 If the message is frozen (attempts to deliver it are suspended) then the text
3237 &"*** frozen ***"& is displayed at the end of this line.
3238
3239 The recipients of the message (taken from the envelope, not the headers) are
3240 displayed on subsequent lines. Those addresses to which the message has already
3241 been delivered are marked with the letter D. If an original address gets
3242 expanded into several addresses via an alias or forward file, the original is
3243 displayed with a D only when deliveries for all of its child addresses are
3244 complete.
3245
3246
3247 .cmdopt -bpa
3248 This option operates like &%-bp%&, but in addition it shows delivered addresses
3249 that were generated from the original top level address(es) in each message by
3250 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3251 of just &"D"&.
3252
3253
3254 .cmdopt -bpc
3255 .cindex "queue" "count of messages on"
3256 This option counts the number of messages in the queue, and writes the total
3257 to the standard output. It is restricted to admin users, unless
3258 &%queue_list_requires_admin%& is set false.
3259
3260
3261 .cmdopt -bpr
3262 This option operates like &%-bp%&, but the output is not sorted into
3263 chronological order of message arrival. This can speed it up when there are
3264 lots of messages in the queue, and is particularly useful if the output is
3265 going to be post-processed in a way that doesn't need the sorting.
3266
3267 .cmdopt -bpra
3268 This option is a combination of &%-bpr%& and &%-bpa%&.
3269
3270 .cmdopt -bpru
3271 This option is a combination of &%-bpr%& and &%-bpu%&.
3272
3273
3274 .cmdopt -bpu
3275 This option operates like &%-bp%& but shows only undelivered top-level
3276 addresses for each message displayed. Addresses generated by aliasing or
3277 forwarding are not shown, unless the message was deferred after processing by a
3278 router with the &%one_time%& option set.
3279
3280
3281 .cmdopt -brt
3282 .cindex "testing" "retry configuration"
3283 .cindex "retry" "configuration testing"
3284 This option is for testing retry rules, and it must be followed by up to three
3285 arguments. It causes Exim to look for a retry rule that matches the values
3286 and to write it to the standard output. For example:
3287 .code
3288 exim -brt bach.comp.mus.example
3289 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3290 .endd
3291 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3292 argument, which is required, can be a complete address in the form
3293 &'local_part@domain'&, or it can be just a domain name. If the second argument
3294 contains a dot, it is interpreted as an optional second domain name; if no
3295 retry rule is found for the first argument, the second is tried. This ties in
3296 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3297 rule is found that matches the host, one that matches the mail domain is
3298 sought. Finally, an argument that is the name of a specific delivery error, as
3299 used in setting up retry rules, can be given. For example:
3300 .code
3301 exim -brt haydn.comp.mus.example quota_3d
3302 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3303 .endd
3304
3305 .cmdopt -brw
3306 .cindex "testing" "rewriting"
3307 .cindex "rewriting" "testing"
3308 This option is for testing address rewriting rules, and it must be followed by
3309 a single argument, consisting of either a local part without a domain, or a
3310 complete address with a fully qualified domain. Exim outputs how this address
3311 would be rewritten for each possible place it might appear. See chapter
3312 &<<CHAPrewrite>>& for further details.
3313
3314 .cmdopt -bS
3315 .cindex "SMTP" "batched incoming"
3316 .cindex "batched SMTP input"
3317 This option is used for batched SMTP input, which is an alternative interface
3318 for non-interactive local message submission. A number of messages can be
3319 submitted in a single run. However, despite its name, this is not really SMTP
3320 input. Exim reads each message's envelope from SMTP commands on the standard
3321 input, but generates no responses. If the caller is trusted, or
3322 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3323 believed; otherwise the sender is always the caller of Exim.
3324
3325 The message itself is read from the standard input, in SMTP format (leading
3326 dots doubled), terminated by a line containing just a single dot. An error is
3327 provoked if the terminating dot is missing. A further message may then follow.
3328
3329 As for other local message submissions, the contents of incoming batch SMTP
3330 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3331 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3332 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3333
3334 Some other SMTP commands are recognized in the input. HELO and EHLO act
3335 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3336 QUIT quits, ignoring the rest of the standard input.
3337
3338 .cindex "return code" "for &%-bS%&"
3339 If any error is encountered, reports are written to the standard output and
3340 error streams, and Exim gives up immediately. The return code is 0 if no error
3341 was detected; it is 1 if one or more messages were accepted before the error
3342 was detected; otherwise it is 2.
3343
3344 More details of input using batched SMTP are given in section
3345 &<<SECTincomingbatchedSMTP>>&.
3346
3347 .cmdopt -bs
3348 .cindex "SMTP" "local input"
3349 .cindex "local SMTP input"
3350 This option causes Exim to accept one or more messages by reading SMTP commands
3351 on the standard input, and producing SMTP replies on the standard output. SMTP
3352 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3353 Some user agents use this interface as a way of passing locally-generated
3354 messages to the MTA.
3355
3356 In
3357 .cindex "sender" "source of"
3358 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3359 set, the senders of messages are taken from the SMTP MAIL commands.
3360 Otherwise the content of these commands is ignored and the sender is set up as
3361 the calling user. Unqualified addresses are automatically qualified using
3362 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3363 &%-bnq%& option is used.
3364
3365 .cindex "inetd"
3366 The
3367 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3368 using a listening daemon. Exim can distinguish the two cases by checking
3369 whether the standard input is a TCP/IP socket. When Exim is called from
3370 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3371 above concerning senders and qualification do not apply. In this situation,
3372 Exim behaves in exactly the same way as it does when receiving a message via
3373 the listening daemon.
3374
3375 .cmdopt -bt
3376 .cindex "testing" "addresses"
3377 .cindex "address" "testing"
3378 This option runs Exim in address testing mode, in which each argument is taken
3379 as a recipient address to be tested for deliverability. The results are
3380 written to the standard output. If a test fails, and the caller is not an admin
3381 user, no details of the failure are output, because these might contain
3382 sensitive information such as usernames and passwords for database lookups.
3383
3384 If no arguments are given, Exim runs in an interactive manner, prompting with a
3385 right angle bracket for addresses to be tested.
3386
3387 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3388 &[readline()]& function, because it is running as &'root'& and there are
3389 security issues.
3390
3391 Each address is handled as if it were the recipient address of a message
3392 (compare the &%-bv%& option). It is passed to the routers and the result is
3393 written to the standard output. However, any router that has
3394 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3395 genuine routing tests if your first router passes everything to a scanner
3396 program.
3397
3398 .cindex "return code" "for &%-bt%&"
3399 The return code is 2 if any address failed outright; it is 1 if no address
3400 failed outright but at least one could not be resolved for some reason. Return
3401 code 0 is given only when all addresses succeed.
3402
3403 .cindex "duplicate addresses"
3404 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3405 addresses after routing is complete, so that only one delivery takes place.
3406 This does not happen when testing with &%-bt%&; the full results of routing are
3407 always shown.
3408
3409 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3410 routers in the configuration makes any tests on the sender address of a
3411 message,
3412 .oindex "&%-f%&" "for address testing"
3413 you can use the &%-f%& option to set an appropriate sender when running
3414 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3415 default qualifying domain. However, if you have set up (for example) routers
3416 whose behaviour depends on the contents of an incoming message, you cannot test
3417 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3418 doing such tests.
3419
3420 .cmdopt -bV
3421 .cindex "version number of Exim"
3422 This option causes Exim to write the current version number, compilation
3423 number, and compilation date of the &'exim'& binary to the standard output.
3424 It also lists the DBM library that is being used, the optional modules (such as
3425 specific lookup types), the drivers that are included in the binary, and the
3426 name of the runtime configuration file that is in use.
3427
3428 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3429 configuration file. However, this is a static check only. It cannot check
3430 values that are to be expanded. For example, although a misspelt ACL verb is
3431 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3432 alone to discover (for example) all the typos in the configuration; some
3433 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3434 dynamic testing facilities.
3435
3436 .cmdopt -bv
3437 .cindex "verifying address" "using &%-bv%&"
3438 .cindex "address" "verification"
3439 This option runs Exim in address verification mode, in which each argument is
3440 taken as a recipient address to be verified by the routers. (This does
3441 not involve any verification callouts). During normal operation, verification
3442 happens mostly as a consequence processing a &%verify%& condition in an ACL
3443 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3444 including callouts, see the &%-bh%& and &%-bhc%& options.
3445
3446 If verification fails, and the caller is not an admin user, no details of the
3447 failure are output, because these might contain sensitive information such as
3448 usernames and passwords for database lookups.
3449
3450 If no arguments are given, Exim runs in an interactive manner, prompting with a
3451 right angle bracket for addresses to be verified.
3452
3453 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3454 &[readline()]& function, because it is running as &'exim'& and there are
3455 security issues.
3456
3457 Verification differs from address testing (the &%-bt%& option) in that routers
3458 that have &%no_verify%& set are skipped, and if the address is accepted by a
3459 router that has &%fail_verify%& set, verification fails. The address is
3460 verified as a recipient if &%-bv%& is used; to test verification for a sender
3461 address, &%-bvs%& should be used.
3462
3463 If the &%-v%& option is not set, the output consists of a single line for each
3464 address, stating whether it was verified or not, and giving a reason in the
3465 latter case. Without &%-v%&, generating more than one address by redirection
3466 causes verification to end successfully, without considering the generated
3467 addresses. However, if just one address is generated, processing continues,
3468 and the generated address must verify successfully for the overall verification
3469 to succeed.
3470
3471 When &%-v%& is set, more details are given of how the address has been handled,
3472 and in the case of address redirection, all the generated addresses are also
3473 considered. Verification may succeed for some and fail for others.
3474
3475 The
3476 .cindex "return code" "for &%-bv%&"
3477 return code is 2 if any address failed outright; it is 1 if no address
3478 failed outright but at least one could not be resolved for some reason. Return
3479 code 0 is given only when all addresses succeed.
3480
3481 If any of the routers in the configuration makes any tests on the sender
3482 address of a message, you should use the &%-f%& option to set an appropriate
3483 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3484 calling user at the default qualifying domain.
3485
3486 .cmdopt -bvs
3487 This option acts like &%-bv%&, but verifies the address as a sender rather
3488 than a recipient address. This affects any rewriting and qualification that
3489 might happen.
3490
3491 .cmdopt -bw
3492 .cindex "daemon"
3493 .cindex "inetd"
3494 .cindex "inetd" "wait mode"
3495 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3496 similarly to the &%-bd%& option.  All port specifications on the command-line
3497 and in the configuration file are ignored.  Queue-running may not be specified.
3498
3499 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3500 listening for connections.  This permits the system to start up and have
3501 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3502 each port only when the first connection is received.
3503
3504 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3505 which the daemon will exit, which should cause inetd to listen once more.
3506
3507 .cmdopt -C <&'filelist'&>
3508 .cindex "configuration file" "alternate"
3509 .cindex "CONFIGURE_FILE"
3510 .cindex "alternate configuration file"
3511 This option causes Exim to find the runtime configuration file from the given
3512 list instead of from the list specified by the CONFIGURE_FILE
3513 compile-time setting. Usually, the list will consist of just a single filename,
3514 but it can be a colon-separated list of names. In this case, the first
3515 file that exists is used. Failure to open an existing file stops Exim from
3516 proceeding any further along the list, and an error is generated.
3517
3518 When this option is used by a caller other than root, and the list is different
3519 from the compiled-in list, Exim gives up its root privilege immediately, and
3520 runs with the real and effective uid and gid set to those of the caller.
3521 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3522 file contains a list of full pathnames, one per line, for configuration files
3523 which are trusted. Root privilege is retained for any configuration file so
3524 listed, as long as the caller is the Exim user (or the user specified in the
3525 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3526 not writeable by inappropriate users or groups.
3527
3528 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3529 configuration using &%-C%& right through message reception and delivery,
3530 even if the caller is root. The reception works, but by that time, Exim is
3531 running as the Exim user, so when it re-executes to regain privilege for the
3532 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3533 test reception and delivery using two separate commands (one to put a message
3534 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3535
3536 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3537 prefix string with which any file named in a &%-C%& command line option
3538 must start. In addition, the filename must not contain the sequence &`/../`&.
3539 However, if the value of the &%-C%& option is identical to the value of
3540 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3541 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3542 unset, any filename can be used with &%-C%&.
3543
3544 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3545 to a directory to which only root has access. This prevents someone who has
3546 broken into the Exim account from running a privileged Exim with an arbitrary
3547 configuration file.
3548
3549 The &%-C%& facility is useful for ensuring that configuration files are
3550 syntactically correct, but cannot be used for test deliveries, unless the
3551 caller is privileged, or unless it is an exotic configuration that does not
3552 require privilege. No check is made on the owner or group of the files
3553 specified by this option.
3554
3555
3556 .vitem &%-D%&<&'macro'&>=<&'value'&>
3557 .oindex "&%-D%&"
3558 .cindex "macro" "setting on command line"
3559 This option can be used to override macro definitions in the configuration file
3560 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3561 unprivileged caller, it causes Exim to give up its root privilege.
3562 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3563 completely disabled, and its use causes an immediate error exit.
3564
3565 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3566 colon-separated list of macros which are considered safe and, if &%-D%& only
3567 supplies macros from this list, and the values are acceptable, then Exim will
3568 not give up root privilege if the caller is root, the Exim run-time user, or
3569 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3570 to be removed in the future.  Acceptable values for the macros satisfy the
3571 regexp: &`^[A-Za-z0-9_/.-]*$`&
3572
3573 The entire option (including equals sign if present) must all be within one
3574 command line item. &%-D%& can be used to set the value of a macro to the empty
3575 string, in which case the equals sign is optional. These two commands are
3576 synonymous:
3577 .code
3578 exim -DABC  ...
3579 exim -DABC= ...
3580 .endd
3581 To include spaces in a macro definition item, quotes must be used. If you use
3582 quotes, spaces are permitted around the macro name and the equals sign. For
3583 example:
3584 .code
3585 exim '-D ABC = something' ...
3586 .endd
3587 &%-D%& may be repeated up to 10 times on a command line.
3588 Only macro names up to 22 letters long can be set.
3589
3590
3591 .vitem &%-d%&<&'debug&~options'&>
3592 .oindex "&%-d%&"
3593 .cindex "debugging" "list of selectors"
3594 .cindex "debugging" "&%-d%& option"
3595 This option causes debugging information to be written to the standard
3596 error stream. It is restricted to admin users because debugging output may show
3597 database queries that contain password information. Also, the details of users'
3598 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3599 writes an error message to the standard error stream and exits with a non-zero
3600 return code.
3601
3602 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3603 standard debugging data is output. This can be reduced, or increased to include
3604 some more rarely needed information, by directly following &%-d%& with a string
3605 made up of names preceded by plus or minus characters. These add or remove sets
3606 of debugging data, respectively. For example, &%-d+filter%& adds filter
3607 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3608 no spaces are allowed in the debug setting. The available debugging categories
3609 are:
3610 .itable none 0 0 2 20* left 80* left
3611 .irow acl            "ACL interpretation"
3612 .irow auth           "authenticators"
3613 .irow deliver        "general delivery logic"
3614 .irow dns            "DNS lookups (see also resolver)"
3615 .irow dnsbl          "DNS black list (aka RBL) code"
3616 .irow exec           "arguments for &[execv()]& calls"
3617 .irow expand         "detailed debugging for string expansions"
3618 .irow filter         "filter handling"
3619 .irow hints_lookup   "hints data lookups"
3620 .irow host_lookup    "all types of name-to-IP address handling"
3621 .irow ident          "ident lookup"
3622 .irow interface      "lists of local interfaces"
3623 .irow lists          "matching things in lists"
3624 .irow load           "system load checks"
3625 .irow local_scan     "can be used by &[local_scan()]& (see chapter &&&
3626                     &<<CHAPlocalscan>>&)"
3627 .irow lookup         "general lookup code and all lookups"
3628 .irow memory         "memory handling"
3629 .irow noutf8         "modifier: avoid UTF-8 line-drawing"
3630 .irow pid            "modifier: add pid to debug output lines"
3631 .irow process_info   "setting info for the process log"
3632 .irow queue_run      "queue runs"
3633 .irow receive        "general message reception logic"
3634 .irow resolver       "turn on the DNS resolver's debugging output"
3635 .irow retry          "retry handling"
3636 .irow rewrite        "address rewriting""
3637 .irow route          "address routing"
3638 .irow timestamp      "modifier: add timestamp to debug output lines"
3639 .irow tls            "TLS logic"
3640 .irow transport      "transports"
3641 .irow uid            "changes of uid/gid and looking up uid/gid"
3642 .irow verify         "address verification logic"
3643 .irow all            "almost all of the above (see below), and also &%-v%&"
3644 .endtable
3645 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3646 for &`-all`&. The reason for this is that &`+all`& is something that people
3647 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3648 is included, an awful lot of output that is very rarely of interest is
3649 generated, so it now has to be explicitly requested. However, &`-all`& does
3650 turn everything off.
3651
3652 .cindex "resolver, debugging output"
3653 .cindex "DNS resolver, debugging output"
3654 The &`resolver`& option produces output only if the DNS resolver was compiled
3655 with DEBUG enabled. This is not the case in some operating systems. Also,
3656 unfortunately, debugging output from the DNS resolver is written to stdout
3657 rather than stderr.
3658
3659 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3660 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3661 However, the &`pid`& selector is forced when debugging is turned on for a
3662 daemon, which then passes it on to any re-executed Exims. Exim also
3663 automatically adds the pid to debug lines when several remote deliveries are
3664 run in parallel.
3665
3666 The &`timestamp`& selector causes the current time to be inserted at the start
3667 of all debug output lines. This can be useful when trying to track down delays
3668 in processing.
3669
3670 .cindex debugging "UTF-8 in"
3671 .cindex UTF-8 "in debug output"
3672 The &`noutf8`& selector disables the use of
3673 UTF-8 line-drawing characters to group related information.
3674 When disabled. ascii-art is used instead.
3675 Using the &`+all`& option does not set this modifier,
3676
3677 If the &%debug_print%& option is set in any driver, it produces output whenever
3678 any debugging is selected, or if &%-v%& is used.
3679
3680 .vitem &%-dd%&<&'debug&~options'&>
3681 .oindex "&%-dd%&"
3682 This option behaves exactly like &%-d%& except when used on a command that
3683 starts a daemon process. In that case, debugging is turned off for the
3684 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3685 behaviour of the daemon without creating as much output as full debugging does.
3686
3687 .cmdopt -dropcr
3688 This is an obsolete option that is now a no-op. It used to affect the way Exim
3689 handled CR and LF characters in incoming messages. What happens now is
3690 described in section &<<SECTlineendings>>&.
3691
3692 .cmdopt -E
3693 .cindex "bounce message" "generating"
3694 This option specifies that an incoming message is a locally-generated delivery
3695 failure report. It is used internally by Exim when handling delivery failures
3696 and is not intended for external use. Its only effect is to stop Exim
3697 generating certain messages to the postmaster, as otherwise message cascades
3698 could occur in some situations. As part of the same option, a message id may
3699 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3700 new message contains the id, following &"R="&, as a cross-reference.
3701
3702 .vitem &%-e%&&'x'&
3703 .oindex "&%-e%&&'x'&"
3704 There are a number of Sendmail options starting with &%-oe%& which seem to be
3705 called by various programs without the leading &%o%& in the option. For
3706 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3707 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3708
3709 .cmdopt -F <&'string'&>
3710 .cindex "sender" "name"
3711 .cindex "name" "of sender"
3712 This option sets the sender's full name for use when a locally-generated
3713 message is being accepted. In the absence of this option, the user's &'gecos'&
3714 entry from the password data is used. As users are generally permitted to alter
3715 their &'gecos'& entries, no security considerations are involved. White space
3716 between &%-F%& and the <&'string'&> is optional.
3717
3718 .cmdopt -f <&'address'&>
3719 .cindex "sender" "address"
3720 .cindex "address" "sender"
3721 .cindex "trusted users"
3722 .cindex "envelope from"
3723 .cindex "envelope sender"
3724 .cindex "user" "trusted"
3725 This option sets the address of the envelope sender of a locally-generated
3726 message (also known as the return path). The option can normally be used only
3727 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3728 users to use it.
3729
3730 Processes running as root or the Exim user are always trusted. Other
3731 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3732 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3733 of a local message is set to the caller's login name at the default qualify
3734 domain.
3735
3736 There is one exception to the restriction on the use of &%-f%&: an empty sender
3737 can be specified by any user, trusted or not, to create a message that can
3738 never provoke a bounce. An empty sender can be specified either as an empty
3739 string, or as a pair of angle brackets with nothing between them, as in these
3740 examples of shell commands:
3741 .code
3742 exim -f '<>' user@domain
3743 exim -f "" user@domain
3744 .endd
3745 In addition, the use of &%-f%& is not restricted when testing a filter file
3746 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3747 &%-bv%& options.
3748
3749 Allowing untrusted users to change the sender address does not of itself make
3750 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3751 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3752 though this can be overridden by setting &%no_local_from_check%&.
3753
3754 White
3755 .cindex "&""From""& line"
3756 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3757 given as two arguments or one combined argument). The sender of a
3758 locally-generated message can also be set (when permitted) by an initial
3759 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3760 if &%-f%& is also present, it overrides &"From&~"&.
3761
3762 .cmdopt -G
3763 .cindex "submission fixups, suppressing (command-line)"
3764 This option is equivalent to an ACL applying:
3765 .code
3766 control = suppress_local_fixups
3767 .endd
3768 for every message received.  Note that Sendmail will complain about such
3769 bad formatting, where Exim silently just does not fix it up.  This may change
3770 in future.
3771
3772 As this affects audit information, the caller must be a trusted user to use
3773 this option.
3774
3775 .cmdopt -h <&'number'&>
3776 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3777 This option is accepted for compatibility with Sendmail, but has no effect. (In
3778 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3779 headers.)
3780
3781 .cmdopt -i
3782 .cindex "Solaris" "&'mail'& command"
3783 .cindex "dot" "in incoming non-SMTP message"
3784 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3785 line by itself should not terminate an incoming, non-SMTP message.
3786 Solaris 2.4 (SunOS 5.4) Sendmail has a similar &%-i%& processing option
3787 &url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf),
3788 p. 1M-529), and therefore a &%-oi%& command line option, which both are used
3789 by its &'mailx'& command.
3790
3791 .cmdopt -L <&'tag'&>
3792 .cindex "syslog" "process name; set with flag"
3793 This option is equivalent to setting &%syslog_processname%& in the config
3794 file and setting &%log_file_path%& to &`syslog`&.
3795 Its use is restricted to administrators.  The configuration file has to be
3796 read and parsed, to determine access rights, before this is set and takes
3797 effect, so early configuration file errors will not honour this flag.
3798
3799 The tag should not be longer than 32 characters.
3800
3801 .cmdopt -M <&'message&~id'&>&~<&'message&~id'&>&~...
3802 .cindex "forcing delivery"
3803 .cindex "delivery" "forcing attempt"
3804 .cindex "frozen messages" "forcing delivery"
3805 This option requests Exim to run a delivery attempt on each message in turn. If
3806 any of the messages are frozen, they are automatically thawed before the
3807 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3808 and &%hold_domains%& are ignored.
3809
3810 Retry
3811 .cindex "hints database" "overriding retry hints"
3812 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3813 the normal retry time has not yet been reached. This option requires the caller
3814 to be an admin user. However, there is an option called &%prod_requires_admin%&
3815 which can be set false to relax this restriction (and also the same requirement
3816 for the &%-q%&, &%-R%&, and &%-S%& options).
3817
3818 The deliveries happen synchronously, that is, the original Exim process does
3819 not terminate until all the delivery attempts have finished. No output is
3820 produced unless there is a serious error. If you want to see what is happening,
3821 use the &%-v%& option as well, or inspect Exim's main log.
3822
3823 .cmdopt -Mar <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3824 .cindex "message" "adding recipients"
3825 .cindex "recipient" "adding"
3826 This option requests Exim to add the addresses to the list of recipients of the
3827 message (&"ar"& for &"add recipients"&). The first argument must be a message
3828 id, and the remaining ones must be email addresses. However, if the message is
3829 active (in the middle of a delivery attempt), it is not altered. This option
3830 can be used only by an admin user.
3831
3832 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&&&
3833         &~<&'host&~IP'&>&&&
3834         &~<&'sequence&~number'&>&&&
3835         &~<&'message&~id'&>"
3836 .oindex "&%-MC%&"
3837 .cindex "SMTP" "passed connection"
3838 .cindex "SMTP" "multiple deliveries"
3839 .cindex "multiple SMTP deliveries"
3840 This option is not intended for use by external callers. It is used internally
3841 by Exim to invoke another instance of itself to deliver a waiting message using
3842 an existing SMTP connection, which is passed as the standard input. Details are
3843 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3844 must be root or the Exim user in order to use it.
3845
3846 .cmdopt -MCA
3847 This option is not intended for use by external callers. It is used internally
3848 by Exim in conjunction with the &%-MC%& option. It signifies that the
3849 connection to the remote host has been authenticated.
3850
3851 .cmdopt -MCD
3852 This option is not intended for use by external callers. It is used internally
3853 by Exim in conjunction with the &%-MC%& option. It signifies that the
3854 remote host supports the ESMTP &_DSN_& extension.
3855
3856 .cmdopt -MCd
3857 This option is not intended for use by external callers. It is used internally
3858 by Exim in conjunction with the &%-d%& option
3859 to pass on an information string on the purpose of the process.
3860
3861 .cmdopt -MCG <&'queue&~name'&>
3862 This option is not intended for use by external callers. It is used internally
3863 by Exim in conjunction with the &%-MC%& option. It signifies that an
3864 alternate queue is used, named by the following argument.
3865
3866 .cmdopt -MCK
3867 This option is not intended for use by external callers. It is used internally
3868 by Exim in conjunction with the &%-MC%& option. It signifies that a
3869 remote host supports the ESMTP &_CHUNKING_& extension.
3870
3871 .cmdopt -MCL
3872 This option is not intended for use by external callers. It is used internally
3873 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3874 which Exim is connected advertised limits on numbers of mails, recipients or
3875 recipient domains.
3876 The limits are given by the following three arguments.
3877
3878 .cmdopt -MCP
3879 This option is not intended for use by external callers. It is used internally
3880 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3881 which Exim is connected supports pipelining.
3882
3883 .cmdopt -MCp
3884 This option is not intended for use by external callers. It is used internally
3885 by Exim in conjunction with the &%-MC%& option. It signifies that the connection
3886 t a remote server is via a SOCKS proxy, using addresses and ports given by
3887 the following four arguments.
3888
3889 .cmdopt -MCQ <&'process&~id'&>&~<&'pipe&~fd'&>
3890 This option is not intended for use by external callers. It is used internally
3891 by Exim in conjunction with the &%-MC%& option when the original delivery was
3892 started by a queue runner. It passes on the process id of the queue runner,
3893 together with the file descriptor number of an open pipe. Closure of the pipe
3894 signals the final completion of the sequence of processes that are passing
3895 messages through the same SMTP connection.
3896
3897 .cmdopt -MCq <&'recipient&~address'&>&~<&'size'&>
3898 This option is not intended for use by external callers. It is used internally
3899 by Exim to implement quota checking for local users.
3900
3901 .cmdopt -MCS
3902 This option is not intended for use by external callers. It is used internally
3903 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3904 ESMTP SIZE option should be used on messages delivered down the existing
3905 connection.
3906
3907 .cmdopt -MCT
3908 This option is not intended for use by external callers. It is used internally
3909 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3910 host to which Exim is connected supports TLS encryption.
3911
3912 .vitem &%-MCr%&&~<&'SNI'&> &&&
3913        &%-MCs%&&~<&'SNI'&>
3914 .oindex "&%-MCs%&"
3915 .oindex "&%-MCr%&"
3916 These options are not intended for use by external callers. It is used internally
3917 by Exim in conjunction with the &%-MCt%& option, and passes on the fact that
3918 a TLS Server Name Indication was sent as part of the channel establishment.
3919 The argument gives the SNI string.
3920 The "r" variant indicates a DANE-verified connection.
3921
3922 .cmdopt -MCt <&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3923 This option is not intended for use by external callers. It is used internally
3924 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3925 connection is being proxied by a parent process for handling TLS encryption.
3926 The arguments give the local address and port being proxied, and the TLS cipher.
3927
3928 .cmdopt -Mc <&'message&~id'&>&~<&'message&~id'&>&~...
3929 .cindex "hints database" "not overridden by &%-Mc%&"
3930 .cindex "delivery" "manually started &-- not forced"
3931 This option requests Exim to run a delivery attempt on each message, in turn,
3932 but unlike the &%-M%& option, it does check for retry hints, and respects any
3933 that are found. This option is not very useful to external callers. It is
3934 provided mainly for internal use by Exim when it needs to re-invoke itself in
3935 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3936 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3937 respects retry times and other options such as &%hold_domains%& that are
3938 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3939 If you want to run a specific delivery as if in a queue run, you should use
3940 &%-q%& with a message id argument. A distinction between queue run deliveries
3941 and other deliveries is made in one or two places.
3942
3943 .cmdopt -Mes <&'message&~id'&>&~<&'address'&>
3944 .cindex "message" "changing sender"
3945 .cindex "sender" "changing"
3946 This option requests Exim to change the sender address in the message to the
3947 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3948 &"edit sender"&). There must be exactly two arguments. The first argument must
3949 be a message id, and the second one an email address. However, if the message
3950 is active (in the middle of a delivery attempt), its status is not altered.
3951 This option can be used only by an admin user.
3952
3953 .cmdopt -Mf <&'message&~id'&>&~<&'message&~id'&>&~...
3954 .cindex "freezing messages"
3955 .cindex "message" "manually freezing"
3956 This option requests Exim to mark each listed message as &"frozen"&. This
3957 prevents any delivery attempts taking place until the message is &"thawed"&,
3958 either manually or as a result of the &%auto_thaw%& configuration option.
3959 However, if any of the messages are active (in the middle of a delivery
3960 attempt), their status is not altered. This option can be used only by an admin
3961 user.
3962
3963 .cmdopt -Mg <&'message&~id'&>&~<&'message&~id'&>&~...
3964 .cindex "giving up on messages"
3965 .cindex "message" "abandoning delivery attempts"
3966 .cindex "delivery" "abandoning further attempts"
3967 This option requests Exim to give up trying to deliver the listed messages,
3968 including any that are frozen. However, if any of the messages are active,
3969 their status is not altered. For non-bounce messages, a delivery error message
3970 is sent to the sender, containing the text &"cancelled by administrator"&.
3971 Bounce messages are just discarded. This option can be used only by an admin
3972 user.
3973
3974 .cmdopt -MG <&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3975 .cindex queue named
3976 .cindex "named queues" "moving messages"
3977 .cindex "queue" "moving messages"
3978 This option requests that each listed message be moved from its current
3979 queue to the given named queue.
3980 The destination queue name argument is required, but can be an empty
3981 string to define the default queue.
3982 If the messages are not currently located in the default queue,
3983 a &%-qG<name>%& option will be required to define the source queue.
3984
3985 .cmdopt -Mmad <&'message&~id'&>&~<&'message&~id'&>&~...
3986 .cindex "delivery" "cancelling all"
3987 This option requests Exim to mark all the recipient addresses in the messages
3988 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3989 message is active (in the middle of a delivery attempt), its status is not
3990 altered. This option can be used only by an admin user.
3991
3992 .cmdopt -Mmd <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3993 .cindex "delivery" "cancelling by address"
3994 .cindex "recipient" "removing"
3995 .cindex "removing recipients"
3996 This option requests Exim to mark the given addresses as already delivered
3997 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3998 the remaining ones must be email addresses. These are matched to recipient
3999 addresses in the message in a case-sensitive manner. If the message is active
4000 (in the middle of a delivery attempt), its status is not altered. This option
4001 can be used only by an admin user.
4002
4003 .cmdopt -Mrm <&'message&~id'&>&~<&'message&~id'&>&~...
4004 .cindex "removing messages"
4005 .cindex "abandoning mail"
4006 .cindex "message" "manually discarding"
4007 This option requests Exim to remove the given messages from the queue. No
4008 bounce messages are sent; each message is simply forgotten. However, if any of
4009 the messages are active, their status is not altered. This option can be used
4010 only by an admin user or by the user who originally caused the message to be
4011 placed in the queue.
4012
4013 . .new
4014 . .vitem &%-MS%&
4015 . .oindex "&%-MS%&"
4016 . .cindex REQUIRETLS
4017 . This option is used to request REQUIRETLS processing on the message.
4018 . It is used internally by Exim in conjunction with -E when generating
4019 . a bounce message.
4020 . .wen
4021
4022 .cmdopt -Mset <&'message&~id'&>
4023 .cindex "testing" "string expansion"
4024 .cindex "expansion" "testing"
4025 This option is useful only in conjunction with &%-be%& (that is, when testing
4026 string expansions). Exim loads the given message from its spool before doing
4027 the test expansions, thus setting message-specific variables such as
4028 &$message_size$& and the header variables. The &$recipients$& variable is made
4029 available. This feature is provided to make it easier to test expansions that
4030 make use of these variables. However, this option can be used only by an admin
4031 user. See also &%-bem%&.
4032
4033 .cmdopt -Mt <&'message&~id'&>&~<&'message&~id'&>&~...
4034 .cindex "thawing messages"
4035 .cindex "unfreezing messages"
4036 .cindex "frozen messages" "thawing"
4037 .cindex "message" "thawing frozen"
4038 This option requests Exim to &"thaw"& any of the listed messages that are
4039 &"frozen"&, so that delivery attempts can resume. However, if any of the
4040 messages are active, their status is not altered. This option can be used only
4041 by an admin user.
4042
4043 .cmdopt -Mvb <&'message&~id'&>
4044 .cindex "listing" "message body"
4045 .cindex "message" "listing body of"
4046 This option causes the contents of the message body (-D) spool file to be
4047 written to the standard output. This option can be used only by an admin user.
4048
4049 .cmdopt -Mvc <&'message&~id'&>
4050 .cindex "message" "listing in RFC 2822 format"
4051 .cindex "listing" "message in RFC 2822 format"
4052 This option causes a copy of the complete message (header lines plus body) to
4053 be written to the standard output in RFC 2822 format. This option can be used
4054 only by an admin user.
4055
4056 .cmdopt -Mvh <&'message&~id'&>
4057 .cindex "listing" "message headers"
4058 .cindex "header lines" "listing"
4059 .cindex "message" "listing header lines"
4060 This option causes the contents of the message headers (-H) spool file to be
4061 written to the standard output. This option can be used only by an admin user.
4062
4063 .cmdopt -Mvl <&'message&~id'&>
4064 .cindex "listing" "message log"
4065 .cindex "message" "listing message log"
4066 This option causes the contents of the message log spool file to be written to
4067 the standard output. This option can be used only by an admin user.
4068
4069 .cmdopt -m
4070 This is a synonym for &%-om%& that is accepted by Sendmail
4071 (&url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf)
4072 p. 1M-258), so Exim treats it that way too.
4073
4074 .cmdopt -N
4075 .cindex "debugging" "&%-N%& option"
4076 .cindex "debugging" "suppressing delivery"
4077 This is a debugging option that inhibits delivery of a message at the transport
4078 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4079 it just doesn't actually transport the message, but instead behaves as if it
4080 had successfully done so. However, it does not make any updates to the retry
4081 database, and the log entries for deliveries are flagged with &"*>"& rather
4082 than &"=>"&.
4083
4084 Because &%-N%& discards any message to which it applies, only root or the Exim
4085 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4086 words, an ordinary user can use it only when supplying an incoming message to
4087 which it will apply. Although transportation never fails when &%-N%& is set, an
4088 address may be deferred because of a configuration problem on a transport, or a
4089 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4090 the message, and applies to any subsequent delivery attempts that may happen
4091 for that message.
4092
4093 .cmdopt -n
4094 This option is interpreted by Sendmail to mean &"no aliasing"&.
4095 For normal modes of operation, it is ignored by Exim.
4096 When combined with &%-bP%& it makes the output more terse (suppresses
4097 option names, environment values and config pretty printing).
4098
4099 .cmdopt -O <&'data'&>
4100 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4101 Exim.
4102
4103 .cmdopt -oA <&'file&~name'&>
4104 .cindex "Sendmail compatibility" "&%-oA%& option"
4105 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4106 alternative alias filename. Exim handles &%-bi%& differently; see the
4107 description above.
4108
4109 .cmdopt -oB <&'n'&>
4110 .cindex "SMTP" "passed connection"
4111 .cindex "SMTP" "multiple deliveries"
4112 .cindex "multiple SMTP deliveries"
4113 This is a debugging option which limits the maximum number of messages that can
4114 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4115 transport. If <&'n'&> is omitted, the limit is set to 1.
4116
4117 .cmdopt -odb
4118 .cindex "background delivery"
4119 .cindex "delivery" "in the background"
4120 This option applies to all modes in which Exim accepts incoming messages,
4121 including the listening daemon. It requests &"background"& delivery of such
4122 messages, which means that the accepting process automatically starts a
4123 delivery process for each message received, but does not wait for the delivery
4124 processes to finish.
4125
4126 When all the messages have been received, the reception process exits,
4127 leaving the delivery processes to finish in their own time. The standard output
4128 and error streams are closed at the start of each delivery process.
4129 This is the default action if none of the &%-od%& options are present.
4130
4131 If one of the queueing options in the configuration file
4132 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4133 overrides it if &%queue_only_override%& is set true, which is the default
4134 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4135
4136 .cmdopt -odf
4137 .cindex "foreground delivery"
4138 .cindex "delivery" "in the foreground"
4139 This option requests &"foreground"& (synchronous) delivery when Exim has
4140 accepted a locally-generated message. (For the daemon it is exactly the same as
4141 &%-odb%&.) A delivery process is automatically started to deliver the message,
4142 and Exim waits for it to complete before proceeding.
4143
4144 The original Exim reception process does not finish until the delivery
4145 process for the final message has ended. The standard error stream is left open
4146 during deliveries.
4147
4148 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4149 false and one of the queueing options in the configuration file is in effect.
4150
4151 If there is a temporary delivery error during foreground delivery, the
4152 message is left in the queue for later delivery, and the original reception
4153 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4154 restricted configuration that never queues messages.
4155
4156
4157 .cmdopt -odi
4158 This option is synonymous with &%-odf%&. It is provided for compatibility with
4159 Sendmail.
4160
4161 .cmdopt -odq
4162 .cindex "non-immediate delivery"
4163 .cindex "delivery" "suppressing immediate"
4164 .cindex "queueing incoming messages"
4165 This option applies to all modes in which Exim accepts incoming messages,
4166 including the listening daemon. It specifies that the accepting process should
4167 not automatically start a delivery process for each message received. Messages
4168 are placed in the queue, and remain there until a subsequent queue runner
4169 process encounters them. There are several configuration options (such as
4170 &%queue_only%&) that can be used to queue incoming messages under certain
4171 conditions. This option overrides all of them and also &%-odqs%&. It always
4172 forces queueing.
4173
4174 .cmdopt -odqs
4175 .cindex "SMTP" "delaying delivery"
4176 .cindex "first pass routing"
4177 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4178 However, like &%-odb%& and &%-odi%&, this option has no effect if
4179 &%queue_only_override%& is false and one of the queueing options in the
4180 configuration file is in effect.
4181
4182 When &%-odqs%& does operate, a delivery process is started for each incoming
4183 message, in the background by default, but in the foreground if &%-odi%& is
4184 also present. The recipient addresses are routed, and local deliveries are done
4185 in the normal way. However, if any SMTP deliveries are required, they are not
4186 done at this time, so the message remains in the queue until a subsequent queue
4187 runner process encounters it. Because routing was done, Exim knows which
4188 messages are waiting for which hosts, and so a number of messages for the same
4189 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4190 configuration option has the same effect for specific domains. See also the
4191 &%-qq%& option.
4192
4193 .cmdopt -oee
4194 .cindex "error" "reporting"
4195 If an error is detected while a non-SMTP message is being received (for
4196 example, a malformed address), the error is reported to the sender in a mail
4197 message.
4198
4199 .cindex "return code" "for &%-oee%&"
4200 Provided
4201 this error message is successfully sent, the Exim receiving process
4202 exits with a return code of zero. If not, the return code is 2 if the problem
4203 is that the original message has no recipients, or 1 for any other error.
4204 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4205
4206 .cmdopt -oem
4207 .cindex "error" "reporting"
4208 .cindex "return code" "for &%-oem%&"
4209 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4210 return code, whether or not the error message was successfully sent.
4211 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4212
4213 .cmdopt -oep
4214 .cindex "error" "reporting"
4215 If an error is detected while a non-SMTP message is being received, the
4216 error is reported by writing a message to the standard error file (stderr).
4217 .cindex "return code" "for &%-oep%&"
4218 The return code is 1 for all errors.
4219
4220 .cmdopt -oeq
4221 .cindex "error" "reporting"
4222 This option is supported for compatibility with Sendmail, but has the same
4223 effect as &%-oep%&.
4224
4225 .cmdopt -oew
4226 .cindex "error" "reporting"
4227 This option is supported for compatibility with Sendmail, but has the same
4228 effect as &%-oem%&.
4229
4230 .cmdopt -oi
4231 .cindex "dot" "in incoming non-SMTP message"
4232 This option, which has the same effect as &%-i%&, specifies that a dot on a
4233 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4234 single dot does terminate, though Exim does no special processing for other
4235 lines that start with a dot. This option is set by default if Exim is called as
4236 &'rmail'&. See also &%-ti%&.
4237
4238 .cmdopt -oitrue
4239 This option is treated as synonymous with &%-oi%&.
4240
4241 .cmdopt -oMa <&'host&~address'&>
4242 .cindex "sender" "host address, specifying for local message"
4243 A number of options starting with &%-oM%& can be used to set values associated
4244 with remote hosts on locally-submitted messages (that is, messages not received
4245 over TCP/IP). These options can be used by any caller in conjunction with the
4246 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4247 other circumstances, they are ignored unless the caller is trusted.
4248
4249 The &%-oMa%& option sets the sender host address. This may include a port
4250 number at the end, after a full stop (period). For example:
4251 .code
4252 exim -bs -oMa 10.9.8.7.1234
4253 .endd
4254 An alternative syntax is to enclose the IP address in square brackets,
4255 followed by a colon and the port number:
4256 .code
4257 exim -bs -oMa [10.9.8.7]:1234
4258 .endd
4259 The IP address is placed in the &$sender_host_address$& variable, and the
4260 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4261 are present on the command line, the sender host IP address is taken from
4262 whichever one is last.
4263
4264 .cmdopt -oMaa <&'name'&>
4265 .cindex "authentication" "name, specifying for local message"
4266 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4267 option sets the value of &$sender_host_authenticated$& (the authenticator
4268 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4269 This option can be used with &%-bh%& and &%-bs%& to set up an
4270 authenticated SMTP session without actually using the SMTP AUTH command.
4271
4272 .cmdopt -oMai <&'string'&>
4273 .cindex "authentication" "id, specifying for local message"
4274 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4275 option sets the value of &$authenticated_id$& (the id that was authenticated).
4276 This overrides the default value (the caller's login id, except with &%-bh%&,
4277 where there is no default) for messages from local sources. See chapter
4278 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4279
4280 .cmdopt -oMas <&'address'&>
4281 .cindex "authentication" "sender, specifying for local message"
4282 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4283 option sets the authenticated sender value in &$authenticated_sender$&. It
4284 overrides the sender address that is created from the caller's login id for
4285 messages from local sources, except when &%-bh%& is used, when there is no
4286 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4287 specified on a MAIL command overrides this value. See chapter
4288 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4289
4290 .cmdopt -oMi <&'interface&~address'&>
4291 .cindex "interface" "address, specifying for local message"
4292 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4293 option sets the IP interface address value. A port number may be included,
4294 using the same syntax as for &%-oMa%&. The interface address is placed in
4295 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4296
4297 .cmdopt -oMm <&'message&~reference'&>
4298 .cindex "message reference" "message reference, specifying for local message"
4299 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4300 option sets the message reference, e.g. message-id, and is logged during
4301 delivery. This is useful when some kind of audit trail is required to tie
4302 messages together. The format of the message reference is checked and will
4303 abort if the format is invalid. The option will only be accepted if exim is
4304 running in trusted mode, not as any regular user.
4305
4306 The best example of a message reference is when Exim sends a bounce message.
4307 The message reference is the message-id of the original message for which Exim
4308 is sending the bounce.
4309
4310 .cmdopt -oMr <&'protocol&~name'&>
4311 .cindex "protocol, specifying for local message"
4312 .vindex "&$received_protocol$&"
4313 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4314 option sets the received protocol value that is stored in
4315 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4316 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4317 SMTP protocol names (see the description of &$received_protocol$& in section
4318 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4319 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4320 be set by &%-oMr%&. Repeated use of this option is not supported.
4321
4322 .cmdopt -oMs <&'host&~name'&>
4323 .cindex "sender" "host name, specifying for local message"
4324 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4325 option sets the sender host name in &$sender_host_name$&. When this option is
4326 present, Exim does not attempt to look up a host name from an IP address; it
4327 uses the name it is given.
4328
4329 .cmdopt -oMt <&'ident&~string'&>
4330 .cindex "sender" "ident string, specifying for local message"
4331 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4332 option sets the sender ident value in &$sender_ident$&. The default setting for
4333 local callers is the login id of the calling process, except when &%-bh%& is
4334 used, when there is no default.
4335
4336 .cmdopt -om
4337 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4338 In Sendmail, this option means &"me too"&, indicating that the sender of a
4339 message should receive a copy of the message if the sender appears in an alias
4340 expansion. Exim always does this, so the option does nothing.
4341
4342 .cmdopt -oo
4343 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4344 This option is ignored. In Sendmail it specifies &"old style headers"&,
4345 whatever that means.
4346
4347 .cmdopt -oP <&'path'&>
4348 .cindex "pid (process id)" "of daemon"
4349 .cindex "daemon" "process id (pid)"
4350 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4351 value. The option specifies the file to which the process id of the daemon is
4352 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4353 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4354 because in those cases, the normal pid file is not used.
4355
4356 .cmdopt -oPX
4357 .cindex "pid (process id)" "of daemon"
4358 .cindex "daemon" "process id (pid)"
4359 This option is not intended for general use.
4360 The daemon uses it when terminating due to a SIGTEM, possibly in
4361 combination with &%-oP%&&~<&'path'&>.
4362 It causes the pid file to be removed.
4363
4364 .cmdopt -or <&'time'&>
4365 .cindex "timeout" "for non-SMTP input"
4366 This option sets a timeout value for incoming non-SMTP messages. If it is not
4367 set, Exim will wait forever for the standard input. The value can also be set
4368 by the &%receive_timeout%& option. The format used for specifying times is
4369 described in section &<<SECTtimeformat>>&.
4370
4371 .cmdopt -os <&'time'&>
4372 .cindex "timeout" "for SMTP input"
4373 .cindex "SMTP" "input timeout"
4374 This option sets a timeout value for incoming SMTP messages. The timeout
4375 applies to each SMTP command and block of data. The value can also be set by
4376 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4377 for specifying times is described in section &<<SECTtimeformat>>&.
4378
4379 .cmdopt -ov
4380 This option has exactly the same effect as &%-v%&.
4381
4382 .cmdopt -oX <&'number&~or&~string'&>
4383 .cindex "TCP/IP" "setting listening ports"
4384 .cindex "TCP/IP" "setting listening interfaces"
4385 .cindex "port" "receiving TCP/IP"
4386 This option is relevant only when the &%-bd%& (start listening daemon) option
4387 is also given. It controls which ports and interfaces the daemon uses. Details
4388 of the syntax, and how it interacts with configuration file options, are given
4389 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4390 file is written unless &%-oP%& is also present to specify a pid filename.
4391
4392 .cmdopt -oY
4393 .cindex "daemon notifier socket"
4394 This option controls the creation of an inter-process communications endpoint
4395 by the Exim daemon.
4396 It is only relevant when the &%-bd%& (start listening daemon) option is also
4397 given.
4398 Normally the daemon creates this socket, unless a &%-oX%& and &*no*& &%-oP%&
4399 option is also present.
4400 If this option is given then the socket will not be created.  This could be
4401 required if the system is running multiple daemons.
4402
4403 The socket is currently used for
4404 .ilist
4405 fast ramp-up of queue runner processes
4406 .next
4407 obtaining a current queue size
4408 .endlist
4409
4410 .cmdopt -pd
4411 .cindex "Perl" "starting the interpreter"
4412 This option applies when an embedded Perl interpreter is linked with Exim (see
4413 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4414 option, forcing the starting of the interpreter to be delayed until it is
4415 needed.
4416
4417 .cmdopt -ps
4418 .cindex "Perl" "starting the interpreter"
4419 This option applies when an embedded Perl interpreter is linked with Exim (see
4420 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4421 option, forcing the starting of the interpreter to occur as soon as Exim is
4422 started.
4423
4424 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4425 .oindex "&%-p%&"
4426 For compatibility with Sendmail, this option is equivalent to
4427 .display
4428 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4429 .endd
4430 It sets the incoming protocol and host name (for trusted callers). The
4431 host name and its colon can be omitted when only the protocol is to be set.
4432 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4433 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4434 or &`s`& using this option (but that does not seem a real limitation).
4435 Repeated use of this option is not supported.
4436
4437 .cmdopt -q
4438 .cindex "queue runner" "starting manually"
4439 This option is normally restricted to admin users. However, there is a
4440 configuration option called &%prod_requires_admin%& which can be set false to
4441 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4442 and &%-S%& options).
4443
4444 .cindex "queue runner" "description of operation"
4445 If other commandline options do not specify an action,
4446 the &%-q%& option starts one queue runner process. This scans the queue of
4447 waiting messages, and runs a delivery process for each one in turn. It waits
4448 for each delivery process to finish before starting the next one. A delivery
4449 process may not actually do any deliveries if the retry times for the addresses
4450 have not been reached. Use &%-qf%& (see below) if you want to override this.
4451
4452 If
4453 .cindex "SMTP" "passed connection"
4454 .cindex "SMTP" "multiple deliveries"
4455 .cindex "multiple SMTP deliveries"
4456 the delivery process spawns other processes to deliver other messages down
4457 passed SMTP connections, the queue runner waits for these to finish before
4458 proceeding.
4459
4460 When all the queued messages have been considered, the original queue runner
4461 process terminates. In other words, a single pass is made over the waiting
4462 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4463 this to be repeated periodically.
4464
4465 Exim processes the waiting messages in an unpredictable order. It isn't very
4466 random, but it is likely to be different each time, which is all that matters.
4467 If one particular message screws up a remote MTA, other messages to the same
4468 MTA have a chance of getting through if they get tried first.
4469
4470 It is possible to cause the messages to be processed in lexical message id
4471 order, which is essentially the order in which they arrived, by setting the
4472 &%queue_run_in_order%& option, but this is not recommended for normal use.
4473
4474 .vitem &%-q%&<&'qflags'&>
4475 The &%-q%& option may be followed by one or more flag letters that change its
4476 behaviour. They are all optional, but if more than one is present, they must
4477 appear in the correct order. Each flag is described in a separate item below.
4478
4479 .vitem &%-qq...%&
4480 .oindex "&%-qq%&"
4481 .cindex "queue" "double scanning"
4482 .cindex "queue" "routing"
4483 .cindex "routing" "whole queue before delivery"
4484 .cindex "first pass routing"
4485 .cindex "queue runner" "two phase"
4486 An option starting with &%-qq%& requests a two-stage queue run. In the first
4487 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4488 every domain. Addresses are routed, local deliveries happen, but no remote
4489 transports are run.
4490
4491 Performance will be best if the &%queue_run_in_order%& option is false.
4492 If that is so and the &%queue_fast_ramp%& option is true then
4493 in the first phase of the run,
4494 once a threshold number of messages are routed for a given host,
4495 a delivery process is forked in parallel with the rest of the scan.
4496
4497 .cindex "hints database" "remembering routing"
4498 The hints database that remembers which messages are waiting for specific hosts
4499 is updated, as if delivery to those hosts had been deferred. After this is
4500 complete, a second, normal queue scan happens, with routing and delivery taking
4501 place as normal. Messages that are routed to the same host should mostly be
4502 delivered down a single SMTP
4503 .cindex "SMTP" "passed connection"
4504 .cindex "SMTP" "multiple deliveries"
4505 .cindex "multiple SMTP deliveries"
4506 connection because of the hints that were set up during the first queue scan.
4507 This option may be useful for hosts that are connected to the Internet
4508 intermittently.
4509
4510 .vitem &%-q[q]i...%&
4511 .oindex "&%-qi%&"
4512 .cindex "queue" "initial delivery"
4513 If the &'i'& flag is present, the queue runner runs delivery processes only for
4514 those messages that haven't previously been tried. (&'i'& stands for &"initial
4515 delivery"&.) This can be helpful if you are putting messages in the queue using
4516 &%-odq%& and want a queue runner just to process the new messages.
4517
4518 .vitem &%-q[q][i]f...%&
4519 .oindex "&%-qf%&"
4520 .cindex "queue" "forcing delivery"
4521 .cindex "delivery" "forcing in queue run"
4522 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4523 message, whereas without &'f'& only those non-frozen addresses that have passed
4524 their retry times are tried.
4525
4526 .vitem &%-q[q][i]ff...%&
4527 .oindex "&%-qff%&"
4528 .cindex "frozen messages" "forcing delivery"
4529 If &'ff'& is present, a delivery attempt is forced for every message, whether
4530 frozen or not.
4531
4532 .vitem &%-q[q][i][f[f]]l%&
4533 .oindex "&%-ql%&"
4534 .cindex "queue" "local deliveries only"
4535 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4536 be done. If a message requires any remote deliveries, it remains in the queue
4537 for later delivery.
4538
4539 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4540 .oindex "&%-qG%&"
4541 .cindex queue named
4542 .cindex "named queues"  "deliver from"
4543 .cindex "queue" "delivering specific messages"
4544 If the &'G'& flag and a name is present, the queue runner operates on the
4545 queue with the given name rather than the default queue.
4546 The name should not contain a &'/'& character.
4547 For a periodic queue run (see below)
4548 append to the name a slash and a time value.
4549
4550 If other commandline options specify an action, a &'-qG<name>'& option
4551 will specify a queue to operate on.
4552 For example:
4553 .code
4554 exim -bp -qGquarantine
4555 mailq -qGquarantine
4556 exim -qGoffpeak -Rf @special.domain.example
4557 .endd
4558
4559 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4560 When scanning the queue, Exim can be made to skip over messages whose ids are
4561 lexically less than a given value by following the &%-q%& option with a
4562 starting message id. For example:
4563 .code
4564 exim -q 0t5C6f-0000c8-00
4565 .endd
4566 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4567 second message id is given, messages whose ids are lexically greater than it
4568 are also skipped. If the same id is given twice, for example,
4569 .code
4570 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4571 .endd
4572 just one delivery process is started, for that message. This differs from
4573 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4574 that it counts as a delivery from a queue run. Note that the selection
4575 mechanism does not affect the order in which the messages are scanned. There
4576 are also other ways of selecting specific sets of messages for delivery in a
4577 queue run &-- see &%-R%& and &%-S%&.
4578
4579 .vitem &%-q%&<&'qflags'&><&'time'&>
4580 .cindex "queue runner" "starting periodically"
4581 .cindex "periodic queue running"
4582 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4583 starting a queue runner process at intervals specified by the given time value
4584 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4585 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4586 single daemon process handles both functions. A common way of starting up a
4587 combined daemon at system boot time is to use a command such as
4588 .code
4589 /usr/exim/bin/exim -bd -q30m
4590 .endd
4591 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4592 process every 30 minutes.
4593
4594 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4595 pid file is written unless one is explicitly requested by the &%-oP%& option.
4596
4597 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4598 .oindex "&%-qR%&"
4599 This option is synonymous with &%-R%&. It is provided for Sendmail
4600 compatibility.
4601
4602 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4603 .oindex "&%-qS%&"
4604 This option is synonymous with &%-S%&.
4605
4606 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4607 .oindex "&%-R%&"
4608 .cindex "queue runner" "for specific recipients"
4609 .cindex "delivery" "to given domain"
4610 .cindex "domain" "delivery to"
4611 The <&'rsflags'&> may be empty, in which case the white space before the string
4612 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4613 which are the possible values for <&'rsflags'&>. White space is required if
4614 <&'rsflags'&> is not empty.
4615
4616 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4617 perform a single queue run, except that, when scanning the messages on the
4618 queue, Exim processes only those that have at least one undelivered recipient
4619 address containing the given string, which is checked in a case-independent
4620 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4621 regular expression; otherwise it is a literal string.
4622
4623 If you want to do periodic queue runs for messages with specific recipients,
4624 you can combine &%-R%& with &%-q%& and a time value. For example:
4625 .code
4626 exim -q25m -R @special.domain.example
4627 .endd
4628 This example does a queue run for messages with recipients in the given domain
4629 every 25 minutes. Any additional flags that are specified with &%-q%& are
4630 applied to each queue run.
4631
4632 Once a message is selected for delivery by this mechanism, all its addresses
4633 are processed. For the first selected message, Exim overrides any retry
4634 information and forces a delivery attempt for each undelivered address. This
4635 means that if delivery of any address in the first message is successful, any
4636 existing retry information is deleted, and so delivery attempts for that
4637 address in subsequently selected messages (which are processed without forcing)
4638 will run. However, if delivery of any address does not succeed, the retry
4639 information is updated, and in subsequently selected messages, the failing
4640 address will be skipped.
4641
4642 .cindex "frozen messages" "forcing delivery"
4643 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4644 all selected messages, not just the first; frozen messages are included when
4645 &'ff'& is present.
4646
4647 The &%-R%& option makes it straightforward to initiate delivery of all messages
4648 to a given domain after a host has been down for some time. When the SMTP
4649 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4650 effect is to run Exim with the &%-R%& option, but it can be configured to run
4651 an arbitrary command instead.
4652
4653 .cmdopt -r
4654 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4655
4656 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4657 .oindex "&%-S%&"
4658 .cindex "delivery" "from given sender"
4659 .cindex "queue runner" "for specific senders"
4660 This option acts like &%-R%& except that it checks the string against each
4661 message's sender instead of against the recipients. If &%-R%& is also set, both
4662 conditions must be met for a message to be selected. If either of the options
4663 has &'f'& or &'ff'& in its flags, the associated action is taken.
4664
4665 .cmdopt -Tqt <&'times'&>
4666 This is an option that is exclusively for use by the Exim testing suite. It is not
4667 recognized when Exim is run normally. It allows for the setting up of explicit
4668 &"queue times"& so that various warning/retry features can be tested.
4669
4670 .cmdopt -t
4671 .cindex "recipient" "extracting from header lines"
4672 .chindex Bcc:
4673 .chindex Cc:
4674 .chindex To:
4675 When Exim is receiving a locally-generated, non-SMTP message on its standard
4676 input, the &%-t%& option causes the recipients of the message to be obtained
4677 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4678 from the command arguments. The addresses are extracted before any rewriting
4679 takes place and the &'Bcc:'& header line, if present, is then removed.
4680
4681 .cindex "Sendmail compatibility" "&%-t%& option"
4682 If the command has any arguments, they specify addresses to which the message
4683 is &'not'& to be delivered. That is, the argument addresses are removed from
4684 the recipients list obtained from the headers. This is compatible with Smail 3
4685 and in accordance with the documented behaviour of several versions of
4686 Sendmail, as described in man pages on a number of operating systems (e.g.
4687 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4688 argument addresses to those obtained from the headers, and the O'Reilly
4689 Sendmail book documents it that way. Exim can be made to add argument addresses
4690 instead of subtracting them by setting the option
4691 &%extract_addresses_remove_arguments%& false.
4692
4693 .cindex "&%Resent-%& header lines" "with &%-t%&"
4694 If there are any &%Resent-%& header lines in the message, Exim extracts
4695 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4696 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4697 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4698 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4699
4700 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4701 message is resent several times). The RFC also specifies that they should be
4702 added at the front of the message, and separated by &'Received:'& lines. It is
4703 not at all clear how &%-t%& should operate in the present of multiple sets,
4704 nor indeed exactly what constitutes a &"set"&.
4705 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4706 are often added at the end of the header, and if a message is resent more than
4707 once, it is common for the original set of &%Resent-%& headers to be renamed as
4708 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4709
4710 .cmdopt -ti
4711 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4712 compatibility with Sendmail.
4713
4714 .cmdopt -tls-on-connect
4715 .cindex "TLS" "use without STARTTLS"
4716 .cindex "TLS" "automatic start"
4717 This option is available when Exim is compiled with TLS support. It forces all
4718 incoming SMTP connections to behave as if the incoming port is listed in the
4719 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4720 &<<CHAPTLS>>& for further details.
4721
4722
4723 .cmdopt -U
4724 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4725 Sendmail uses this option for &"initial message submission"&, and its
4726 documentation states that in future releases, it may complain about
4727 syntactically invalid messages rather than fixing them when this flag is not
4728 set. Exim ignores this option.
4729
4730 .cmdopt -v
4731 This option causes Exim to write information to the standard error stream,
4732 describing what it is doing. In particular, it shows the log lines for
4733 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4734 dialogue is shown. Some of the log lines shown may not actually be written to
4735 the log if the setting of &%log_selector%& discards them. Any relevant
4736 selectors are shown with each log line. If none are shown, the logging is
4737 unconditional.
4738
4739 .cmdopt -x
4740 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4741 National Language Support extended characters in the body of the mail item"&).
4742 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4743 this option.
4744
4745 .cmdopt -X <&'logfile'&>
4746 This option is interpreted by Sendmail to cause debug information to be sent
4747 to the named file.  It is ignored by Exim.
4748
4749 .cmdopt -z <&'log-line'&>
4750 This option writes its argument to Exim's logfile.
4751 Use is restricted to administrators; the intent is for operational notes.
4752 Quotes should be used to maintain a multi-word item as a single argument,
4753 under most shells.
4754 .endlist
4755
4756 .ecindex IIDclo1
4757 .ecindex IIDclo2
4758
4759
4760 . ////////////////////////////////////////////////////////////////////////////
4761 . Insert a stylized DocBook comment here, to identify the end of the command
4762 . line options. This is for the benefit of the Perl script that automatically
4763 . creates a man page for the options.
4764 . ////////////////////////////////////////////////////////////////////////////
4765
4766 .literal xml
4767 <!-- === End of command line options === -->
4768 .literal off
4769
4770
4771
4772
4773
4774 . ////////////////////////////////////////////////////////////////////////////
4775 . ////////////////////////////////////////////////////////////////////////////
4776
4777
4778 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4779          "The runtime configuration file"
4780
4781 .cindex "runtime configuration"
4782 .cindex "configuration file" "general description"
4783 .cindex "CONFIGURE_FILE"
4784 .cindex "configuration file" "errors in"
4785 .cindex "error" "in configuration file"
4786 .cindex "return code" "for bad configuration"
4787 Exim uses a single runtime configuration file that is read whenever an Exim
4788 binary is executed. Note that in normal operation, this happens frequently,
4789 because Exim is designed to operate in a distributed manner, without central
4790 control.
4791
4792 If a syntax error is detected while reading the configuration file, Exim
4793 writes a message on the standard error, and exits with a non-zero return code.
4794 The message is also written to the panic log. &*Note*&: Only simple syntax
4795 errors can be detected at this time. The values of any expanded options are
4796 not checked until the expansion happens, even when the expansion does not
4797 actually alter the string.
4798
4799 The name of the configuration file is compiled into the binary for security
4800 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4801 most configurations, this specifies a single file. However, it is permitted to
4802 give a colon-separated list of filenames, in which case Exim uses the first
4803 existing file in the list.
4804
4805 .cindex "EXIM_USER"
4806 .cindex "EXIM_GROUP"
4807 .cindex "CONFIGURE_OWNER"
4808 .cindex "CONFIGURE_GROUP"
4809 .cindex "configuration file" "ownership"
4810 .cindex "ownership" "configuration file"
4811 The runtime configuration file must be owned by root or by the user that is
4812 specified at compile time by the CONFIGURE_OWNER option (if set). The
4813 configuration file must not be world-writeable, or group-writeable unless its
4814 group is the root group or the one specified at compile time by the
4815 CONFIGURE_GROUP option.
4816
4817 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4818 to root, anybody who is able to edit the runtime configuration file has an
4819 easy way to run commands as root. If you specify a user or group in the
4820 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4821 who are members of that group will trivially be able to obtain root privileges.
4822
4823 Up to Exim version 4.72, the runtime configuration file was also permitted to
4824 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4825 since it offered a simple privilege escalation for any attacker who managed to
4826 compromise the Exim user account.
4827
4828 A default configuration file, which will work correctly in simple situations,
4829 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4830 defines just one filename, the installation process copies the default
4831 configuration to a new file of that name if it did not previously exist. If
4832 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4833 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4834 configuration.
4835
4836
4837
4838 .section "Using a different configuration file" "SECID40"
4839 .cindex "configuration file" "alternate"
4840 A one-off alternate configuration can be specified by the &%-C%& command line
4841 option, which may specify a single file or a list of files. However, when
4842 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4843 unless the argument for &%-C%& is identical to the built-in value from
4844 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4845 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4846 is useful mainly for checking the syntax of configuration files before
4847 installing them. No owner or group checks are done on a configuration file
4848 specified by &%-C%&, if root privilege has been dropped.
4849
4850 Even the Exim user is not trusted to specify an arbitrary configuration file
4851 with the &%-C%& option to be used with root privileges, unless that file is
4852 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4853 testing a configuration using &%-C%& right through message reception and
4854 delivery, even if the caller is root. The reception works, but by that time,
4855 Exim is running as the Exim user, so when it re-execs to regain privilege for
4856 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4857 can test reception and delivery using two separate commands (one to put a
4858 message in the queue, using &%-odq%&, and another to do the delivery, using
4859 &%-M%&).
4860
4861 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4862 prefix string with which any file named in a &%-C%& command line option must
4863 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4864 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4865 filename can be used with &%-C%&.
4866
4867 One-off changes to a configuration can be specified by the &%-D%& command line
4868 option, which defines and overrides values for macros used inside the
4869 configuration file. However, like &%-C%&, the use of this option by a
4870 non-privileged user causes Exim to discard its root privilege.
4871 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4872 completely disabled, and its use causes an immediate error exit.
4873
4874 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4875 to declare certain macro names trusted, such that root privilege will not
4876 necessarily be discarded.
4877 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4878 considered safe and, if &%-D%& only supplies macros from this list, and the
4879 values are acceptable, then Exim will not give up root privilege if the caller
4880 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4881 transition mechanism and is expected to be removed in the future.  Acceptable
4882 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4883
4884 Some sites may wish to use the same Exim binary on different machines that
4885 share a file system, but to use different configuration files on each machine.
4886 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4887 looks for a file whose name is the configuration filename followed by a dot
4888 and the machine's node name, as obtained from the &[uname()]& function. If this
4889 file does not exist, the standard name is tried. This processing occurs for
4890 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4891
4892 In some esoteric situations different versions of Exim may be run under
4893 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4894 help with this. See the comments in &_src/EDITME_& for details.
4895
4896
4897
4898 .section "Configuration file format" "SECTconffilfor"
4899 .cindex "configuration file" "format of"
4900 .cindex "format" "configuration file"
4901 Exim's configuration file is divided into a number of different parts. General
4902 option settings must always appear at the start of the file. The other parts
4903 are all optional, and may appear in any order. Each part other than the first
4904 is introduced by the word &"begin"& followed by at least one literal
4905 space, and the name of the part. The optional parts are:
4906
4907 .ilist
4908 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4909 &<<CHAPACL>>&).
4910 .next
4911 .cindex "AUTH" "configuration"
4912 &'authenticators'&: Configuration settings for the authenticator drivers. These
4913 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4914 .next
4915 &'routers'&: Configuration settings for the router drivers. Routers process
4916 addresses and determine how the message is to be delivered (see chapters
4917 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4918 .next
4919 &'transports'&: Configuration settings for the transport drivers. Transports
4920 define mechanisms for copying messages to destinations (see chapters
4921 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4922 .next
4923 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4924 If there is no retry section, or if it is empty (that is, no retry rules are
4925 defined), Exim will not retry deliveries. In this situation, temporary errors
4926 are treated the same as permanent errors. Retry rules are discussed in chapter
4927 &<<CHAPretry>>&.
4928 .next
4929 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4930 when new addresses are generated during delivery. Rewriting is discussed in
4931 chapter &<<CHAPrewrite>>&.
4932 .next
4933 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4934 want to use this feature, you must set
4935 .code
4936 LOCAL_SCAN_HAS_OPTIONS=yes
4937 .endd
4938 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4939 facility are given in chapter &<<CHAPlocalscan>>&.
4940 .endlist
4941
4942 .cindex "configuration file" "leading white space in"
4943 .cindex "configuration file" "trailing white space in"
4944 .cindex "white space" "in configuration file"
4945 Leading and trailing white space in configuration lines is always ignored.
4946
4947 Blank lines in the file, and lines starting with a # character (ignoring
4948 leading white space) are treated as comments and are ignored. &*Note*&: A
4949 # character other than at the beginning of a line is not treated specially,
4950 and does not introduce a comment.
4951
4952 Any non-comment line can be continued by ending it with a backslash. Note that
4953 the general rule for white space means that trailing white space after the
4954 backslash and leading white space at the start of continuation
4955 lines is ignored. Comment lines beginning with # (but not empty lines) may
4956 appear in the middle of a sequence of continuation lines.
4957
4958 A convenient way to create a configuration file is to start from the
4959 default, which is supplied in &_src/configure.default_&, and add, delete, or
4960 change settings as required.
4961
4962 The ACLs, retry rules, and rewriting rules have their own syntax which is
4963 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4964 respectively. The other parts of the configuration file have some syntactic
4965 items in common, and these are described below, from section &<<SECTcos>>&
4966 onwards. Before that, the inclusion, macro, and conditional facilities are
4967 described.
4968
4969
4970
4971 .section "File inclusions in the configuration file" "SECID41"
4972 .cindex "inclusions in configuration file"
4973 .cindex "configuration file" "including other files"
4974 .cindex "&`.include`& in configuration file"
4975 .cindex "&`.include_if_exists`& in configuration file"
4976 You can include other files inside Exim's runtime configuration file by
4977 using this syntax:
4978 .display
4979 &`.include`& <&'filename'&>
4980 &`.include_if_exists`& <&'filename'&>
4981 .endd
4982 on a line by itself. Double quotes round the filename are optional. If you use
4983 the first form, a configuration error occurs if the file does not exist; the
4984 second form does nothing for non-existent files.
4985 The first form allows a relative name. It is resolved relative to
4986 the directory of the including file. For the second form an absolute filename
4987 is required.
4988
4989 Includes may be nested to any depth, but remember that Exim reads its
4990 configuration file often, so it is a good idea to keep them to a minimum.
4991 If you change the contents of an included file, you must HUP the daemon,
4992 because an included file is read only when the configuration itself is read.
4993
4994 The processing of inclusions happens early, at a physical line level, so, like
4995 comment lines, an inclusion can be used in the middle of an option setting,
4996 for example:
4997 .code
4998 hosts_lookup = a.b.c \
4999                .include /some/file
5000 .endd
5001 Include processing happens after macro processing (see below). Its effect is to
5002 process the lines of the included file as if they occurred inline where the
5003 inclusion appears.
5004
5005
5006
5007 .section "Macros in the configuration file" "SECTmacrodefs"
5008 .cindex "macro" "description of"
5009 .cindex "configuration file" "macros"
5010 If a line in the main part of the configuration (that is, before the first
5011 &"begin"& line) begins with an upper case letter, it is taken as a macro
5012 definition, and must be of the form
5013 .display
5014 <&'name'&> = <&'rest of line'&>
5015 .endd
5016 The name must consist of letters, digits, and underscores, and need not all be
5017 in upper case, though that is recommended. The rest of the line, including any
5018 continuations, is the replacement text, and has leading and trailing white
5019 space removed. Quotes are not removed. The replacement text can never end with
5020 a backslash character, but this doesn't seem to be a serious limitation.
5021
5022 Macros may also be defined between router, transport, authenticator, or ACL
5023 definitions. They may not, however, be defined within an individual driver or
5024 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5025
5026 .section "Macro substitution" "SECID42"
5027 Once a macro is defined, all subsequent lines in the file (and any included
5028 files) are scanned for the macro name; if there are several macros, the line is
5029 scanned for each, in turn, in the order in which the macros are defined. The
5030 replacement text is not re-scanned for the current macro, though it is scanned
5031 for subsequently defined macros. For this reason, a macro name may not contain
5032 the name of a previously defined macro as a substring. You could, for example,
5033 define
5034 .display
5035 &`ABCD_XYZ = `&<&'something'&>
5036 &`ABCD = `&<&'something else'&>
5037 .endd
5038 but putting the definitions in the opposite order would provoke a configuration
5039 error. Macro expansion is applied to individual physical lines from the file,
5040 before checking for line continuation or file inclusion (see above). If a line
5041 consists solely of a macro name, and the expansion of the macro is empty, the
5042 line is ignored. A macro at the start of a line may turn the line into a
5043 comment line or a &`.include`& line.
5044
5045
5046 .section "Redefining macros" "SECID43"
5047 Once defined, the value of a macro can be redefined later in the configuration
5048 (or in an included file). Redefinition is specified by using &'=='& instead of
5049 &'='&. For example:
5050 .code
5051 MAC =  initial value
5052 ...
5053 MAC == updated value
5054 .endd
5055 Redefinition does not alter the order in which the macros are applied to the
5056 subsequent lines of the configuration file. It is still the same order in which
5057 the macros were originally defined. All that changes is the macro's value.
5058 Redefinition makes it possible to accumulate values. For example:
5059 .code
5060 MAC =  initial value
5061 ...
5062 MAC == MAC and something added
5063 .endd
5064 This can be helpful in situations where the configuration file is built
5065 from a number of other files.
5066
5067 .section "Overriding macro values" "SECID44"
5068 The values set for macros in the configuration file can be overridden by the
5069 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5070 used, unless called by root or the Exim user. A definition on the command line
5071 using the &%-D%& option causes all definitions and redefinitions within the
5072 file to be ignored.
5073
5074
5075
5076 .section "Example of macro usage" "SECID45"
5077 As an example of macro usage, consider a configuration where aliases are looked
5078 up in a MySQL database. It helps to keep the file less cluttered if long
5079 strings such as SQL statements are defined separately as macros, for example:
5080 .code
5081 ALIAS_QUERY = select mailbox from user where \
5082               login='${quote_mysql:$local_part}';
5083 .endd
5084 This can then be used in a &(redirect)& router setting like this:
5085 .code
5086 data = ${lookup mysql{ALIAS_QUERY}}
5087 .endd
5088 In earlier versions of Exim macros were sometimes used for domain, host, or
5089 address lists. In Exim 4 these are handled better by named lists &-- see
5090 section &<<SECTnamedlists>>&.
5091
5092
5093 .section "Builtin macros" "SECTbuiltinmacros"
5094 Exim defines some macros depending on facilities available, which may
5095 differ due to build-time definitions and from one release to another.
5096 All of these macros start with an underscore.
5097 They can be used to conditionally include parts of a configuration
5098 (see below).
5099
5100 The following classes of macros are defined:
5101 .display
5102 &` _HAVE_*                    `&  build-time defines
5103 &` _DRIVER_ROUTER_*           `&  router drivers
5104 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5105 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5106 &` _LOG_*                     `&  log_selector values
5107 &` _OPT_MAIN_*                `&  main config options
5108 &` _OPT_ROUTERS_*             `&  generic router options
5109 &` _OPT_TRANSPORTS_*          `&  generic transport options
5110 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5111 &` _OPT_ROUTER_*_*            `&  private router options
5112 &` _OPT_TRANSPORT_*_*         `&  private transport options
5113 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5114 .endd
5115
5116 Use an &"exim -bP macros"& command to get the list of macros.
5117
5118
5119 .section "Conditional skips in the configuration file" "SECID46"
5120 .cindex "configuration file" "conditional skips"
5121 .cindex "&`.ifdef`&"
5122 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5123 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5124 portions of the configuration file. The processing happens whenever the file is
5125 read (that is, when an Exim binary starts to run).
5126
5127 The implementation is very simple. Instances of the first four directives must
5128 be followed by text that includes the names of one or macros. The condition
5129 that is tested is whether or not any macro substitution has taken place in the
5130 line. Thus:
5131 .code
5132 .ifdef AAA
5133 message_size_limit = 50M
5134 .else
5135 message_size_limit = 100M
5136 .endif
5137 .endd
5138 sets a message size limit of 50M if the macro &`AAA`& is defined
5139 (or &`A`& or &`AA`&), and 100M
5140 otherwise. If there is more than one macro named on the line, the condition
5141 is true if any of them are defined. That is, it is an &"or"& condition. To
5142 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5143
5144 Although you can use a macro expansion to generate one of these directives,
5145 it is not very useful, because the condition &"there was a macro substitution
5146 in this line"& will always be true.
5147
5148 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5149 to clarify complicated nestings.
5150
5151
5152
5153 .section "Common option syntax" "SECTcos"
5154 .cindex "common option syntax"
5155 .cindex "syntax of common options"
5156 .cindex "configuration file" "common option syntax"
5157 For the main set of options, driver options, and &[local_scan()]& options,
5158 each setting is on a line by itself, and starts with a name consisting of
5159 lower-case letters and underscores. Many options require a data value, and in
5160 these cases the name must be followed by an equals sign (with optional white
5161 space) and then the value. For example:
5162 .code
5163 qualify_domain = mydomain.example.com
5164 .endd
5165 .cindex "hiding configuration option values"
5166 .cindex "configuration options" "hiding value of"
5167 .cindex "options" "hiding value of"
5168 Some option settings may contain sensitive data, for example, passwords for
5169 accessing databases. To stop non-admin users from using the &%-bP%& command
5170 line option to read these values, you can precede the option settings with the
5171 word &"hide"&. For example:
5172 .code
5173 hide mysql_servers = localhost/users/admin/secret-password
5174 .endd
5175 For non-admin users, such options are displayed like this:
5176 .code
5177 mysql_servers = <value not displayable>
5178 .endd
5179 If &"hide"& is used on a driver option, it hides the value of that option on
5180 all instances of the same driver.
5181
5182 The following sections describe the syntax used for the different data types
5183 that are found in option settings.
5184
5185
5186 .section "Boolean options" "SECID47"
5187 .cindex "format" "boolean"
5188 .cindex "boolean configuration values"
5189 .oindex "&%no_%&&'xxx'&"
5190 .oindex "&%not_%&&'xxx'&"
5191 Options whose type is given as boolean are on/off switches. There are two
5192 different ways of specifying such options: with and without a data value. If
5193 the option name is specified on its own without data, the switch is turned on;
5194 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5195 boolean options may be followed by an equals sign and one of the words
5196 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5197 the following two settings have exactly the same effect:
5198 .code
5199 queue_only
5200 queue_only = true
5201 .endd
5202 The following two lines also have the same (opposite) effect:
5203 .code
5204 no_queue_only
5205 queue_only = false
5206 .endd
5207 You can use whichever syntax you prefer.
5208
5209
5210
5211
5212 .section "Integer values" "SECID48"
5213 .cindex "integer configuration values"
5214 .cindex "format" "integer"
5215 If an option's type is given as &"integer"&, the value can be given in decimal,
5216 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5217 number is assumed. Otherwise, it is treated as an octal number unless it starts
5218 with the characters &"0x"&, in which case the remainder is interpreted as a
5219 hexadecimal number.
5220
5221 If an integer value is followed by the letter K, it is multiplied by 1024; if
5222 it is followed by the letter M, it is multiplied by 1024x1024;
5223 if by the letter G, 1024x1024x1024.
5224 When the values
5225 of integer option settings are output, values which are an exact multiple of
5226 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5227 and M. The printing style is independent of the actual input format that was
5228 used.
5229
5230
5231 .section "Octal integer values" "SECID49"
5232 .cindex "integer format"
5233 .cindex "format" "octal integer"
5234 If an option's type is given as &"octal integer"&, its value is always
5235 interpreted as an octal number, whether or not it starts with the digit zero.
5236 Such options are always output in octal.
5237
5238
5239 .section "Fixed point numbers" "SECID50"
5240 .cindex "fixed point configuration values"
5241 .cindex "format" "fixed point"
5242 If an option's type is given as &"fixed-point"&, its value must be a decimal
5243 integer, optionally followed by a decimal point and up to three further digits.
5244
5245
5246
5247 .section "Time intervals" "SECTtimeformat"
5248 .cindex "time interval" "specifying in configuration"
5249 .cindex "format" "time interval"
5250 A time interval is specified as a sequence of numbers, each followed by one of
5251 the following letters, with no intervening white space:
5252
5253 .table2 30pt
5254 .irow &%s%& seconds
5255 .irow &%m%& minutes
5256 .irow &%h%& hours
5257 .irow &%d%& days
5258 .irow &%w%& weeks
5259 .endtable
5260
5261 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5262 intervals are output in the same format. Exim does not restrict the values; it
5263 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5264
5265
5266
5267 .section "String values" "SECTstrings"
5268 .cindex "string" "format of configuration values"
5269 .cindex "format" "string"
5270 If an option's type is specified as &"string"&, the value can be specified with
5271 or without double-quotes. If it does not start with a double-quote, the value
5272 consists of the remainder of the line plus any continuation lines, starting at
5273 the first character after any leading white space, with trailing white space
5274 removed, and with no interpretation of the characters in the string. Because
5275 Exim removes comment lines (those beginning with #) at an early stage, they can
5276 appear in the middle of a multi-line string. The following two settings are
5277 therefore equivalent:
5278 .code
5279 trusted_users = uucp:mail
5280 trusted_users = uucp:\
5281                 # This comment line is ignored
5282                 mail
5283 .endd
5284 .cindex "string" "quoted"
5285 .cindex "escape characters in quoted strings"
5286 If a string does start with a double-quote, it must end with a closing
5287 double-quote, and any backslash characters other than those used for line
5288 continuation are interpreted as escape characters, as follows:
5289
5290 .table2 100pt
5291 .irow &`\\`&                     "single backslash"
5292 .irow &`\n`&                     "newline"
5293 .irow &`\r`&                     "carriage return"
5294 .irow &`\t`&                     "tab"
5295 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5296 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5297                                    character"
5298 .endtable
5299
5300 If a backslash is followed by some other character, including a double-quote
5301 character, that character replaces the pair.
5302
5303 Quoting is necessary only if you want to make use of the backslash escapes to
5304 insert special characters, or if you need to specify a value with leading or
5305 trailing spaces. These cases are rare, so quoting is almost never needed in
5306 current versions of Exim. In versions of Exim before 3.14, quoting was required
5307 in order to continue lines, so you may come across older configuration files
5308 and examples that apparently quote unnecessarily.
5309
5310
5311 .section "Expanded strings" "SECID51"
5312 .cindex "expansion" "definition of"
5313 Some strings in the configuration file are subjected to &'string expansion'&,
5314 by which means various parts of the string may be changed according to the
5315 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5316 is as just described; in particular, the handling of backslashes in quoted
5317 strings is done as part of the input process, before expansion takes place.
5318 However, backslash is also an escape character for the expander, so any
5319 backslashes that are required for that reason must be doubled if they are
5320 within a quoted configuration string.
5321
5322
5323 .section "User and group names" "SECID52"
5324 .cindex "user name" "format of"
5325 .cindex "format" "user name"
5326 .cindex "groups" "name format"
5327 .cindex "format" "group name"
5328 User and group names are specified as strings, using the syntax described
5329 above, but the strings are interpreted specially. A user or group name must
5330 either consist entirely of digits, or be a name that can be looked up using the
5331 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5332
5333
5334 .section "List construction" "SECTlistconstruct"
5335 .cindex "list" "syntax of in configuration"
5336 .cindex "format" "list item in configuration"
5337 .cindex "string" "list, definition of"
5338 The data for some configuration options is a list of items, with colon as the
5339 default separator. Many of these options are shown with type &"string list"& in
5340 the descriptions later in this document. Others are listed as &"domain list"&,
5341 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5342 are all the same; however, those other than &"string list"& are subject to
5343 particular kinds of interpretation, as described in chapter
5344 &<<CHAPdomhosaddlists>>&.
5345
5346 In all these cases, the entire list is treated as a single string as far as the
5347 input syntax is concerned. The &%trusted_users%& setting in section
5348 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5349 in a list, it must be entered as two colons. Leading and trailing white space
5350 on each item in a list is ignored. This makes it possible to include items that
5351 start with a colon, and in particular, certain forms of IPv6 address. For
5352 example, the list
5353 .code
5354 local_interfaces = 127.0.0.1 : ::::1
5355 .endd
5356 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5357
5358 &*Note*&: Although leading and trailing white space is ignored in individual
5359 list items, it is not ignored when parsing the list. The spaces around the first
5360 colon in the example above are necessary. If they were not there, the list would
5361 be interpreted as the two items 127.0.0.1:: and 1.
5362
5363 .section "Changing list separators" "SECTlistsepchange"
5364 .cindex "list separator" "changing"
5365 .cindex "IPv6" "addresses in lists"
5366 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5367 introduced to allow the separator character to be changed. If a list begins
5368 with a left angle bracket, followed by any punctuation character, that
5369 character is used instead of colon as the list separator. For example, the list
5370 above can be rewritten to use a semicolon separator like this:
5371 .code
5372 local_interfaces = <; 127.0.0.1 ; ::1
5373 .endd
5374 This facility applies to all lists, with the exception of the list in
5375 &%log_file_path%&. It is recommended that the use of non-colon separators be
5376 confined to circumstances where they really are needed.
5377
5378 .cindex "list separator" "newline as"
5379 .cindex "newline" "as list separator"
5380 It is also possible to use newline and other control characters (those with
5381 code values less than 32, plus DEL) as separators in lists. Such separators
5382 must be provided literally at the time the list is processed. For options that
5383 are string-expanded, you can write the separator using a normal escape
5384 sequence. This will be processed by the expander before the string is
5385 interpreted as a list. For example, if a newline-separated list of domains is
5386 generated by a lookup, you can process it directly by a line such as this:
5387 .code
5388 domains = <\n ${lookup mysql{.....}}
5389 .endd
5390 This avoids having to change the list separator in such data. You are unlikely
5391 to want to use a control character as a separator in an option that is not
5392 expanded, because the value is literal text. However, it can be done by giving
5393 the value in quotes. For example:
5394 .code
5395 local_interfaces = "<\n 127.0.0.1 \n ::1"
5396 .endd
5397 Unlike printing character separators, which can be included in list items by
5398 doubling, it is not possible to include a control character as data when it is
5399 set as the separator. Two such characters in succession are interpreted as
5400 enclosing an empty list item.
5401
5402
5403
5404 .section "Empty items in lists" "SECTempitelis"
5405 .cindex "list" "empty item in"
5406 An empty item at the end of a list is always ignored. In other words, trailing
5407 separator characters are ignored. Thus, the list in
5408 .code
5409 senders = user@domain :
5410 .endd
5411 contains only a single item. If you want to include an empty string as one item
5412 in a list, it must not be the last item. For example, this list contains three
5413 items, the second of which is empty:
5414 .code
5415 senders = user1@domain : : user2@domain
5416 .endd
5417 &*Note*&: There must be white space between the two colons, as otherwise they
5418 are interpreted as representing a single colon data character (and the list
5419 would then contain just one item). If you want to specify a list that contains
5420 just one, empty item, you can do it as in this example:
5421 .code
5422 senders = :
5423 .endd
5424 In this case, the first item is empty, and the second is discarded because it
5425 is at the end of the list.
5426
5427
5428
5429
5430 .section "Format of driver configurations" "SECTfordricon"
5431 .cindex "drivers" "configuration format"
5432 There are separate parts in the configuration for defining routers, transports,
5433 and authenticators. In each part, you are defining a number of driver
5434 instances, each with its own set of options. Each driver instance is defined by
5435 a sequence of lines like this:
5436 .display
5437 <&'instance name'&>:
5438   <&'option'&>
5439   ...
5440   <&'option'&>
5441 .endd
5442 In the following example, the instance name is &(localuser)&, and it is
5443 followed by three options settings:
5444 .code
5445 localuser:
5446   driver = accept
5447   check_local_user
5448   transport = local_delivery
5449 .endd
5450 For each driver instance, you specify which Exim code module it uses &-- by the
5451 setting of the &%driver%& option &-- and (optionally) some configuration
5452 settings. For example, in the case of transports, if you want a transport to
5453 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5454 a local file you would use the &(appendfile)& driver. Each of the drivers is
5455 described in detail in its own separate chapter later in this manual.
5456
5457 You can have several routers, transports, or authenticators that are based on
5458 the same underlying driver (each must have a different instance name).
5459
5460 The order in which routers are defined is important, because addresses are
5461 passed to individual routers one by one, in order. The order in which
5462 transports are defined does not matter at all. The order in which
5463 authenticators are defined is used only when Exim, as a client, is searching
5464 them to find one that matches an authentication mechanism offered by the
5465 server.
5466
5467 .cindex "generic options"
5468 .cindex "options" "generic &-- definition of"
5469 Within a driver instance definition, there are two kinds of option: &'generic'&
5470 and &'private'&. The generic options are those that apply to all drivers of the
5471 same type (that is, all routers, all transports or all authenticators). The
5472 &%driver%& option is a generic option that must appear in every definition.
5473 .cindex "private options"
5474 The private options are special for each driver, and none need appear, because
5475 they all have default values.
5476
5477 The options may appear in any order, except that the &%driver%& option must
5478 precede any private options, since these depend on the particular driver. For
5479 this reason, it is recommended that &%driver%& always be the first option.
5480
5481 Driver instance names, which are used for reference in log entries and
5482 elsewhere, can be any sequence of letters, digits, and underscores (starting
5483 with a letter) and must be unique among drivers of the same type. A router and
5484 a transport (for example) can each have the same name, but no two router
5485 instances can have the same name. The name of a driver instance should not be
5486 confused with the name of the underlying driver module. For example, the
5487 configuration lines:
5488 .code
5489 remote_smtp:
5490   driver = smtp
5491 .endd
5492 create an instance of the &(smtp)& transport driver whose name is
5493 &(remote_smtp)&. The same driver code can be used more than once, with
5494 different instance names and different option settings each time. A second
5495 instance of the &(smtp)& transport, with different options, might be defined
5496 thus:
5497 .code
5498 special_smtp:
5499   driver = smtp
5500   port = 1234
5501   command_timeout = 10s
5502 .endd
5503 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5504 these transport instances from routers, and these names would appear in log
5505 lines.
5506
5507 Comment lines may be present in the middle of driver specifications. The full
5508 list of option settings for any particular driver instance, including all the
5509 defaulted values, can be extracted by making use of the &%-bP%& command line
5510 option.
5511
5512
5513
5514
5515
5516
5517 . ////////////////////////////////////////////////////////////////////////////
5518 . ////////////////////////////////////////////////////////////////////////////
5519
5520 .chapter "The default configuration file" "CHAPdefconfil"
5521 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5522 .cindex "default" "configuration file &""walk through""&"
5523 The default configuration file supplied with Exim as &_src/configure.default_&
5524 is sufficient for a host with simple mail requirements. As an introduction to
5525 the way Exim is configured, this chapter &"walks through"& the default
5526 configuration, giving brief explanations of the settings. Detailed descriptions
5527 of the options are given in subsequent chapters. The default configuration file
5528 itself contains extensive comments about ways you might want to modify the
5529 initial settings. However, note that there are many options that are not
5530 mentioned at all in the default configuration.
5531
5532
5533
5534 .section "Macros" "SECTdefconfmacros"
5535 All macros should be defined before any options.
5536
5537 One macro is specified, but commented out, in the default configuration:
5538 .code
5539 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5540 .endd
5541 If all off-site mail is expected to be delivered to a "smarthost", then set the
5542 hostname here and uncomment the macro.  This will affect which router is used
5543 later on.  If this is left commented out, then Exim will perform direct-to-MX
5544 deliveries using a &(dnslookup)& router.
5545
5546 In addition to macros defined here, Exim includes a number of built-in macros
5547 to enable configuration to be guarded by a binary built with support for a
5548 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5549
5550
5551 .section "Main configuration settings" "SECTdefconfmain"
5552 The main (global) configuration option settings section must always come first
5553 in the file, after the macros.
5554 The first thing you'll see in the file, after some initial comments, is the line
5555 .code
5556 # primary_hostname =
5557 .endd
5558 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5559 to know the official, fully qualified name of your host, and this is where you
5560 can specify it. However, in most cases you do not need to set this option. When
5561 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5562
5563 The first three non-comment configuration lines are as follows:
5564 .code
5565 domainlist local_domains    = @
5566 domainlist relay_to_domains =
5567 hostlist   relay_from_hosts = 127.0.0.1
5568 .endd
5569 These are not, in fact, option settings. They are definitions of two named
5570 domain lists and one named host list. Exim allows you to give names to lists of
5571 domains, hosts, and email addresses, in order to make it easier to manage the
5572 configuration file (see section &<<SECTnamedlists>>&).
5573
5574 The first line defines a domain list called &'local_domains'&; this is used
5575 later in the configuration to identify domains that are to be delivered
5576 on the local host.
5577
5578 .cindex "@ in a domain list"
5579 There is just one item in this list, the string &"@"&. This is a special form
5580 of entry which means &"the name of the local host"&. Thus, if the local host is
5581 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5582 be delivered locally. Because the local host's name is referenced indirectly,
5583 the same configuration file can be used on different hosts.
5584
5585 The second line defines a domain list called &'relay_to_domains'&, but the
5586 list itself is empty. Later in the configuration we will come to the part that
5587 controls mail relaying through the local host; it allows relaying to any
5588 domains in this list. By default, therefore, no relaying on the basis of a mail
5589 domain is permitted.
5590
5591 The third line defines a host list called &'relay_from_hosts'&. This list is
5592 used later in the configuration to permit relaying from any host or IP address
5593 that matches the list. The default contains just the IP address of the IPv4
5594 loopback interface, which means that processes on the local host are able to
5595 submit mail for relaying by sending it over TCP/IP to that interface. No other
5596 hosts are permitted to submit messages for relaying.
5597
5598 Just to be sure there's no misunderstanding: at this point in the configuration
5599 we aren't actually setting up any controls. We are just defining some domains
5600 and hosts that will be used in the controls that are specified later.
5601
5602 The next two configuration lines are genuine option settings:
5603 .code
5604 acl_smtp_rcpt = acl_check_rcpt
5605 acl_smtp_data = acl_check_data
5606 .endd
5607 These options specify &'Access Control Lists'& (ACLs) that are to be used
5608 during an incoming SMTP session for every recipient of a message (every RCPT
5609 command), and after the contents of the message have been received,
5610 respectively. The names of the lists are &'acl_check_rcpt'& and
5611 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5612 section of the configuration. The RCPT ACL controls which recipients are
5613 accepted for an incoming message &-- if a configuration does not provide an ACL
5614 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5615 contents of a message to be checked.
5616
5617 Two commented-out option settings are next:
5618 .code
5619 # av_scanner = clamd:/tmp/clamd
5620 # spamd_address = 127.0.0.1 783
5621 .endd
5622 These are example settings that can be used when Exim is compiled with the
5623 content-scanning extension. The first specifies the interface to the virus
5624 scanner, and the second specifies the interface to SpamAssassin. Further
5625 details are given in chapter &<<CHAPexiscan>>&.
5626
5627 Three more commented-out option settings follow:
5628 .code
5629 # tls_advertise_hosts = *
5630 # tls_certificate = /etc/ssl/exim.crt
5631 # tls_privatekey = /etc/ssl/exim.pem
5632 .endd
5633 These are example settings that can be used when Exim is compiled with
5634 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5635 first one specifies the list of clients that are allowed to use TLS when
5636 connecting to this server; in this case, the wildcard means all clients. The
5637 other options specify where Exim should find its TLS certificate and private
5638 key, which together prove the server's identity to any clients that connect.
5639 More details are given in chapter &<<CHAPTLS>>&.
5640
5641 Another two commented-out option settings follow:
5642 .code
5643 # daemon_smtp_ports = 25 : 465 : 587
5644 # tls_on_connect_ports = 465
5645 .endd
5646 .cindex "port" "465 and 587"
5647 .cindex "port" "for message submission"
5648 .cindex "message" "submission, ports for"
5649 .cindex "submissions protocol"
5650 .cindex "smtps protocol"
5651 .cindex "ssmtp protocol"
5652 .cindex "SMTP" "submissions protocol"
5653 .cindex "SMTP" "ssmtp protocol"
5654 .cindex "SMTP" "smtps protocol"
5655 These options provide better support for roaming users who wish to use this
5656 server for message submission. They are not much use unless you have turned on
5657 TLS (as described in the previous paragraph) and authentication (about which
5658 more in section &<<SECTdefconfauth>>&).
5659 Mail submission from mail clients (MUAs) should be separate from inbound mail
5660 to your domain (MX delivery) for various good reasons (eg, ability to impose
5661 much saner TLS protocol and ciphersuite requirements without unintended
5662 consequences).
5663 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5664 which uses STARTTLS, so this is the &"submission"& port.
5665 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5666 which should be used in preference to 587.
5667 You should also consider deploying SRV records to help clients find
5668 these ports.
5669 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5670
5671 Two more commented-out options settings follow:
5672 .code
5673 # qualify_domain =
5674 # qualify_recipient =
5675 .endd
5676 The first of these specifies a domain that Exim uses when it constructs a
5677 complete email address from a local login name. This is often needed when Exim
5678 receives a message from a local process. If you do not set &%qualify_domain%&,
5679 the value of &%primary_hostname%& is used. If you set both of these options,
5680 you can have different qualification domains for sender and recipient
5681 addresses. If you set only the first one, its value is used in both cases.
5682
5683 .cindex "domain literal" "recognizing format"
5684 The following line must be uncommented if you want Exim to recognize
5685 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5686 (an IP address within square brackets) instead of a named domain.
5687 .code
5688 # allow_domain_literals
5689 .endd
5690 The RFCs still require this form, but many people think that in the modern
5691 Internet it makes little sense to permit mail to be sent to specific hosts by
5692 quoting their IP addresses. This ancient format has been used by people who
5693 try to abuse hosts by using them for unwanted relaying. However, some
5694 people believe there are circumstances (for example, messages addressed to
5695 &'postmaster'&) where domain literals are still useful.
5696
5697 The next configuration line is a kind of trigger guard:
5698 .code
5699 never_users = root
5700 .endd
5701 It specifies that no delivery must ever be run as the root user. The normal
5702 convention is to set up &'root'& as an alias for the system administrator. This
5703 setting is a guard against slips in the configuration.
5704 The list of users specified by &%never_users%& is not, however, the complete
5705 list; the build-time configuration in &_Local/Makefile_& has an option called
5706 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5707 contents of &%never_users%& are added to this list. By default
5708 FIXED_NEVER_USERS also specifies root.
5709
5710 When a remote host connects to Exim in order to send mail, the only information
5711 Exim has about the host's identity is its IP address. The next configuration
5712 line,
5713 .code
5714 host_lookup = *
5715 .endd
5716 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5717 in order to get a host name. This improves the quality of the logging
5718 information, but if you feel it is too expensive, you can remove it entirely,
5719 or restrict the lookup to hosts on &"nearby"& networks.
5720 Note that it is not always possible to find a host name from an IP address,
5721 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5722 unreachable.
5723
5724 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5725 1413 (hence their names):
5726 .code
5727 rfc1413_hosts = *
5728 rfc1413_query_timeout = 0s
5729 .endd
5730 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5731 Few hosts offer RFC1413 service these days; calls have to be
5732 terminated by a timeout and this needlessly delays the startup
5733 of an incoming SMTP connection.
5734 If you have hosts for which you trust RFC1413 and need this
5735 information, you can change this.
5736
5737 This line enables an efficiency SMTP option.  It is negotiated by clients
5738 and not expected to cause problems but can be disabled if needed.
5739 .code
5740 prdr_enable = true
5741 .endd
5742
5743 When Exim receives messages over SMTP connections, it expects all addresses to
5744 be fully qualified with a domain, as required by the SMTP definition. However,
5745 if you are running a server to which simple clients submit messages, you may
5746 find that they send unqualified addresses. The two commented-out options:
5747 .code
5748 # sender_unqualified_hosts =
5749 # recipient_unqualified_hosts =
5750 .endd
5751 show how you can specify hosts that are permitted to send unqualified sender
5752 and recipient addresses, respectively.
5753
5754 The &%log_selector%& option is used to increase the detail of logging
5755 over the default:
5756 .code
5757 log_selector = +smtp_protocol_error +smtp_syntax_error \
5758                +tls_certificate_verified
5759 .endd
5760
5761 The &%percent_hack_domains%& option is also commented out:
5762 .code
5763 # percent_hack_domains =
5764 .endd
5765 It provides a list of domains for which the &"percent hack"& is to operate.
5766 This is an almost obsolete form of explicit email routing. If you do not know
5767 anything about it, you can safely ignore this topic.
5768
5769 The next two settings in the main part of the default configuration are
5770 concerned with messages that have been &"frozen"& on Exim's queue. When a
5771 message is frozen, Exim no longer continues to try to deliver it. Freezing
5772 occurs when a bounce message encounters a permanent failure because the sender
5773 address of the original message that caused the bounce is invalid, so the
5774 bounce cannot be delivered. This is probably the most common case, but there
5775 are also other conditions that cause freezing, and frozen messages are not
5776 always bounce messages.
5777 .code
5778 ignore_bounce_errors_after = 2d
5779 timeout_frozen_after = 7d
5780 .endd
5781 The first of these options specifies that failing bounce messages are to be
5782 discarded after 2 days in the queue. The second specifies that any frozen
5783 message (whether a bounce message or not) is to be timed out (and discarded)
5784 after a week. In this configuration, the first setting ensures that no failing
5785 bounce message ever lasts a week.
5786
5787 Exim queues it's messages in a spool directory. If you expect to have
5788 large queues, you may consider using this option. It splits the spool
5789 directory into subdirectories to avoid file system degradation from
5790 many files in a single directory, resulting in better performance.
5791 Manual manipulation of queued messages becomes more complex (though fortunately
5792 not often needed).
5793 .code
5794 # split_spool_directory = true
5795 .endd
5796
5797 In an ideal world everybody follows the standards. For non-ASCII
5798 messages RFC 2047 is a standard, allowing a maximum line length of 76
5799 characters. Exim adheres that standard and won't process messages which
5800 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5801 In particular, the Exim maintainers have had multiple reports of
5802 problems from Russian administrators of issues until they disable this
5803 check, because of some popular, yet buggy, mail composition software.
5804 .code
5805 # check_rfc2047_length = false
5806 .endd
5807
5808 If you need to be strictly RFC compliant you may wish to disable the
5809 8BITMIME advertisement. Use this, if you exchange mails with systems
5810 that are not 8-bit clean.
5811 .code
5812 # accept_8bitmime = false
5813 .endd
5814
5815 Libraries you use may depend on specific environment settings.  This
5816 imposes a security risk (e.g. PATH). There are two lists:
5817 &%keep_environment%& for the variables to import as they are, and
5818 &%add_environment%& for variables we want to set to a fixed value.
5819 Note that TZ is handled separately, by the &%timezone%& runtime
5820 option and by the TIMEZONE_DEFAULT buildtime option.
5821 .code
5822 # keep_environment = ^LDAP
5823 # add_environment = PATH=/usr/bin::/bin
5824 .endd
5825
5826
5827 .section "ACL configuration" "SECID54"
5828 .cindex "default" "ACLs"
5829 .cindex "&ACL;" "default configuration"
5830 In the default configuration, the ACL section follows the main configuration.
5831 It starts with the line
5832 .code
5833 begin acl
5834 .endd
5835 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5836 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5837 and &%acl_smtp_data%& above.
5838
5839 .cindex "RCPT" "ACL for"
5840 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5841 RCPT command specifies one of the message's recipients. The ACL statements
5842 are considered in order, until the recipient address is either accepted or
5843 rejected. The RCPT command is then accepted or rejected, according to the
5844 result of the ACL processing.
5845 .code
5846 acl_check_rcpt:
5847 .endd
5848 This line, consisting of a name terminated by a colon, marks the start of the
5849 ACL, and names it.
5850 .code
5851 accept  hosts = :
5852 .endd
5853 This ACL statement accepts the recipient if the sending host matches the list.
5854 But what does that strange list mean? It doesn't actually contain any host
5855 names or IP addresses. The presence of the colon puts an empty item in the
5856 list; Exim matches this only if the incoming message did not come from a remote
5857 host, because in that case, the remote hostname is empty. The colon is
5858 important. Without it, the list itself is empty, and can never match anything.
5859
5860 What this statement is doing is to accept unconditionally all recipients in
5861 messages that are submitted by SMTP from local processes using the standard
5862 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5863 manner.
5864 .code
5865 deny    domains       = +local_domains
5866         local_parts   = ^[.] : ^.*[@%!/|]
5867         message       = Restricted characters in address
5868
5869 deny    domains       = !+local_domains
5870         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5871         message       = Restricted characters in address
5872 .endd
5873 These statements are concerned with local parts that contain any of the
5874 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5875 Although these characters are entirely legal in local parts (in the case of
5876 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5877 in Internet mail addresses.
5878
5879 The first three have in the past been associated with explicitly routed
5880 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5881 option). Addresses containing these characters are regularly tried by spammers
5882 in an attempt to bypass relaying restrictions, and also by open relay testing
5883 programs. Unless you really need them it is safest to reject these characters
5884 at this early stage. This configuration is heavy-handed in rejecting these
5885 characters for all messages it accepts from remote hosts. This is a deliberate
5886 policy of being as safe as possible.
5887
5888 The first rule above is stricter, and is applied to messages that are addressed
5889 to one of the local domains handled by this host. This is implemented by the
5890 first condition, which restricts it to domains that are listed in the
5891 &'local_domains'& domain list. The &"+"& character is used to indicate a
5892 reference to a named list. In this configuration, there is just one domain in
5893 &'local_domains'&, but in general there may be many.
5894
5895 The second condition on the first statement uses two regular expressions to
5896 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5897 or &"|"&. If you have local accounts that include these characters, you will
5898 have to modify this rule.
5899
5900 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5901 allows them because they have been encountered in practice. (Consider the
5902 common convention of local parts constructed as
5903 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5904 the author of Exim, who has no second initial.) However, a local part starting
5905 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5906 filename (for example, for a mailing list). This is also true for local parts
5907 that contain slashes. A pipe symbol can also be troublesome if the local part
5908 is incorporated unthinkingly into a shell command line.
5909
5910 The second rule above applies to all other domains, and is less strict. This
5911 allows your own users to send outgoing messages to sites that use slashes
5912 and vertical bars in their local parts. It blocks local parts that begin
5913 with a dot, slash, or vertical bar, but allows these characters within the
5914 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5915 and &"!"& is blocked, as before. The motivation here is to prevent your users
5916 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5917 .code
5918 accept  local_parts   = postmaster
5919         domains       = +local_domains
5920 .endd
5921 This statement, which has two conditions, accepts an incoming address if the
5922 local part is &'postmaster'& and the domain is one of those listed in the
5923 &'local_domains'& domain list. The &"+"& character is used to indicate a
5924 reference to a named list. In this configuration, there is just one domain in
5925 &'local_domains'&, but in general there may be many.
5926
5927 The presence of this statement means that mail to postmaster is never blocked
5928 by any of the subsequent tests. This can be helpful while sorting out problems
5929 in cases where the subsequent tests are incorrectly denying access.
5930 .code
5931 require verify        = sender
5932 .endd
5933 This statement requires the sender address to be verified before any subsequent
5934 ACL statement can be used. If verification fails, the incoming recipient
5935 address is refused. Verification consists of trying to route the address, to
5936 see if a bounce message could be delivered to it. In the case of remote
5937 addresses, basic verification checks only the domain, but &'callouts'& can be
5938 used for more verification if required. Section &<<SECTaddressverification>>&
5939 discusses the details of address verification.
5940 .code
5941 accept  hosts         = +relay_from_hosts
5942         control       = submission
5943 .endd
5944 This statement accepts the address if the message is coming from one of the
5945 hosts that are defined as being allowed to relay through this host. Recipient
5946 verification is omitted here, because in many cases the clients are dumb MUAs
5947 that do not cope well with SMTP error responses. For the same reason, the
5948 second line specifies &"submission mode"& for messages that are accepted. This
5949 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5950 messages that are deficient in some way, for example, because they lack a
5951 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5952 probably add recipient verification here, and disable submission mode.
5953 .code
5954 accept  authenticated = *
5955         control       = submission
5956 .endd
5957 This statement accepts the address if the client host has authenticated itself.
5958 Submission mode is again specified, on the grounds that such messages are most
5959 likely to come from MUAs. The default configuration does not define any
5960 authenticators, though it does include some nearly complete commented-out
5961 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5962 fact authenticate until you complete the authenticator definitions.
5963 .code
5964 require message = relay not permitted
5965         domains = +local_domains : +relay_to_domains
5966 .endd
5967 This statement rejects the address if its domain is neither a local domain nor
5968 one of the domains for which this host is a relay.
5969 .code
5970 require verify = recipient
5971 .endd
5972 This statement requires the recipient address to be verified; if verification
5973 fails, the address is rejected.
5974 .code
5975 # deny    dnslists    = black.list.example
5976 #         message     = rejected because $sender_host_address \
5977 #                       is in a black list at $dnslist_domain\n\
5978 #                       $dnslist_text
5979 #
5980 # warn    dnslists    = black.list.example
5981 #         add_header  = X-Warning: $sender_host_address is in \
5982 #                       a black list at $dnslist_domain
5983 #         log_message = found in $dnslist_domain
5984 .endd
5985 These commented-out lines are examples of how you could configure Exim to check
5986 sending hosts against a DNS black list. The first statement rejects messages
5987 from blacklisted hosts, whereas the second just inserts a warning header
5988 line.
5989 .code
5990 # require verify = csa
5991 .endd
5992 This commented-out line is an example of how you could turn on client SMTP
5993 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5994 records.
5995 .code
5996 accept
5997 .endd
5998 The final statement in the first ACL unconditionally accepts any recipient
5999 address that has successfully passed all the previous tests.
6000 .code
6001 acl_check_data:
6002 .endd
6003 This line marks the start of the second ACL, and names it. Most of the contents
6004 of this ACL are commented out:
6005 .code
6006 # deny    malware   = *
6007 #         message   = This message contains a virus \
6008 #                     ($malware_name).
6009 .endd
6010 These lines are examples of how to arrange for messages to be scanned for
6011 viruses when Exim has been compiled with the content-scanning extension, and a
6012 suitable virus scanner is installed. If the message is found to contain a
6013 virus, it is rejected with the given custom error message.
6014 .code
6015 # warn    spam      = nobody
6016 #         message   = X-Spam_score: $spam_score\n\
6017 #                     X-Spam_score_int: $spam_score_int\n\
6018 #                     X-Spam_bar: $spam_bar\n\
6019 #                     X-Spam_report: $spam_report
6020 .endd
6021 These lines are an example of how to arrange for messages to be scanned by
6022 SpamAssassin when Exim has been compiled with the content-scanning extension,
6023 and SpamAssassin has been installed. The SpamAssassin check is run with
6024 &`nobody`& as its user parameter, and the results are added to the message as a
6025 series of extra header line. In this case, the message is not rejected,
6026 whatever the spam score.
6027 .code
6028 accept
6029 .endd
6030 This final line in the DATA ACL accepts the message unconditionally.
6031
6032
6033 .section "Router configuration" "SECID55"
6034 .cindex "default" "routers"
6035 .cindex "routers" "default"
6036 The router configuration comes next in the default configuration, introduced
6037 by the line
6038 .code
6039 begin routers
6040 .endd
6041 Routers are the modules in Exim that make decisions about where to send
6042 messages. An address is passed to each router, in turn, until it is either
6043 accepted, or failed. This means that the order in which you define the routers
6044 matters. Each router is fully described in its own chapter later in this
6045 manual. Here we give only brief overviews.
6046 .code
6047 # domain_literal:
6048 #   driver = ipliteral
6049 #   domains = !+local_domains
6050 #   transport = remote_smtp
6051 .endd
6052 .cindex "domain literal" "default router"
6053 This router is commented out because the majority of sites do not want to
6054 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6055 you uncomment this router, you also need to uncomment the setting of
6056 &%allow_domain_literals%& in the main part of the configuration.
6057
6058 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6059 macro has been defined, per
6060 .code
6061 .ifdef ROUTER_SMARTHOST
6062 smarthost:
6063 #...
6064 .else
6065 dnslookup:
6066 #...
6067 .endif
6068 .endd
6069
6070 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6071 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6072 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6073 skip these routers because of the &%domains%& option.
6074
6075 .code
6076 smarthost:
6077   driver = manualroute
6078   domains = ! +local_domains
6079   transport = smarthost_smtp
6080   route_data = ROUTER_SMARTHOST
6081   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6082   no_more
6083 .endd
6084 This router only handles mail which is not to any local domains; this is
6085 specified by the line
6086 .code
6087 domains = ! +local_domains
6088 .endd
6089 The &%domains%& option lists the domains to which this router applies, but the
6090 exclamation mark is a negation sign, so the router is used only for domains
6091 that are not in the domain list called &'local_domains'& (which was defined at
6092 the start of the configuration). The plus sign before &'local_domains'&
6093 indicates that it is referring to a named list. Addresses in other domains are
6094 passed on to the following routers.
6095
6096 The name of the router driver is &(manualroute)& because we are manually
6097 specifying how mail should be routed onwards, instead of using DNS MX.
6098 While the name of this router instance is arbitrary, the &%driver%& option must
6099 be one of the driver modules that is in the Exim binary.
6100
6101 With no pre-conditions other than &%domains%&, all mail for non-local domains
6102 will be handled by this router, and the &%no_more%& setting will ensure that no
6103 other routers will be used for messages matching the pre-conditions.  See
6104 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6105 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6106 and the macro supplies the value; the address is then queued for the
6107 &(smarthost_smtp)& transport.
6108
6109 .code
6110 dnslookup:
6111   driver = dnslookup
6112   domains = ! +local_domains
6113   transport = remote_smtp
6114   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6115   no_more
6116 .endd
6117 The &%domains%& option behaves as per smarthost, above.
6118
6119 The name of the router driver is &(dnslookup)&,
6120 and is specified by the &%driver%& option. Do not be confused by the fact that
6121 the name of this router instance is the same as the name of the driver. The
6122 instance name is arbitrary, but the name set in the &%driver%& option must be
6123 one of the driver modules that is in the Exim binary.
6124
6125 The &(dnslookup)& router routes addresses by looking up their domains in the
6126 DNS in order to obtain a list of hosts to which the address is routed. If the
6127 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6128 specified by the &%transport%& option. If the router does not find the domain
6129 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6130 the address fails and is bounced.
6131
6132 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6133 be entirely ignored. This option is present because a number of cases have been
6134 encountered where MX records in the DNS point to host names
6135 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6136 Completely ignoring these IP addresses causes Exim to fail to route the
6137 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6138 continue to try to deliver the message periodically until the address timed
6139 out.
6140 .code
6141 system_aliases:
6142   driver = redirect
6143   allow_fail
6144   allow_defer
6145   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6146 # user = exim
6147   file_transport = address_file
6148   pipe_transport = address_pipe
6149 .endd
6150 Control reaches this and subsequent routers only for addresses in the local
6151 domains. This router checks to see whether the local part is defined as an
6152 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6153 data that it looks up from that file. If no data is found for the local part,
6154 the value of the &%data%& option is empty, causing the address to be passed to
6155 the next router.
6156
6157 &_/etc/aliases_& is a conventional name for the system aliases file that is
6158 often used. That is why it is referenced by from the default configuration
6159 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6160 &_Local/Makefile_& before building Exim.
6161 .code
6162 userforward:
6163   driver = redirect
6164   check_local_user
6165 # local_part_suffix = +* : -*
6166 # local_part_suffix_optional
6167   file = $home/.forward
6168 # allow_filter
6169   no_verify
6170   no_expn
6171   check_ancestor
6172   file_transport = address_file
6173   pipe_transport = address_pipe
6174   reply_transport = address_reply
6175 .endd
6176 This is the most complicated router in the default configuration. It is another
6177 redirection router, but this time it is looking for forwarding data set up by
6178 individual users. The &%check_local_user%& setting specifies a check that the
6179 local part of the address is the login name of a local user. If it is not, the
6180 router is skipped. The two commented options that follow &%check_local_user%&,
6181 namely:
6182 .code
6183 # local_part_suffix = +* : -*
6184 # local_part_suffix_optional
6185 .endd
6186 .vindex "&$local_part_suffix$&"
6187 show how you can specify the recognition of local part suffixes. If the first
6188 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6189 by any sequence of characters, is removed from the local part and placed in the
6190 variable &$local_part_suffix$&. The second suffix option specifies that the
6191 presence of a suffix in the local part is optional. When a suffix is present,
6192 the check for a local login uses the local part with the suffix removed.
6193
6194 When a local user account is found, the file called &_.forward_& in the user's
6195 home directory is consulted. If it does not exist, or is empty, the router
6196 declines. Otherwise, the contents of &_.forward_& are interpreted as
6197 redirection data (see chapter &<<CHAPredirect>>& for more details).
6198
6199 .cindex "Sieve filter" "enabling in default router"
6200 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6201 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6202 is commented out by default), the contents of the file are interpreted as a set
6203 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6204 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6205 separate document entitled &'Exim's interfaces to mail filtering'&.
6206
6207 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6208 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6209 There are two reasons for doing this:
6210
6211 .olist
6212 Whether or not a local user has a &_.forward_& file is not really relevant when
6213 checking an address for validity; it makes sense not to waste resources doing
6214 unnecessary work.
6215 .next
6216 More importantly, when Exim is verifying addresses or handling an EXPN
6217 command during an SMTP session, it is running as the Exim user, not as root.
6218 The group is the Exim group, and no additional groups are set up.
6219 It may therefore not be possible for Exim to read users' &_.forward_& files at
6220 this time.
6221 .endlist
6222
6223 The setting of &%check_ancestor%& prevents the router from generating a new
6224 address that is the same as any previous address that was redirected. (This
6225 works round a problem concerning a bad interaction between aliasing and
6226 forwarding &-- see section &<<SECTredlocmai>>&).
6227
6228 The final three option settings specify the transports that are to be used when
6229 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6230 auto-reply, respectively. For example, if a &_.forward_& file contains
6231 .code
6232 a.nother@elsewhere.example, /home/spqr/archive
6233 .endd
6234 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6235 transport.
6236 .code
6237 localuser:
6238   driver = accept
6239   check_local_user
6240 # local_part_suffix = +* : -*
6241 # local_part_suffix_optional
6242   transport = local_delivery
6243 .endd
6244 The final router sets up delivery into local mailboxes, provided that the local
6245 part is the name of a local login, by accepting the address and assigning it to
6246 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6247 routers, so the address is bounced. The commented suffix settings fulfil the
6248 same purpose as they do for the &(userforward)& router.
6249
6250
6251 .section "Transport configuration" "SECID56"
6252 .cindex "default" "transports"
6253 .cindex "transports" "default"
6254 Transports define mechanisms for actually delivering messages. They operate
6255 only when referenced from routers, so the order in which they are defined does
6256 not matter. The transports section of the configuration starts with
6257 .code
6258 begin transports
6259 .endd
6260 Two remote transports and four local transports are defined.
6261 .code
6262 remote_smtp:
6263   driver = smtp
6264   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6265 .ifdef _HAVE_PRDR
6266   hosts_try_prdr = *
6267 .endif
6268 .endd
6269 This transport is used for delivering messages over SMTP connections.
6270 The list of remote hosts comes from the router.
6271 The &%message_size_limit%& usage is a hack to avoid sending on messages
6272 with over-long lines.
6273
6274 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6275 negotiated between client and server and not expected to cause problems
6276 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6277 use of the &%hosts_try_prdr%& configuration option.
6278
6279 The other remote transport is used when delivering to a specific smarthost
6280 with whom there must be some kind of existing relationship, instead of the
6281 usual federated system.
6282
6283 .code
6284 smarthost_smtp:
6285   driver = smtp
6286   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6287   multi_domain
6288   #
6289 .ifdef _HAVE_TLS
6290   # Comment out any of these which you have to, then file a Support
6291   # request with your smarthost provider to get things fixed:
6292   hosts_require_tls = *
6293   tls_verify_hosts = *
6294   # As long as tls_verify_hosts is enabled, this this will have no effect,
6295   # but if you have to comment it out then this will at least log whether
6296   # you succeed or not:
6297   tls_try_verify_hosts = *
6298   #
6299   # The SNI name should match the name which we'll expect to verify;
6300   # many mail systems don't use SNI and this doesn't matter, but if it does,
6301   # we need to send a name which the remote site will recognize.
6302   # This _should_ be the name which the smarthost operators specified as
6303   # the hostname for sending your mail to.
6304   tls_sni = ROUTER_SMARTHOST
6305   #
6306 .ifdef _HAVE_OPENSSL
6307   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6308 .endif
6309 .ifdef _HAVE_GNUTLS
6310   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6311 .endif
6312 .endif
6313 .ifdef _HAVE_PRDR
6314   hosts_try_prdr = *
6315 .endif
6316 .endd
6317 After the same &%message_size_limit%& hack, we then specify that this Transport
6318 can handle messages to multiple domains in one run.  The assumption here is
6319 that you're routing all non-local mail to the same place and that place is
6320 happy to take all messages from you as quickly as possible.
6321 All other options depend upon built-in macros; if Exim was built without TLS support
6322 then no other options are defined.
6323 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6324 and versions using the &%tls_require_ciphers%& option, where the value to be
6325 used depends upon the library providing TLS.
6326 Beyond that, the options adopt the stance that you should have TLS support available
6327 from your smarthost on today's Internet, so we turn on requiring TLS for the
6328 mail to be delivered, and requiring that the certificate be valid, and match
6329 the expected hostname.  The &%tls_sni%& option can be used by service providers
6330 to select an appropriate certificate to present to you and here we re-use the
6331 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6332 You want to specify the hostname which you'll expect to validate for, and that
6333 should not be subject to insecure tampering via DNS results.
6334
6335 For the &%hosts_try_prdr%& option see the previous transport.
6336
6337 All other options are defaulted.
6338 .code
6339 local_delivery:
6340   driver = appendfile
6341   file = /var/mail/$local_part_data
6342   delivery_date_add
6343   envelope_to_add
6344   return_path_add
6345 # group = mail
6346 # mode = 0660
6347 .endd
6348 This &(appendfile)& transport is used for local delivery to user mailboxes in
6349 traditional BSD mailbox format.
6350
6351 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6352 as it is provided by a potential bad actor.
6353 Instead we use &$local_part_data$&,
6354 the result of looking up &$local_part$& in the user database
6355 (done by using &%check_local_user%& in the the router).
6356
6357 By default &(appendfile)& runs under the uid and gid of the
6358 local user, which requires the sticky bit to be set on the &_/var/mail_&
6359 directory. Some systems use the alternative approach of running mail deliveries
6360 under a particular group instead of using the sticky bit. The commented options
6361 show how this can be done.
6362
6363 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6364 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6365 similarly-named options above.
6366 .code
6367 address_pipe:
6368   driver = pipe
6369   return_output
6370 .endd
6371 This transport is used for handling deliveries to pipes that are generated by
6372 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6373 option specifies that any output on stdout or stderr generated by the pipe is to
6374 be returned to the sender.
6375 .code
6376 address_file:
6377   driver = appendfile
6378   delivery_date_add
6379   envelope_to_add
6380   return_path_add
6381 .endd
6382 This transport is used for handling deliveries to files that are generated by
6383 redirection. The name of the file is not specified in this instance of
6384 &(appendfile)&, because it comes from the &(redirect)& router.
6385 .code
6386 address_reply:
6387   driver = autoreply
6388 .endd
6389 This transport is used for handling automatic replies generated by users'
6390 filter files.
6391
6392
6393
6394 .section "Default retry rule" "SECID57"
6395 .cindex "retry" "default rule"
6396 .cindex "default" "retry rule"
6397 The retry section of the configuration file contains rules which affect the way
6398 Exim retries deliveries that cannot be completed at the first attempt. It is
6399 introduced by the line
6400 .code
6401 begin retry
6402 .endd
6403 In the default configuration, there is just one rule, which applies to all
6404 errors:
6405 .code
6406 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6407 .endd
6408 This causes any temporarily failing address to be retried every 15 minutes for
6409 2 hours, then at intervals starting at one hour and increasing by a factor of
6410 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6411 is not delivered after 4 days of temporary failure, it is bounced. The time is
6412 measured from first failure, not from the time the message was received.
6413
6414 If the retry section is removed from the configuration, or is empty (that is,
6415 if no retry rules are defined), Exim will not retry deliveries. This turns
6416 temporary errors into permanent errors.
6417
6418
6419 .section "Rewriting configuration" "SECID58"
6420 The rewriting section of the configuration, introduced by
6421 .code
6422 begin rewrite
6423 .endd
6424 contains rules for rewriting addresses in messages as they arrive. There are no
6425 rewriting rules in the default configuration file.
6426
6427
6428
6429 .section "Authenticators configuration" "SECTdefconfauth"
6430 .cindex "AUTH" "configuration"
6431 The authenticators section of the configuration, introduced by
6432 .code
6433 begin authenticators
6434 .endd
6435 defines mechanisms for the use of the SMTP AUTH command. The default
6436 configuration file contains two commented-out example authenticators
6437 which support plaintext username/password authentication using the
6438 standard PLAIN mechanism and the traditional but non-standard LOGIN
6439 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6440 to support most MUA software.
6441
6442 The example PLAIN authenticator looks like this:
6443 .code
6444 #PLAIN:
6445 #  driver                  = plaintext
6446 #  server_set_id           = $auth2
6447 #  server_prompts          = :
6448 #  server_condition        = Authentication is not yet configured
6449 #  server_advertise_condition = ${if def:tls_in_cipher }
6450 .endd
6451 And the example LOGIN authenticator looks like this:
6452 .code
6453 #LOGIN:
6454 #  driver                  = plaintext
6455 #  server_set_id           = $auth1
6456 #  server_prompts          = <| Username: | Password:
6457 #  server_condition        = Authentication is not yet configured
6458 #  server_advertise_condition = ${if def:tls_in_cipher }
6459 .endd
6460
6461 The &%server_set_id%& option makes Exim remember the authenticated username
6462 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6463 &%server_prompts%& option configures the &(plaintext)& authenticator so
6464 that it implements the details of the specific authentication mechanism,
6465 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6466 when Exim offers authentication to clients; in the examples, this is only
6467 when TLS or SSL has been started, so to enable the authenticators you also
6468 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6469
6470 The &%server_condition%& setting defines how to verify that the username and
6471 password are correct. In the examples it just produces an error message.
6472 To make the authenticators work, you can use a string expansion
6473 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6474
6475 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6476 usercode and password are in different positions.
6477 Chapter &<<CHAPplaintext>>& covers both.
6478
6479 .ecindex IIDconfiwal
6480
6481
6482
6483 . ////////////////////////////////////////////////////////////////////////////
6484 . ////////////////////////////////////////////////////////////////////////////
6485
6486 .chapter "Regular expressions" "CHAPregexp"
6487
6488 .cindex "regular expressions" "library"
6489 .cindex "PCRE2"
6490 Exim supports the use of regular expressions in many of its options. It
6491 uses the PCRE2 regular expression library; this provides regular expression
6492 matching that is compatible with Perl 5. The syntax and semantics of
6493 regular expressions is discussed in
6494 online Perl manpages, in
6495 many Perl reference books, and also in
6496 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6497 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6498 . --- the http: URL here redirects to another page with the ISBN in the URL
6499 . --- where trying to use https: just redirects back to http:, so sticking
6500 . --- to the old URL for now.  2018-09-07.
6501
6502 The documentation for the syntax and semantics of the regular expressions that
6503 are supported by PCRE2 is included in the PCRE2 distribution, and no further
6504 description is included here. The PCRE2 functions are called from Exim using
6505 the default option settings (that is, with no PCRE2 options set), except that
6506 the PCRE2_CASELESS option is set when the matching is required to be
6507 case-insensitive.
6508
6509 In most cases, when a regular expression is required in an Exim configuration,
6510 it has to start with a circumflex, in order to distinguish it from plain text
6511 or an &"ends with"& wildcard. In this example of a configuration setting, the
6512 second item in the colon-separated list is a regular expression.
6513 .code
6514 domains = a.b.c : ^\\d{3} : *.y.z : ...
6515 .endd
6516 The doubling of the backslash is required because of string expansion that
6517 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6518 of this issue, and a way of avoiding the need for doubling backslashes. The
6519 regular expression that is eventually used in this example contains just one
6520 backslash. The circumflex is included in the regular expression, and has the
6521 normal effect of &"anchoring"& it to the start of the string that is being
6522 matched.
6523
6524 There are, however, two cases where a circumflex is not required for the
6525 recognition of a regular expression: these are the &%match%& condition in a
6526 string expansion, and the &%matches%& condition in an Exim filter file. In
6527 these cases, the relevant string is always treated as a regular expression; if
6528 it does not start with a circumflex, the expression is not anchored, and can
6529 match anywhere in the subject string.
6530
6531 In all cases, if you want a regular expression to match at the end of a string,
6532 you must code the $ metacharacter to indicate this. For example:
6533 .code
6534 domains = ^\\d{3}\\.example
6535 .endd
6536 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6537 You need to use:
6538 .code
6539 domains = ^\\d{3}\\.example\$
6540 .endd
6541 if you want &'example'& to be the top-level domain. The backslash before the
6542 $ is needed because string expansion also interprets dollar characters.
6543
6544
6545
6546 . ////////////////////////////////////////////////////////////////////////////
6547 . ////////////////////////////////////////////////////////////////////////////
6548
6549 .chapter "File and database lookups" "CHAPfdlookup"
6550 .scindex IIDfidalo1 "file" "lookups"
6551 .scindex IIDfidalo2 "database" "lookups"
6552 .cindex "lookup" "description of"
6553 Exim can be configured to look up data in files or databases as it processes
6554 messages. Two different kinds of syntax are used:
6555
6556 .olist
6557 A string that is to be expanded may contain explicit lookup requests. These
6558 cause parts of the string to be replaced by data that is obtained from the
6559 lookup. Lookups of this type are conditional expansion items. Different results
6560 can be defined for the cases of lookup success and failure. See chapter
6561 &<<CHAPexpand>>&, where string expansions are described in detail.
6562 The key for the lookup is &*specified*& as part of the string to be expanded.
6563 .next
6564 Lists of domains, hosts, and email addresses can contain lookup requests as a
6565 way of avoiding excessively long linear lists. In this case, the data that is
6566 returned by the lookup is often (but not always) discarded; whether the lookup
6567 succeeds or fails is what really counts. These kinds of list are described in
6568 chapter &<<CHAPdomhosaddlists>>&.
6569 Depending on the lookup type (see below)
6570 the key for the lookup may need to be &*specified*& as above
6571 or may be &*implicit*&,
6572 given by the context in which the list is being checked.
6573 .endlist
6574
6575 String expansions, lists, and lookups interact with each other in such a way
6576 that there is no order in which to describe any one of them that does not
6577 involve references to the others. Each of these three chapters makes more sense
6578 if you have read the other two first. If you are reading this for the first
6579 time, be aware that some of it will make a lot more sense after you have read
6580 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6581
6582 .section "Examples of different lookup syntax" "SECID60"
6583 It is easy to confuse the two different kinds of lookup, especially as the
6584 lists that may contain the second kind are always expanded before being
6585 processed as lists. Therefore, they may also contain lookups of the first kind.
6586 Be careful to distinguish between the following two examples:
6587 .code
6588 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6589 domains = lsearch;/some/file
6590 .endd
6591 .ilist
6592 The first uses a string expansion, the result of which must be a domain list.
6593 The key for an expansion-style lookup must be given explicitly.
6594 No strings have been specified for a successful or a failing lookup; the
6595 defaults in this case are the looked-up data and an empty string, respectively.
6596 The expansion takes place before the string is processed as a list, and the
6597 file that is searched could contain lines like this:
6598 .code
6599 192.168.3.4: domain1:domain2:...
6600 192.168.1.9: domain3:domain4:...
6601 .endd
6602 When the lookup succeeds, the result of the expansion is a list of domains (and
6603 possibly other types of item that are allowed in domain lists).
6604 .cindex "tainted data" "de-tainting"
6605 .cindex "de-tainting" "using a lookup expansion""
6606 The result of the expansion is not tainted.
6607
6608 .next
6609 In the second example, the lookup is a single item in a domain list. It causes
6610 Exim to use a lookup to see if the domain that is being processed can be found
6611 in the file.
6612 The file could contains lines like this:
6613 .code
6614 domain1:
6615 domain2:
6616 .endd
6617 Any data that follows the keys is not relevant when checking that the domain
6618 matches the list item.
6619
6620 The key for a list-style lookup is implicit, from the lookup context, if
6621 the lookup is a single-key type (see below).
6622 For query-style lookup types the query must be given explicitly.
6623 .endlist
6624
6625 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6626 Consider a file containing lines like this:
6627 .code
6628 192.168.5.6: lsearch;/another/file
6629 .endd
6630 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6631 first &%domains%& setting above generates the second setting, which therefore
6632 causes a second lookup to occur.
6633
6634 The lookup type may optionally be followed by a comma
6635 and a comma-separated list of options.
6636 Each option is a &"name=value"& pair.
6637 Whether an option is meaningful depends on the lookup type.
6638
6639 All lookups support the option &"cache=no_rd"&.
6640 If this is given then the cache that Exim manages for lookup results
6641 is not checked before doing the lookup.
6642 The result of the lookup is still written to the cache.
6643
6644 The rest of this chapter describes the different lookup types that are
6645 available. Any of them can be used in any part of the configuration where a
6646 lookup is permitted.
6647
6648
6649 .section "Lookup types" "SECID61"
6650 .cindex "lookup" "types of"
6651 .cindex "single-key lookup" "definition of"
6652 Two different types of data lookup are implemented:
6653
6654 .ilist
6655 The &'single-key'& type requires the specification of a file in which to look,
6656 and a single key to search for. The key must be a non-empty string for the
6657 lookup to succeed. The lookup type determines how the file is searched.
6658 .cindex "tainted data" "single-key lookups"
6659 The file string may not be tainted.
6660
6661 .cindex "tainted data" "de-tainting"
6662 .cindex "de-tainting" "using a single-key lookup"
6663 All single-key lookups support the option &"ret=key"&.
6664 If this is given and the lookup
6665 (either underlying implementation or cached value)
6666 returns data, the result is replaced with a non-tainted
6667 version of the lookup key.
6668
6669 .next
6670 .cindex "query-style lookup" "definition of"
6671 The &'query-style'& type accepts a generalized database query. No particular
6672 key value is assumed by Exim for query-style lookups. You can use whichever
6673 Exim variables you need to construct the database query.
6674 .cindex "tainted data" "quoting for lookups"
6675 If tainted data is used in the query then it should be quuted by
6676 using the &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*& expansion operator
6677 appropriate for the lookup.
6678 .endlist
6679
6680 The code for each lookup type is in a separate source file that is included in
6681 the binary of Exim only if the corresponding compile-time option is set. The
6682 default settings in &_src/EDITME_& are:
6683 .code
6684 LOOKUP_DBM=yes
6685 LOOKUP_LSEARCH=yes
6686 .endd
6687 which means that only linear searching and DBM lookups are included by default.
6688 For some types of lookup (e.g. SQL databases), you need to install appropriate
6689 libraries and header files before building Exim.
6690
6691
6692
6693
6694 .section "Single-key lookup types" "SECTsinglekeylookups"
6695 .cindex "lookup" "single-key types"
6696 .cindex "single-key lookup" "list of types"
6697 The following single-key lookup types are implemented:
6698
6699 .subsection cdb
6700 .cindex "cdb" "description of"
6701 .cindex "lookup" "cdb"
6702 .cindex "binary zero" "in lookup key"
6703 The given file is searched as a Constant DataBase file, using the key
6704 string without a terminating binary zero. The cdb format is designed for
6705 indexed files that are read frequently and never updated, except by total
6706 re-creation. As such, it is particularly suitable for large files containing
6707 aliases or other indexed data referenced by an MTA. Information about cdb and
6708 tools for building the files can be found in several places:
6709 .display
6710 &url(https://cr.yp.to/cdb.html)
6711 &url(https://www.corpit.ru/mjt/tinycdb.html)
6712 &url(https://packages.debian.org/stable/utils/freecdb)
6713 &url(https://github.com/philpennock/cdbtools) (in Go)
6714 .endd
6715 A cdb distribution is not needed in order to build Exim with cdb support,
6716 because the code for reading cdb files is included directly in Exim itself.
6717 However, no means of building or testing cdb files is provided with Exim, so
6718 you need to obtain a cdb distribution in order to do this.
6719
6720 .subsection dbm
6721 .cindex "DBM" "lookup type"
6722 .cindex "lookup" "dbm"
6723 .cindex "binary zero" "in lookup key"
6724 Calls to DBM library functions are used to extract data from the given
6725 DBM file by looking up the record with the given key. A terminating binary
6726 zero is included in the key that is passed to the DBM library. See section
6727 &<<SECTdb>>& for a discussion of DBM libraries.
6728
6729 .cindex "Berkeley DB library" "file format"
6730 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6731 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6732 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6733 the DB_UNKNOWN option. This enables it to handle any of the types of database
6734 that the library supports, and can be useful for accessing DBM files created by
6735 other applications. (For earlier DB versions, DB_HASH is always used.)
6736
6737 .subsection dbmjz
6738 .cindex "lookup" "dbmjz"
6739 .cindex "lookup" "dbm &-- embedded NULs"
6740 .cindex "sasldb2"
6741 .cindex "dbmjz lookup type"
6742 This is the same as &(dbm)&, except that the lookup key is
6743 interpreted as an Exim list; the elements of the list are joined together with
6744 ASCII NUL characters to form the lookup key.  An example usage would be to
6745 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6746 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6747 &(cram_md5)& authenticator.
6748
6749 .subsection dbmnz
6750 .cindex "lookup" "dbmnz"
6751 .cindex "lookup" "dbm &-- terminating zero"
6752 .cindex "binary zero" "in lookup key"
6753 .cindex "Courier"
6754 .cindex "&_/etc/userdbshadow.dat_&"
6755 .cindex "dbmnz lookup type"
6756 This is the same as &(dbm)&, except that a terminating binary zero
6757 is not included in the key that is passed to the DBM library. You may need this
6758 if you want to look up data in files that are created by or shared with some
6759 other application that does not use terminating zeros. For example, you need to
6760 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6761 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6762 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6763 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6764
6765 .subsection dsearch
6766 .cindex "lookup" "dsearch"
6767 .cindex "dsearch lookup type"
6768 The given file must be an absolute directory path; this is searched for an entry
6769 whose name is the key by calling the &[lstat()]& function.
6770 The key may not contain any forward slash characters.
6771 If &[lstat()]& succeeds then so does the lookup.
6772 .cindex "tainted data" "dsearch result"
6773 The result is regarded as untainted.
6774
6775 Options for the lookup can be given by appending them after the word "dsearch",
6776 separated by a comma.  Options, if present, are a comma-separated list having
6777 each element starting with a tag name and an equals.
6778
6779 Two options are supported, for the return value and for filtering match
6780 candidates.
6781 The "ret" option requests an alternate result value of
6782 the entire path for the entry. Example:
6783 .code
6784 ${lookup {passwd} dsearch,ret=full {/etc}}
6785 .endd
6786 The default result is just the requested entry.
6787 The "filter" option requests that only directory entries of a given type
6788 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6789 not matching "." or ".."). Example:
6790 .code
6791 ${lookup {passwd} dsearch,filter=file {/etc}}
6792 .endd
6793 The default matching is for any entry type, including directories
6794 and symlinks.
6795
6796 An example of how this
6797 lookup can be used to support virtual domains is given in section
6798 &<<SECTvirtualdomains>>&.
6799
6800 .subsection iplsearch
6801 .cindex "lookup" "iplsearch"
6802 .cindex "iplsearch lookup type"
6803 The given file is a text file containing keys and data. A key is
6804 terminated by a colon or white space or the end of the line. The keys in the
6805 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6806 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6807 being interpreted as a key terminator. For example:
6808 .code
6809 1.2.3.4:           data for 1.2.3.4
6810 192.168.0.0/16:    data for 192.168.0.0/16
6811 "abcd::cdab":      data for abcd::cdab
6812 "abcd:abcd::/32"   data for abcd:abcd::/32
6813 .endd
6814 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6815 file is searched linearly, using the CIDR masks where present, until a matching
6816 key is found. The first key that matches is used; there is no attempt to find a
6817 &"best"& match. Apart from the way the keys are matched, the processing for
6818 &(iplsearch)& is the same as for &(lsearch)&.
6819
6820 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6821 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6822 lookup types support only literal keys.
6823
6824 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6825 the implicit key is the host's IP address rather than its name (see section
6826 &<<SECThoslispatsikey>>&).
6827
6828 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6829 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6830 notation before executing the lookup.)
6831
6832 One option is supported, "ret=full", to request the return of the entire line
6833 rather than omitting the key portion.
6834 Note however that the key portion will have been de-quoted.
6835
6836 .subsection json
6837 .cindex lookup json
6838 .cindex json "lookup type"
6839 .cindex JSON expansions
6840 The given file is a text file with a JSON structure.
6841 An element of the structure is extracted, defined by the search key.
6842 The key is a list of subelement selectors
6843 (colon-separated by default but changeable in the usual way)
6844 which are applied in turn to select smaller and smaller portions
6845 of the JSON structure.
6846 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6847 nunbered array element is selected.
6848 Otherwise it must apply to a JSON object; the named element is selected.
6849 The final resulting element can be a simple JSON type or a JSON object
6850 or array; for the latter two a string-representation of the JSON
6851 is returned.
6852 For elements of type string, the returned value is de-quoted.
6853
6854
6855 .subsection lmdb
6856 .cindex LMDB
6857 .cindex lookup lmdb
6858 .cindex database lmdb
6859 The given file is an LMDB database.
6860 LMDB is a memory-mapped key-value store,
6861 with API modeled loosely on that of BerkeleyDB.
6862 See &url(https://symas.com/products/lightning-memory-mapped-database/)
6863 for the feature set and operation modes.
6864
6865 Exim provides read-only access via the LMDB C library.
6866 The library can be obtained from &url(https://github.com/LMDB/lmdb)
6867 or your operating system package repository.
6868 To enable LMDB support in Exim set LOOKUP_LMDB=yes in &_Local/Makefile_&.
6869
6870 You will need to separately create the LMDB database file,
6871 possibly using the &"mdb_load"& utility.
6872
6873
6874 .subsection lsearch
6875 .cindex "linear search"
6876 .cindex "lookup" "lsearch"
6877 .cindex "lsearch lookup type"
6878 .cindex "case sensitivity" "in lsearch lookup"
6879 The given file is a text file that is searched linearly for a
6880 line beginning with the search key, terminated by a colon or white space or the
6881 end of the line. The search is case-insensitive; that is, upper and lower case
6882 letters are treated as the same. The first occurrence of the key that is found
6883 in the file is used.
6884
6885 White space between the key and the colon is permitted. The remainder of the
6886 line, with leading and trailing white space removed, is the data. This can be
6887 continued onto subsequent lines by starting them with any amount of white
6888 space, but only a single space character is included in the data at such a
6889 junction. If the data begins with a colon, the key must be terminated by a
6890 colon, for example:
6891 .code
6892 baduser:  :fail:
6893 .endd
6894 Empty lines and lines beginning with # are ignored, even if they occur in the
6895 middle of an item. This is the traditional textual format of alias files. Note
6896 that the keys in an &(lsearch)& file are literal strings. There is no
6897 wildcarding of any kind.
6898
6899 .cindex "lookup" "lsearch &-- colons in keys"
6900 .cindex "white space" "in lsearch key"
6901 In most &(lsearch)& files, keys are not required to contain colons or #
6902 characters, or white space. However, if you need this feature, it is available.
6903 If a key begins with a doublequote character, it is terminated only by a
6904 matching quote (or end of line), and the normal escaping rules apply to its
6905 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6906 quoted keys (exactly as for unquoted keys). There is no special handling of
6907 quotes for the data part of an &(lsearch)& line.
6908
6909 .subsection nis
6910 .cindex "NIS lookup type"
6911 .cindex "lookup" "NIS"
6912 .cindex "binary zero" "in lookup key"
6913 The given file is the name of a NIS map, and a NIS lookup is done with
6914 the given key, without a terminating binary zero. There is a variant called
6915 &(nis0)& which does include the terminating binary zero in the key. This is
6916 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6917 aliases; the full map names must be used.
6918
6919 .subsection (n)wildlsearch
6920 .cindex "wildlsearch lookup type"
6921 .cindex "lookup" "wildlsearch"
6922 .cindex "nwildlsearch lookup type"
6923 .cindex "lookup" "nwildlsearch"
6924 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6925 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6926 the file may be wildcarded. The difference between these two lookup types is
6927 that for &(wildlsearch)&, each key in the file is string-expanded before being
6928 used, whereas for &(nwildlsearch)&, no expansion takes place.
6929
6930 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6931 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6932 file that are regular expressions can be made case-sensitive by the use of
6933 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6934
6935 .olist
6936 The string may begin with an asterisk to mean &"ends with"&. For example:
6937 .code
6938 *.a.b.c       data for anything.a.b.c
6939 *fish         data for anythingfish
6940 .endd
6941 .next
6942 The string may begin with a circumflex to indicate a regular expression. For
6943 example, for &(wildlsearch)&:
6944 .code
6945 ^\N\d+\.a\.b\N    data for <digits>.a.b
6946 .endd
6947 Note the use of &`\N`& to disable expansion of the contents of the regular
6948 expression. If you are using &(nwildlsearch)&, where the keys are not
6949 string-expanded, the equivalent entry is:
6950 .code
6951 ^\d+\.a\.b        data for <digits>.a.b
6952 .endd
6953 The case-insensitive flag is set at the start of compiling the regular
6954 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6955 For example, to make the entire pattern case-sensitive:
6956 .code
6957 ^(?-i)\d+\.a\.b        data for <digits>.a.b
6958 .endd
6959
6960 If the regular expression contains white space or colon characters, you must
6961 either quote it (see &(lsearch)& above), or represent these characters in other
6962 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6963 colon. This may be easier than quoting, because if you quote, you have to
6964 escape all the backslashes inside the quotes.
6965
6966 &*Note*&: It is not possible to capture substrings in a regular expression
6967 match for later use, because the results of all lookups are cached. If a lookup
6968 is repeated, the result is taken from the cache, and no actual pattern matching
6969 takes place. The values of all the numeric variables are unset after a
6970 &((n)wildlsearch)& match.
6971
6972 .next
6973 Although I cannot see it being of much use, the general matching function that
6974 is used to implement &((n)wildlsearch)& means that the string may begin with a
6975 lookup name terminated by a semicolon, and followed by lookup data. For
6976 example:
6977 .code
6978 cdb;/some/file  data for keys that match the file
6979 .endd
6980 The data that is obtained from the nested lookup is discarded.
6981 .endlist olist
6982
6983 Keys that do not match any of these patterns are interpreted literally. The
6984 continuation rules for the data are the same as for &(lsearch)&, and keys may
6985 be followed by optional colons.
6986
6987 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6988 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6989 lookup types support only literal keys.
6990
6991 .subsection spf
6992 .cindex "spf lookup type"
6993 .cindex "lookup" "spf"
6994 If Exim is built with SPF support, manual lookups can be done
6995 (as opposed to the standard ACL condition method).
6996 For details see section &<<SECSPF>>&.
6997
6998
6999 .section "Query-style lookup types" "SECTquerystylelookups"
7000 .cindex "lookup" "query-style types"
7001 .cindex "query-style lookup" "list of types"
7002 The supported query-style lookup types are listed below. Further details about
7003 many of them are given in later sections.
7004
7005 .subsection dnsdb
7006 .cindex "DNS" "as a lookup type"
7007 .cindex "lookup" "DNS"
7008 This does a DNS search for one or more records whose domain names
7009 are given in the supplied query. The resulting data is the contents of the
7010 records. See section &<<SECTdnsdb>>&.
7011
7012 .subsection ibase
7013 .cindex "InterBase lookup type"
7014 .cindex "lookup" "InterBase"
7015 This does a lookup in an InterBase database.
7016
7017 .subsection ldap
7018 .cindex "LDAP" "lookup type"
7019 .cindex "lookup" "LDAP"
7020 This does an LDAP lookup using a query in the form of a URL, and
7021 returns attributes from a single entry. There is a variant called &(ldapm)&
7022 that permits values from multiple entries to be returned. A third variant
7023 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7024 any attribute values. See section &<<SECTldap>>&.
7025
7026 .subsection mysql
7027 .cindex "MySQL" "lookup type"
7028 .cindex "lookup" "MySQL"
7029 The format of the query is an SQL statement that is passed to a
7030 MySQL database. See section &<<SECTsql>>&.
7031
7032 .subsection nisplus
7033 .cindex "NIS+ lookup type"
7034 .cindex "lookup" "NIS+"
7035 This does a NIS+ lookup using a query that can specify the name of
7036 the field to be returned. See section &<<SECTnisplus>>&.
7037
7038 .subsection oracle
7039 .cindex "Oracle" "lookup type"
7040 .cindex "lookup" "Oracle"
7041 The format of the query is an SQL statement that is passed to an
7042 Oracle database. See section &<<SECTsql>>&.
7043
7044 .subsection passwd
7045 .cindex "lookup" "passwd"
7046 .cindex "passwd lookup type"
7047 .cindex "&_/etc/passwd_&"
7048 This is a query-style lookup with queries that are just user names. The
7049 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7050 success, the result string is the same as you would get from an &(lsearch)&
7051 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7052 password value. For example:
7053 .code
7054 *:42:42:King Rat:/home/kr:/bin/bash
7055 .endd
7056
7057 .subsection pgsql
7058 .cindex "PostgreSQL lookup type"
7059 .cindex "lookup" "PostgreSQL"
7060 The format of the query is an SQL statement that is passed to a
7061 PostgreSQL database. See section &<<SECTsql>>&.
7062
7063 .subsection redis
7064 .cindex "Redis lookup type"
7065 .cindex lookup Redis
7066 The format of the query is either a simple get or simple set,
7067 passed to a Redis database. See section &<<SECTsql>>&.
7068
7069 .subsection sqlite
7070 .cindex "sqlite lookup type"
7071 .cindex "lookup" "sqlite"
7072 The format of the query is
7073 an SQL statement that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7074
7075 .subsection testdb
7076 This is a lookup type that is used for testing Exim. It is
7077 not likely to be useful in normal operation.
7078
7079 .subsection whoson
7080 .cindex "whoson lookup type"
7081 .cindex "lookup" "whoson"
7082 &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7083 allows a server to check whether a particular (dynamically allocated) IP
7084 address is currently allocated to a known (trusted) user and, optionally, to
7085 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7086 at one time for &"POP before SMTP"& authentication, but that approach has been
7087 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7088 &"POP before SMTP"& checking using ACL statements such as
7089 .code
7090 require condition = \
7091   ${lookup whoson {$sender_host_address}{yes}{no}}
7092 .endd
7093 The query consists of a single IP address. The value returned is the name of
7094 the authenticated user, which is stored in the variable &$value$&. However, in
7095 this example, the data in &$value$& is not used; the result of the lookup is
7096 one of the fixed strings &"yes"& or &"no"&.
7097
7098
7099
7100 .section "Temporary errors in lookups" "SECID63"
7101 .cindex "lookup" "temporary error in"
7102 Lookup functions can return temporary error codes if the lookup cannot be
7103 completed. For example, an SQL or LDAP database might be unavailable. For this
7104 reason, it is not advisable to use a lookup that might do this for critical
7105 options such as a list of local domains.
7106
7107 When a lookup cannot be completed in a router or transport, delivery
7108 of the message (to the relevant address) is deferred, as for any other
7109 temporary error. In other circumstances Exim may assume the lookup has failed,
7110 or may give up altogether.
7111
7112
7113
7114 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7115 .cindex "wildcard lookups"
7116 .cindex "lookup" "default values"
7117 .cindex "lookup" "wildcard"
7118 .cindex "lookup" "* added to type"
7119 .cindex "default" "in single-key lookups"
7120 In this context, a &"default value"& is a value specified by the administrator
7121 that is to be used if a lookup fails.
7122
7123 &*Note:*& This section applies only to single-key lookups. For query-style
7124 lookups, the facilities of the query language must be used. An attempt to
7125 specify a default for a query-style lookup provokes an error.
7126
7127 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7128 and the initial lookup fails, the key &"*"& is looked up in the file to
7129 provide a default value. See also the section on partial matching below.
7130
7131 .cindex "*@ with single-key lookup"
7132 .cindex "lookup" "*@ added to type"
7133 .cindex "alias file" "per-domain default"
7134 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7135 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7136 character, a second lookup is done with everything before the last @ replaced
7137 by *. This makes it possible to provide per-domain defaults in alias files
7138 that include the domains in the keys. If the second lookup fails (or doesn't
7139 take place because there is no @ in the key), &"*"& is looked up.
7140 For example, a &(redirect)& router might contain:
7141 .code
7142 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7143 .endd
7144 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7145 looks up these keys, in this order:
7146 .code
7147 jane@eyre.example
7148 *@eyre.example
7149 *
7150 .endd
7151 The data is taken from whichever key it finds first. &*Note*&: In an
7152 &(lsearch)& file, this does not mean the first of these keys in the file. A
7153 complete scan is done for each key, and only if it is not found at all does
7154 Exim move on to try the next key.
7155
7156
7157
7158 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7159 .cindex "partial matching"
7160 .cindex "wildcard lookups"
7161 .cindex "lookup" "partial matching"
7162 .cindex "lookup" "wildcard"
7163 .cindex "asterisk" "in search type"
7164 The normal operation of a single-key lookup is to search the file for an exact
7165 match with the given key. However, in a number of situations where domains are
7166 being looked up, it is useful to be able to do partial matching. In this case,
7167 information in the file that has a key starting with &"*."& is matched by any
7168 domain that ends with the components that follow the full stop. For example, if
7169 a key in a DBM file is
7170 .code
7171 *.dates.fict.example
7172 .endd
7173 then when partial matching is enabled this is matched by (amongst others)
7174 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7175 by &'dates.fict.example'&, if that does not appear as a separate key in the
7176 file.
7177
7178 &*Note*&: Partial matching is not available for query-style lookups. It is
7179 also not available for any lookup items in address lists (see section
7180 &<<SECTaddresslist>>&).
7181
7182 Partial matching is implemented by doing a series of separate lookups using
7183 keys constructed by modifying the original subject key. This means that it can
7184 be used with any of the single-key lookup types, provided that
7185 partial matching keys
7186 beginning with a special prefix (default &"*."&) are included in the data file.
7187 Keys in the file that do not begin with the prefix are matched only by
7188 unmodified subject keys when partial matching is in use.
7189
7190 Partial matching is requested by adding the string &"partial-"& to the front of
7191 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7192 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7193 is added at the start of the subject key, and it is looked up again. If that
7194 fails, further lookups are tried with dot-separated components removed from the
7195 start of the subject key, one-by-one, and &"*."& added on the front of what
7196 remains.
7197
7198 A minimum number of two non-* components are required. This can be adjusted
7199 by including a number before the hyphen in the search type. For example,
7200 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7201 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7202 subject key is &'2250.dates.fict.example'& then the following keys are looked
7203 up when the minimum number of non-* components is two:
7204 .code
7205 2250.dates.fict.example
7206 *.2250.dates.fict.example
7207 *.dates.fict.example
7208 *.fict.example
7209 .endd
7210 As soon as one key in the sequence is successfully looked up, the lookup
7211 finishes.
7212
7213 .cindex "lookup" "partial matching &-- changing prefix"
7214 .cindex "prefix" "for partial matching"
7215 The use of &"*."& as the partial matching prefix is a default that can be
7216 changed. The motivation for this feature is to allow Exim to operate with file
7217 formats that are used by other MTAs. A different prefix can be supplied in
7218 parentheses instead of the hyphen after &"partial"&. For example:
7219 .code
7220 domains = partial(.)lsearch;/some/file
7221 .endd
7222 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7223 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7224 components is unchanged). The prefix may consist of any punctuation characters
7225 other than a closing parenthesis. It may be empty, for example:
7226 .code
7227 domains = partial1()cdb;/some/file
7228 .endd
7229 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7230 &`a.b.c`&, &`b.c`&, and &`c`&.
7231
7232 If &"partial0"& is specified, what happens at the end (when the lookup with
7233 just one non-wild component has failed, and the original key is shortened right
7234 down to the null string) depends on the prefix:
7235
7236 .ilist
7237 If the prefix has zero length, the whole lookup fails.
7238 .next
7239 If the prefix has length 1, a lookup for just the prefix is done. For
7240 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7241 .next
7242 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7243 remainder is looked up. With the default prefix, therefore, the final lookup is
7244 for &"*"& on its own.
7245 .next
7246 Otherwise, the whole prefix is looked up.
7247 .endlist
7248
7249
7250 If the search type ends in &"*"& or &"*@"& (see section
7251 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7252 this implies happens after all partial lookups have failed. If &"partial0"& is
7253 specified, adding &"*"& to the search type has no effect with the default
7254 prefix, because the &"*"& key is already included in the sequence of partial
7255 lookups. However, there might be a use for lookup types such as
7256 &"partial0(.)lsearch*"&.
7257
7258 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7259 in domain lists and the like. Partial matching works only in terms of
7260 dot-separated components; a key such as &`*fict.example`&
7261 in a database file is useless, because the asterisk in a partial matching
7262 subject key is always followed by a dot.
7263
7264
7265
7266
7267 .section "Lookup caching" "SECID64"
7268 .cindex "lookup" "caching"
7269 .cindex "caching" "lookup data"
7270 Exim caches all lookup results in order to avoid needless repetition of
7271 lookups. However, because (apart from the daemon) Exim operates as a collection
7272 of independent, short-lived processes, this caching applies only within a
7273 single Exim process. There is no inter-process lookup caching facility.
7274
7275 If an option &"cache=no_rd"& is used on the lookup then
7276 the cache is only written to, cached data is not used for the operation
7277 and a real lookup is done.
7278
7279 For single-key lookups, Exim keeps the relevant files open in case there is
7280 another lookup that needs them. In some types of configuration this can lead to
7281 many files being kept open for messages with many recipients. To avoid hitting
7282 the operating system limit on the number of simultaneously open files, Exim
7283 closes the least recently used file when it needs to open more files than its
7284 own internal limit, which can be changed via the &%lookup_open_max%& option.
7285
7286 The single-key lookup files are closed and the lookup caches are flushed at
7287 strategic points during delivery &-- for example, after all routing is
7288 complete.
7289
7290
7291
7292
7293 .section "Quoting lookup data" "SECID65"
7294 .cindex "lookup" "quoting"
7295 .cindex "quoting" "in lookups"
7296 When data from an incoming message is included in a query-style lookup, there
7297 is the possibility of special characters in the data messing up the syntax of
7298 the query. For example, a NIS+ query that contains
7299 .code
7300 [name=$local_part]
7301 .endd
7302 will be broken if the local part happens to contain a closing square bracket.
7303 For NIS+, data can be enclosed in double quotes like this:
7304 .code
7305 [name="$local_part"]
7306 .endd
7307 but this still leaves the problem of a double quote in the data. The rule for
7308 NIS+ is that double quotes must be doubled. Other lookup types have different
7309 rules, and to cope with the differing requirements, an expansion operator
7310 of the following form is provided:
7311 .code
7312 ${quote_<lookup-type>:<string>}
7313 .endd
7314 For example, the safest way to write the NIS+ query is
7315 .code
7316 [name="${quote_nisplus:$local_part}"]
7317 .endd
7318 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7319 operator can be used for all lookup types, but has no effect for single-key
7320 lookups, since no quoting is ever needed in their key strings.
7321
7322
7323
7324
7325 .section "More about dnsdb" "SECTdnsdb"
7326 .cindex "dnsdb lookup"
7327 .cindex "lookup" "dnsdb"
7328 .cindex "DNS" "as a lookup type"
7329 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7330 of a record type and a domain name, separated by an equals sign. For example,
7331 an expansion string could contain:
7332 .code
7333 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7334 .endd
7335 If the lookup succeeds, the result is placed in &$value$&, which in this case
7336 is used on its own as the result. If the lookup does not succeed, the
7337 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7338 &<<SECTforexpfai>>& for an explanation of what this means.
7339
7340 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7341 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7342 If no type is given, TXT is assumed.
7343
7344 For any record type, if multiple records are found, the data is returned as a
7345 concatenation, with newline as the default separator. The order, of course,
7346 depends on the DNS resolver. You can specify a different separator character
7347 between multiple records by putting a right angle-bracket followed immediately
7348 by the new separator at the start of the query. For example:
7349 .code
7350 ${lookup dnsdb{>: a=host1.example}}
7351 .endd
7352 It is permitted to specify a space as the separator character. Further
7353 white space is ignored.
7354 For lookup types that return multiple fields per record,
7355 an alternate field separator can be specified using a comma after the main
7356 separator character, followed immediately by the field separator.
7357
7358 .cindex "PTR record" "in &(dnsdb)& lookup"
7359 When the type is PTR,
7360 the data can be an IP address, written as normal; inversion and the addition of
7361 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7362 .code
7363 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7364 .endd
7365 If the data for a PTR record is not a syntactically valid IP address, it is not
7366 altered and nothing is added.
7367
7368 .cindex "MX record" "in &(dnsdb)& lookup"
7369 .cindex "SRV record" "in &(dnsdb)& lookup"
7370 For an MX lookup, both the preference value and the host name are returned for
7371 each record, separated by a space. For an SRV lookup, the priority, weight,
7372 port, and host name are returned for each record, separated by spaces.
7373 The field separator can be modified as above.
7374
7375 .cindex "TXT record" "in &(dnsdb)& lookup"
7376 .cindex "SPF record" "in &(dnsdb)& lookup"
7377 For TXT records with multiple items of data, only the first item is returned,
7378 unless a field separator is specified.
7379 To concatenate items without a separator, use a semicolon instead.
7380 For SPF records the
7381 default behaviour is to concatenate multiple items without using a separator.
7382 .code
7383 ${lookup dnsdb{>\n,: txt=a.b.example}}
7384 ${lookup dnsdb{>\n; txt=a.b.example}}
7385 ${lookup dnsdb{spf=example.org}}
7386 .endd
7387 It is permitted to specify a space as the separator character. Further
7388 white space is ignored.
7389
7390 .cindex "SOA record" "in &(dnsdb)& lookup"
7391 For an SOA lookup, while no result is obtained the lookup is redone with
7392 successively more leading components dropped from the given domain.
7393 Only the primary-nameserver field is returned unless a field separator is
7394 specified.
7395 .code
7396 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7397 .endd
7398
7399 .subsection "Dnsdb lookup modifiers" SECTdnsdb_mod
7400 .cindex "dnsdb modifiers"
7401 .cindex "modifiers" "dnsdb"
7402 .cindex "options" "dnsdb"
7403 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7404 each followed by a comma,
7405 that may appear before the record type.
7406
7407 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7408 temporary DNS error for any of them, the behaviour is controlled by
7409 a defer-option modifier.
7410 The possible keywords are
7411 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7412 With &"strict"& behaviour, any temporary DNS error causes the
7413 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7414 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7415 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7416 error causes the whole lookup to defer only if none of the other lookups
7417 succeed. The default is &"lax"&, so the following lookups are equivalent:
7418 .code
7419 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7420 ${lookup dnsdb{a=one.host.com:two.host.com}}
7421 .endd
7422 Thus, in the default case, as long as at least one of the DNS lookups
7423 yields some data, the lookup succeeds.
7424
7425 .cindex "DNSSEC" "dns lookup"
7426 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7427 The possible keywords are
7428 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7429 With &"strict"& or &"lax"& DNSSEC information is requested
7430 with the lookup.
7431 With &"strict"& a response from the DNS resolver that
7432 is not labelled as authenticated data
7433 is treated as equivalent to a temporary DNS error.
7434 The default is &"lax"&.
7435
7436 See also the &$lookup_dnssec_authenticated$& variable.
7437
7438 .cindex timeout "dns lookup"
7439 .cindex "DNS" timeout
7440 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7441 The form is &"retrans_VAL"& where VAL is an Exim time specification
7442 (e.g. &"5s"&).
7443 The default value is set by the main configuration option &%dns_retrans%&.
7444
7445 Retries for the dnsdb lookup can be controlled by a retry modifier.
7446 The form if &"retry_VAL"& where VAL is an integer.
7447 The default count is set by the main configuration option &%dns_retry%&.
7448
7449 .cindex caching "of dns lookup"
7450 .cindex TTL "of dns lookup"
7451 .cindex DNS TTL
7452 Dnsdb lookup results are cached within a single process (and its children).
7453 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7454 value of the set of returned DNS records.
7455
7456
7457 .subsection "Pseudo dnsdb record types" SECID66
7458 .cindex "MX record" "in &(dnsdb)& lookup"
7459 By default, both the preference value and the host name are returned for
7460 each MX record, separated by a space. If you want only host names, you can use
7461 the pseudo-type MXH:
7462 .code
7463 ${lookup dnsdb{mxh=a.b.example}}
7464 .endd
7465 In this case, the preference values are omitted, and just the host names are
7466 returned.
7467
7468 .cindex "name server for enclosing domain"
7469 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7470 records on the given domain, but if none are found, it removes the first
7471 component of the domain name, and tries again. This process continues until NS
7472 records are found or there are no more components left (or there is a DNS
7473 error). In other words, it may return the name servers for a top-level domain,
7474 but it never returns the root name servers. If there are no NS records for the
7475 top-level domain, the lookup fails. Consider these examples:
7476 .code
7477 ${lookup dnsdb{zns=xxx.quercite.com}}
7478 ${lookup dnsdb{zns=xxx.edu}}
7479 .endd
7480 Assuming that in each case there are no NS records for the full domain name,
7481 the first returns the name servers for &%quercite.com%&, and the second returns
7482 the name servers for &%edu%&.
7483
7484 You should be careful about how you use this lookup because, unless the
7485 top-level domain does not exist, the lookup always returns some host names. The
7486 sort of use to which this might be put is for seeing if the name servers for a
7487 given domain are on a blacklist. You can probably assume that the name servers
7488 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7489 such a list.
7490
7491 .cindex "CSA" "in &(dnsdb)& lookup"
7492 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7493 records according to the CSA rules, which are described in section
7494 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7495 not sufficient because of the extra parent domain search behaviour of CSA. The
7496 result of a successful lookup such as:
7497 .code
7498 ${lookup dnsdb {csa=$sender_helo_name}}
7499 .endd
7500 has two space-separated fields: an authorization code and a target host name.
7501 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7502 authorization required but absent, or &"?"& for unknown.
7503
7504 .cindex "A+" "in &(dnsdb)& lookup"
7505 The pseudo-type A+ performs an AAAA
7506 and then an A lookup.  All results are returned; defer processing
7507 (see below) is handled separately for each lookup.  Example:
7508 .code
7509 ${lookup dnsdb {>; a+=$sender_helo_name}}
7510 .endd
7511
7512
7513 .subsection "Multiple dnsdb lookups" SECID67
7514 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7515 However, you can specify a list of domains or IP addresses in a single
7516 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7517 the default separator, but with the ability to change this. For example:
7518 .code
7519 ${lookup dnsdb{one.domain.com:two.domain.com}}
7520 ${lookup dnsdb{a=one.host.com:two.host.com}}
7521 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7522 .endd
7523 In order to retain backwards compatibility, there is one special case: if
7524 the lookup type is PTR and no change of separator is specified, Exim looks
7525 to see if the rest of the string is precisely one IPv6 address. In this
7526 case, it does not treat it as a list.
7527
7528 The data from each lookup is concatenated, with newline separators by default,
7529 in the same way that multiple DNS records for a single item are handled. A
7530 different separator can be specified, as described above.
7531
7532
7533
7534
7535 .section "More about LDAP" "SECTldap"
7536 .cindex "LDAP" "lookup, more about"
7537 .cindex "lookup" "LDAP"
7538 .cindex "Solaris" "LDAP"
7539 The original LDAP implementation came from the University of Michigan; this has
7540 become &"Open LDAP"&, and there are now two different releases. Another
7541 implementation comes from Netscape, and Solaris 7 and subsequent releases
7542 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7543 the lookup function level, their error handling is different. For this reason
7544 it is necessary to set a compile-time variable when building Exim with LDAP, to
7545 indicate which LDAP library is in use. One of the following should appear in
7546 your &_Local/Makefile_&:
7547 .code
7548 LDAP_LIB_TYPE=UMICHIGAN
7549 LDAP_LIB_TYPE=OPENLDAP1
7550 LDAP_LIB_TYPE=OPENLDAP2
7551 LDAP_LIB_TYPE=NETSCAPE
7552 LDAP_LIB_TYPE=SOLARIS
7553 .endd
7554 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7555 same interface as the University of Michigan version.
7556
7557 There are three LDAP lookup types in Exim. These behave slightly differently in
7558 the way they handle the results of a query:
7559
7560 .ilist
7561 &(ldap)& requires the result to contain just one entry; if there are more, it
7562 gives an error.
7563 .next
7564 &(ldapdn)& also requires the result to contain just one entry, but it is the
7565 Distinguished Name that is returned rather than any attribute values.
7566 .next
7567 &(ldapm)& permits the result to contain more than one entry; the attributes
7568 from all of them are returned.
7569 .endlist
7570
7571
7572 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7573 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7574 the data returned by a successful lookup is described in the next section.
7575 First we explain how LDAP queries are coded.
7576
7577
7578 .subsection "Format of LDAP queries" SECTforldaque
7579 .cindex "LDAP" "query format"
7580 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7581 the configuration of a &(redirect)& router one might have this setting:
7582 .code
7583 data = ${lookup ldap \
7584   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7585   c=UK?mailbox?base?}}
7586 .endd
7587 .cindex "LDAP" "with TLS"
7588 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7589 secure (encrypted) LDAP connections. The second of these ensures that an
7590 encrypted TLS connection is used.
7591
7592 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7593 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7594 See the &%ldap_start_tls%& option.
7595
7596 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7597 controlled. Every part of the TLS configuration can be configured by settings in
7598 &_exim.conf_&. Depending on the version of the client libraries installed on
7599 your system, some of the initialization may have required setting options in
7600 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7601 certificates. This revealed a nuance where the current UID that exim was
7602 running as could affect which config files it read. With Exim 4.83, these
7603 methods become optional, only taking effect if not specifically set in
7604 &_exim.conf_&.
7605
7606
7607 .subsection "LDAP quoting" SECID68
7608 .cindex "LDAP" "quoting"
7609 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7610 and the second because the LDAP query is represented as a URL. Furthermore,
7611 within an LDAP query, two different kinds of quoting are required. For this
7612 reason, there are two different LDAP-specific quoting operators.
7613
7614 The &%quote_ldap%& operator is designed for use on strings that are part of
7615 filter specifications. Conceptually, it first does the following conversions on
7616 the string:
7617 .code
7618 *   =>   \2A
7619 (   =>   \28
7620 )   =>   \29
7621 \   =>   \5C
7622 .endd
7623 in accordance with RFC 2254. The resulting string is then quoted according
7624 to the rules for URLs, that is, all non-alphanumeric characters except
7625 .code
7626 ! $ ' - . _ ( ) * +
7627 .endd
7628 are converted to their hex values, preceded by a percent sign. For example:
7629 .code
7630 ${quote_ldap: a(bc)*, a<yz>; }
7631 .endd
7632 yields
7633 .code
7634 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7635 .endd
7636 Removing the URL quoting, this is (with a leading and a trailing space):
7637 .code
7638 a\28bc\29\2A, a<yz>;
7639 .endd
7640 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7641 base DN specifications in queries. Conceptually, it first converts the string
7642 by inserting a backslash in front of any of the following characters:
7643 .code
7644 , + " \ < > ;
7645 .endd
7646 It also inserts a backslash before any leading spaces or # characters, and
7647 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7648 is then quoted according to the rules for URLs. For example:
7649 .code
7650 ${quote_ldap_dn: a(bc)*, a<yz>; }
7651 .endd
7652 yields
7653 .code
7654 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7655 .endd
7656 Removing the URL quoting, this is (with a trailing space):
7657 .code
7658 \ a(bc)*\, a\<yz\>\;\
7659 .endd
7660 There are some further comments about quoting in the section on LDAP
7661 authentication below.
7662
7663
7664 .subsection "LDAP connections" SECID69
7665 .cindex "LDAP" "connections"
7666 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7667 is in use, via a Unix domain socket. The example given above does not specify
7668 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7669 by starting it with
7670 .code
7671 ldap://<hostname>:<port>/...
7672 .endd
7673 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7674 used. When no server is specified in a query, a list of default servers is
7675 taken from the &%ldap_default_servers%& configuration option. This supplies a
7676 colon-separated list of servers which are tried in turn until one successfully
7677 handles a query, or there is a serious error. Successful handling either
7678 returns the requested data, or indicates that it does not exist. Serious errors
7679 are syntactical, or multiple values when only a single value is expected.
7680 Errors which cause the next server to be tried are connection failures, bind
7681 failures, and timeouts.
7682
7683 For each server name in the list, a port number can be given. The standard way
7684 of specifying a host and port is to use a colon separator (RFC 1738). Because
7685 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7686 doubled. For example
7687 .code
7688 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7689 .endd
7690 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7691 to the LDAP library with no server name, and the library's default (normally
7692 the local host) is used.
7693
7694 If you are using the OpenLDAP library, you can connect to an LDAP server using
7695 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7696 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7697 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7698 not available.
7699
7700 For this type of connection, instead of a host name for the server, a pathname
7701 for the socket is required, and the port number is not relevant. The pathname
7702 can be specified either as an item in &%ldap_default_servers%&, or inline in
7703 the query. In the former case, you can have settings such as
7704 .code
7705 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7706 .endd
7707 When the pathname is given in the query, you have to escape the slashes as
7708 &`%2F`& to fit in with the LDAP URL syntax. For example:
7709 .code
7710 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7711 .endd
7712 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7713 a pathname, it uses the Unix domain socket code, even if the query actually
7714 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7715 socket connection. This behaviour means that you can use a setting of
7716 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7717 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7718 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7719 backup host.
7720
7721 If an explicit &`ldapi`& type is given in a query when a host name is
7722 specified, an error is diagnosed. However, if there are more items in
7723 &%ldap_default_servers%&, they are tried. In other words:
7724
7725 .ilist
7726 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7727 interface.
7728 .next
7729 Using &`ldapi`& with a host name causes an error.
7730 .endlist
7731
7732
7733 Using &`ldapi`& with no host or path in the query, and no setting of
7734 &%ldap_default_servers%&, does whatever the library does by default.
7735
7736
7737
7738 .subsection "LDAP authentication and control information" SECID70
7739 .cindex "LDAP" "authentication"
7740 The LDAP URL syntax provides no way of passing authentication and other control
7741 information to the server. To make this possible, the URL in an LDAP query may
7742 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7743 spaces. If a value contains spaces it must be enclosed in double quotes, and
7744 when double quotes are used, backslash is interpreted in the usual way inside
7745 them. The following names are recognized:
7746 .itable none 0 0 2 20* left 80* left
7747 .irow DEREFERENCE "set the dereferencing parameter"
7748 .irow NETTIME     "set a timeout for a network operation"
7749 .irow USER        "set the DN, for authenticating the LDAP bind"
7750 .irow PASS        "set the password, likewise"
7751 .irow REFERRALS   "set the referrals parameter"
7752 .irow SERVERS     "set alternate server list for this query only"
7753 .irow SIZE        "set the limit for the number of entries returned"
7754 .irow TIME        "set the maximum waiting time for a query"
7755 .endtable
7756 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7757 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7758 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7759 library from trying to follow referrals issued by the LDAP server.
7760
7761 .cindex LDAP timeout
7762 .cindex timeout "LDAP lookup"
7763 The name CONNECT is an obsolete name for NETTIME, retained for
7764 backwards compatibility. This timeout (specified as a number of seconds) is
7765 enforced from the client end for operations that can be carried out over a
7766 network. Specifically, it applies to network connections and calls to the
7767 &'ldap_result()'& function. If the value is greater than zero, it is used if
7768 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7769 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7770 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7771 Netscape SDK; for OpenLDAP no action is taken.
7772
7773 The TIME parameter (also a number of seconds) is passed to the server to
7774 set a server-side limit on the time taken to complete a search.
7775
7776 The SERVERS parameter allows you to specify an alternate list of ldap servers
7777 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7778 default list of ldap servers, and a single lookup can specify a single ldap
7779 server to use.  But when you need to do a lookup with a list of servers that is
7780 different than the default list (maybe different order, maybe a completely
7781 different set of servers), the SERVERS parameter allows you to specify this
7782 alternate list (colon-separated).
7783
7784 Here is an example of an LDAP query in an Exim lookup that uses some of these
7785 values. This is a single line, folded to fit on the page:
7786 .code
7787 ${lookup ldap
7788   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7789   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7790   {$value}fail}
7791 .endd
7792 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7793 any of the auxiliary data. Exim configuration settings that include lookups
7794 which contain password information should be preceded by &"hide"& to prevent
7795 non-admin users from using the &%-bP%& option to see their values.
7796
7797 The auxiliary data items may be given in any order. The default is no
7798 connection timeout (the system timeout is used), no user or password, no limit
7799 on the number of entries returned, and no time limit on queries.
7800
7801 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7802 removes any URL quoting that it may contain before passing it LDAP. Apparently
7803 some libraries do this for themselves, but some do not. Removing the URL
7804 quoting has two advantages:
7805
7806 .ilist
7807 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7808 DNs as with DNs inside actual queries.
7809 .next
7810 It permits spaces inside USER= DNs.
7811 .endlist
7812
7813 For example, a setting such as
7814 .code
7815 USER=cn=${quote_ldap_dn:$1}
7816 .endd
7817 should work even if &$1$& contains spaces.
7818
7819 Expanded data for the PASS= value should be quoted using the &%quote%&
7820 expansion operator, rather than the LDAP quote operators. The only reason this
7821 field needs quoting is to ensure that it conforms to the Exim syntax, which
7822 does not allow unquoted spaces. For example:
7823 .code
7824 PASS=${quote:$3}
7825 .endd
7826 The LDAP authentication mechanism can be used to check passwords as part of
7827 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7828 &<<CHAPexpand>>&.
7829
7830
7831
7832 .subsection "Format of data returned by LDAP" SECID71
7833 .cindex "LDAP" "returned data formats"
7834 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7835 as a sequence of values, for example
7836 .code
7837 cn=manager,o=University of Cambridge,c=UK
7838 .endd
7839 The &(ldap)& lookup type generates an error if more than one entry matches the
7840 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7841 the result between the data from different entries. It is possible for multiple
7842 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7843 you know that whatever values are returned all came from a single entry in the
7844 directory.
7845
7846 In the common case where you specify a single attribute in your LDAP query, the
7847 result is not quoted, and does not contain the attribute name. If the attribute
7848 has multiple values, they are separated by commas. Any comma that is
7849 part of an attribute's value is doubled.
7850
7851 If you specify multiple attributes, the result contains space-separated, quoted
7852 strings, each preceded by the attribute name and an equals sign. Within the
7853 quotes, the quote character, backslash, and newline are escaped with
7854 backslashes, and commas are used to separate multiple values for the attribute.
7855 Any commas in attribute values are doubled
7856 (permitting treatment of the values as a comma-separated list).
7857 Apart from the escaping, the string within quotes takes the same form as the
7858 output when a single attribute is requested. Specifying no attributes is the
7859 same as specifying all of an entry's attributes.
7860
7861 Here are some examples of the output format. The first line of each pair is an
7862 LDAP query, and the second is the data that is returned. The attribute called
7863 &%attr1%& has two values, one of them with an embedded comma, whereas
7864 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7865 (they have SUP &%attr%& in their schema definitions).
7866
7867 .code
7868 ldap:///o=base?attr1?sub?(uid=fred)
7869 value1.1,value1,,2
7870
7871 ldap:///o=base?attr2?sub?(uid=fred)
7872 value two
7873
7874 ldap:///o=base?attr?sub?(uid=fred)
7875 value1.1,value1,,2,value two
7876
7877 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7878 attr1="value1.1,value1,,2" attr2="value two"
7879
7880 ldap:///o=base??sub?(uid=fred)
7881 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7882 .endd
7883 You can
7884 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7885 results of LDAP lookups.
7886 The &%extract%& operator in string expansions can be used to pick out
7887 individual fields from data that consists of &'key'&=&'value'& pairs.
7888 The &%listextract%& operator should be used to pick out individual values
7889 of attributes, even when only a single value is expected.
7890 The doubling of embedded commas allows you to use the returned data as a
7891 comma separated list (using the "<," syntax for changing the input list separator).
7892
7893
7894
7895
7896 .section "More about NIS+" "SECTnisplus"
7897 .cindex "NIS+ lookup type"
7898 .cindex "lookup" "NIS+"
7899 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7900 and field name. If this is given, the result of a successful query is the
7901 contents of the named field; otherwise the result consists of a concatenation
7902 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7903 values containing spaces are quoted. For example, the query
7904 .code
7905 [name=mg1456],passwd.org_dir
7906 .endd
7907 might return the string
7908 .code
7909 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7910 home=/home/mg1456 shell=/bin/bash shadow=""
7911 .endd
7912 (split over two lines here to fit on the page), whereas
7913 .code
7914 [name=mg1456],passwd.org_dir:gcos
7915 .endd
7916 would just return
7917 .code
7918 Martin Guerre
7919 .endd
7920 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7921 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7922 operator is to double any quote characters within the text.
7923
7924
7925
7926 .section "SQL lookups" "SECTsql"
7927 .cindex "SQL lookup types"
7928 .cindex "MySQL" "lookup type"
7929 .cindex "PostgreSQL lookup type"
7930 .cindex "lookup" "MySQL"
7931 .cindex "lookup" "PostgreSQL"
7932 .cindex "Oracle" "lookup type"
7933 .cindex "lookup" "Oracle"
7934 .cindex "InterBase lookup type"
7935 .cindex "lookup" "InterBase"
7936 .cindex "Redis lookup type"
7937 .cindex lookup Redis
7938 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7939 and SQLite
7940 databases. Queries for these databases contain SQL statements, so an example
7941 might be
7942 .code
7943 ${lookup mysql{select mailbox from users where id='userx'}\
7944   {$value}fail}
7945 .endd
7946 If the result of the query contains more than one field, the data for each
7947 field in the row is returned, preceded by its name, so the result of
7948 .code
7949 ${lookup pgsql{select home,name from users where id='userx'}\
7950   {$value}}
7951 .endd
7952 might be
7953 .code
7954 home=/home/userx name="Mister X"
7955 .endd
7956 Empty values and values containing spaces are double quoted, with embedded
7957 quotes escaped by a backslash. If the result of the query contains just one
7958 field, the value is passed back verbatim, without a field name, for example:
7959 .code
7960 Mister X
7961 .endd
7962 If the result of the query yields more than one row, it is all concatenated,
7963 with a newline between the data for each row.
7964
7965
7966 .subsection "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" SECID72
7967 .cindex "MySQL" "lookup type"
7968 .cindex "PostgreSQL lookup type"
7969 .cindex "lookup" "MySQL"
7970 .cindex "lookup" "PostgreSQL"
7971 .cindex "Oracle" "lookup type"
7972 .cindex "lookup" "Oracle"
7973 .cindex "InterBase lookup type"
7974 .cindex "lookup" "InterBase"
7975 .cindex "Redis lookup type"
7976 .cindex lookup Redis
7977 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7978 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7979 or &%redis_servers%&
7980 option (as appropriate) must be set to a colon-separated list of server
7981 information.
7982 .oindex &%mysql_servers%&
7983 .oindex &%pgsql_servers%&
7984 .oindex &%oracle_servers%&
7985 .oindex &%ibase_servers%&
7986 .oindex &%redis_servers%&
7987 (For MySQL and PostgreSQL, the global option need not be set if all
7988 queries contain their own server information &-- see section
7989 &<<SECTspeserque>>&.)
7990 For all but Redis
7991 each item in the list is a slash-separated list of four
7992 items: host name, database name, user name, and password. In the case of
7993 Oracle, the host name field is used for the &"service name"&, and the database
7994 name field is not used and should be empty. For example:
7995 .code
7996 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7997 .endd
7998 Because password data is sensitive, you should always precede the setting with
7999 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8000 option. Here is an example where two MySQL servers are listed:
8001 .code
8002 hide mysql_servers = localhost/users/root/secret:\
8003                      otherhost/users/root/othersecret
8004 .endd
8005 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8006 because this is a colon-separated list, the colon has to be doubled. For each
8007 query, these parameter groups are tried in order until a connection is made and
8008 a query is successfully processed. The result of a query may be that no data is
8009 found, but that is still a successful query. In other words, the list of
8010 servers provides a backup facility, not a list of different places to look.
8011
8012 For Redis the global option need not be specified if all queries contain their
8013 own server information &-- see section &<<SECTspeserque>>&.
8014 If specified, the option must be set to a colon-separated list of server
8015 information.
8016 Each item in the list is a slash-separated list of three items:
8017 host, database number, and password.
8018 .olist
8019 The host is required and may be either an IPv4 address and optional
8020 port number (separated by a colon, which needs doubling due to the
8021 higher-level list), or a Unix socket pathname enclosed in parentheses
8022 .next
8023 The database number is optional; if present that number is selected in the backend
8024 .next
8025 The password is optional; if present it is used to authenticate to the backend
8026 .endlist
8027
8028 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8029 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8030 respectively, and the characters single-quote, double-quote, and backslash
8031 itself are escaped with backslashes.
8032
8033 The &%quote_redis%& expansion operator
8034 escapes whitespace and backslash characters with a backslash.
8035
8036 .subsection "Specifying the server in the query" SECTspeserque
8037 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8038 it is possible to specify a list of servers with an individual query. This is
8039 done by appending a comma-separated option to the query type:
8040 .display
8041 &`,servers=`&&'server1:server2:server3:...'&
8042 .endd
8043 Each item in the list may take one of two forms:
8044 .olist
8045 If it contains no slashes it is assumed to be just a host name. The appropriate
8046 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8047 of the same name, and the remaining parameters (database, user, password) are
8048 taken from there.
8049 .next
8050 If it contains any slashes, it is taken as a complete parameter set.
8051 .endlist
8052 The list of servers is used in exactly the same way as the global list.
8053 Once a connection to a server has happened and a query has been
8054 successfully executed, processing of the lookup ceases.
8055
8056 This feature is intended for use in master/slave situations where updates
8057 are occurring and you want to update the master rather than a slave. If the
8058 master is in the list as a backup for reading, you might have a global setting
8059 like this:
8060 .code
8061 mysql_servers = slave1/db/name/pw:\
8062                 slave2/db/name/pw:\
8063                 master/db/name/pw
8064 .endd
8065 In an updating lookup, you could then write:
8066 .code
8067 ${lookup mysql,servers=master {UPDATE ...} }
8068 .endd
8069 That query would then be sent only to the master server. If, on the other hand,
8070 the master is not to be used for reading, and so is not present in the global
8071 option, you can still update it by a query of this form:
8072 .code
8073 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8074 .endd
8075
8076 An older syntax places the servers specification before the query,
8077 semicolon separated:
8078 .code
8079 ${lookup mysql{servers=master; UPDATE ...} }
8080 .endd
8081 The new version avoids potential issues with tainted
8082 arguments in the query, for explicit expansion.
8083 &*Note*&: server specifications in list-style lookups are still problematic.
8084
8085
8086 .subsection "Special MySQL features" SECID73
8087 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8088 causes a connection to the server on the local host by means of a Unix domain
8089 socket. An alternate socket can be specified in parentheses.
8090 An option group name for MySQL option files can be specified in square brackets;
8091 the default value is &"exim"&.
8092 The full syntax of each item in &%mysql_servers%& is:
8093 .display
8094 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8095   <&'database'&>/<&'user'&>/<&'password'&>
8096 .endd
8097 Any of the four sub-parts of the first field can be omitted. For normal use on
8098 the local host it can be left blank or set to just &"localhost"&.
8099
8100 No database need be supplied &-- but if it is absent here, it must be given in
8101 the queries.
8102
8103 If a MySQL query is issued that does not request any data (an insert, update,
8104 or delete command), the result of the lookup is the number of rows affected.
8105
8106 &*Warning*&: This can be misleading. If an update does not actually change
8107 anything (for example, setting a field to the value it already has), the result
8108 is zero because no rows are affected.
8109
8110
8111 .subsection "Special PostgreSQL features" SECID74
8112 PostgreSQL lookups can also use Unix domain socket connections to the database.
8113 This is usually faster and costs less CPU time than a TCP/IP connection.
8114 However it can be used only if the mail server runs on the same machine as the
8115 database server. A configuration line for PostgreSQL via Unix domain sockets
8116 looks like this:
8117 .code
8118 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8119 .endd
8120 In other words, instead of supplying a host name, a path to the socket is
8121 given. The path name is enclosed in parentheses so that its slashes aren't
8122 visually confused with the delimiters for the other server parameters.
8123
8124 If a PostgreSQL query is issued that does not request any data (an insert,
8125 update, or delete command), the result of the lookup is the number of rows
8126 affected.
8127
8128 .subsection "More about SQLite" SECTsqlite
8129 .cindex "lookup" "SQLite"
8130 .cindex "sqlite lookup type"
8131 SQLite is different to the other SQL lookups because a filename is required in
8132 addition to the SQL query. An SQLite database is a single file, and there is no
8133 daemon as in the other SQL databases.
8134
8135 .oindex &%sqlite_dbfile%&
8136 There are two ways of
8137 specifying the file.
8138 The first is is by using the &%sqlite_dbfile%& main option.
8139 The second, which allows separate files for each query,
8140 is to use an option appended, comma-separated, to the &"sqlite"&
8141 lookup type word.  The option is the word &"file"&, then an equals,
8142 then the filename.
8143 The filename in this case cannot contain whitespace or open-brace charachters.
8144
8145 A deprecated method is available, prefixing the query with the filename
8146 separated by white space.
8147 This means that
8148 .cindex "tainted data" "sqlite file"
8149 the query cannot use any tainted values, as that taints
8150 the entire query including the filename - resulting in a refusal to open
8151 the file.
8152
8153 In all the above cases the filename must be an absolute path.
8154
8155 Here is a lookup expansion example:
8156 .code
8157 sqlite_dbfile = /some/thing/sqlitedb
8158 ...
8159 ${lookup sqlite {select name from aliases where id='userx';}}
8160 .endd
8161 In a list, the syntax is similar. For example:
8162 .code
8163 domainlist relay_to_domains = sqlite;\
8164    select * from relays where ip='$sender_host_address';
8165 .endd
8166 The only character affected by the &%quote_sqlite%& operator is a single
8167 quote, which it doubles.
8168
8169 .cindex timeout SQLite
8170 .cindex sqlite "lookup timeout"
8171 The SQLite library handles multiple simultaneous accesses to the database
8172 internally. Multiple readers are permitted, but only one process can
8173 update at once. Attempts to access the database while it is being updated
8174 are rejected after a timeout period, during which the SQLite library
8175 waits for the lock to be released. In Exim, the default timeout is set
8176 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8177 option.
8178
8179 .subsection "More about Redis" SECTredis
8180 .cindex "lookup" "Redis"
8181 .cindex "redis lookup type"
8182 Redis is a non-SQL database. Commands are simple get and set.
8183 Examples:
8184 .code
8185 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8186 ${lookup redis{get keyname}}
8187 .endd
8188
8189 As of release 4.91, "lightweight" support for Redis Cluster is available.
8190 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8191 of which must be reachable from the running exim instance. If the cluster has
8192 master/slave replication, the list must contain all the master and slave
8193 servers.
8194
8195 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8196 immediately follow the redirection but treats the response as a DEFER, moving on
8197 to the next server in the &%redis_servers%& list until the correct server is
8198 reached.
8199
8200 .ecindex IIDfidalo1
8201 .ecindex IIDfidalo2
8202
8203
8204 . ////////////////////////////////////////////////////////////////////////////
8205 . ////////////////////////////////////////////////////////////////////////////
8206
8207 .chapter "Domain, host, address, and local part lists" &&&
8208          "CHAPdomhosaddlists" &&&
8209          "Domain, host, and address lists"
8210 .scindex IIDdohoadli "lists of domains; hosts; etc."
8211 A number of Exim configuration options contain lists of domains, hosts,
8212 email addresses, or local parts. For example, the &%hold_domains%& option
8213 contains a list of domains whose delivery is currently suspended. These lists
8214 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8215 arguments to expansion conditions such as &%match_domain%&.
8216
8217 Each item in one of these lists is a pattern to be matched against a domain,
8218 host, email address, or local part, respectively. In the sections below, the
8219 different types of pattern for each case are described, but first we cover some
8220 general facilities that apply to all four kinds of list.
8221
8222 Note that other parts of Exim use a &'string list'& which does not
8223 support all the complexity available in
8224 domain, host, address and local part lists.
8225
8226
8227
8228 .section "Results of list checking" SECTlistresults
8229 The primary result of doing a list check is a truth value.
8230 In some contexts additional information is stored
8231 about the list element that matched:
8232 .vlist
8233 .vitem hosts
8234 A &%hosts%& ACL condition
8235 will store a result in the &$host_data$& variable.
8236 .vitem local_parts
8237 A &%local_parts%& router option or &%local_parts%& ACL condition
8238 will store a result in the &$local_part_data$& variable.
8239 .vitem domains
8240 A &%domains%& router option or &%domains%& ACL condition
8241 will store a result in the &$domain_data$& variable.
8242 .vitem senders
8243 A &%senders%& router option or &%senders%& ACL condition
8244 will store a result in the &$sender_data$& variable.
8245 .vitem recipients
8246 A &%recipients%& ACL condition
8247 will store a result in the &$recipient_data$& variable.
8248 .endlist
8249
8250 The detail of the additional information depends on the
8251 type of match and is given below as the &*value*& information.
8252
8253
8254
8255
8256 .section "Expansion of lists" "SECTlistexpand"
8257 .cindex "expansion" "of lists"
8258 Each list is expanded as a single string before it is used.
8259
8260 &'Exception: the router headers_remove option, where list-item
8261 splitting is done before string-expansion.'&
8262
8263 The result of
8264 expansion must be a list, possibly containing empty items, which is split up
8265 into separate items for matching. By default, colon is the separator character,
8266 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8267 &<<SECTempitelis>>& for details of the list syntax; the second of these
8268 discusses the way to specify empty list items.
8269
8270
8271 If the string expansion is forced to fail, Exim behaves as if the item it is
8272 testing (domain, host, address, or local part) is not in the list. Other
8273 expansion failures cause temporary errors.
8274
8275 If an item in a list is a regular expression, backslashes, dollars and possibly
8276 other special characters in the expression must be protected against
8277 misinterpretation by the string expander. The easiest way to do this is to use
8278 the &`\N`& expansion feature to indicate that the contents of the regular
8279 expression should not be expanded. For example, in an ACL you might have:
8280 .code
8281 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8282                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8283 .endd
8284 The first item is a regular expression that is protected from expansion by
8285 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8286 senders based on the receiving domain.
8287
8288
8289
8290
8291 .subsection "Negated items in lists" SECID76
8292 .cindex "list" "negation"
8293 .cindex "negation" "in lists"
8294 Items in a list may be positive or negative. Negative items are indicated by a
8295 leading exclamation mark, which may be followed by optional white space. A list
8296 defines a set of items (domains, etc). When Exim processes one of these lists,
8297 it is trying to find out whether a domain, host, address, or local part
8298 (respectively) is in the set that is defined by the list. It works like this:
8299
8300 The list is scanned from left to right. If a positive item is matched, the
8301 subject that is being checked is in the set; if a negative item is matched, the
8302 subject is not in the set. If the end of the list is reached without the
8303 subject having matched any of the patterns, it is in the set if the last item
8304 was a negative one, but not if it was a positive one. For example, the list in
8305 .code
8306 domainlist relay_to_domains = !a.b.c : *.b.c
8307 .endd
8308 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8309 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8310 list is positive. However, if the setting were
8311 .code
8312 domainlist relay_to_domains = !a.b.c
8313 .endd
8314 then all domains other than &'a.b.c'& would match because the last item in the
8315 list is negative. In other words, a list that ends with a negative item behaves
8316 as if it had an extra item &`:*`& on the end.
8317
8318 Another way of thinking about positive and negative items in lists is to read
8319 the connector as &"or"& after a positive item and as &"and"& after a negative
8320 item.
8321
8322
8323
8324 .subsection "File names in lists" SECTfilnamlis
8325 .cindex "list" "filename in"
8326 If an item in a domain, host, address, or local part list is an absolute
8327 filename (beginning with a slash character), each line of the file is read and
8328 processed as if it were an independent item in the list, except that further
8329 filenames are not allowed,
8330 and no expansion of the data from the file takes place.
8331 Empty lines in the file are ignored, and the file may also contain comment
8332 lines:
8333
8334 .ilist
8335 For domain and host lists, if a # character appears anywhere in a line of the
8336 file, it and all following characters are ignored.
8337 .next
8338 Because local parts may legitimately contain # characters, a comment in an
8339 address list or local part list file is recognized only if # is preceded by
8340 white space or the start of the line. For example:
8341 .code
8342 not#comment@x.y.z   # but this is a comment
8343 .endd
8344 .endlist
8345
8346 Putting a filename in a list has the same effect as inserting each line of the
8347 file as an item in the list (blank lines and comments excepted). However, there
8348 is one important difference: the file is read each time the list is processed,
8349 so if its contents vary over time, Exim's behaviour changes.
8350
8351 If a filename is preceded by an exclamation mark, the sense of any match
8352 within the file is inverted. For example, if
8353 .code
8354 hold_domains = !/etc/nohold-domains
8355 .endd
8356 and the file contains the lines
8357 .code
8358 !a.b.c
8359 *.b.c
8360 .endd
8361 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8362 any domain matching &`*.b.c`& is not.
8363
8364
8365
8366 .subsection "An lsearch file is not an out-of-line list" SECID77
8367 As will be described in the sections that follow, lookups can be used in lists
8368 to provide indexed methods of checking list membership. There has been some
8369 confusion about the way &(lsearch)& lookups work in lists. Because
8370 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8371 sometimes thought that it is allowed to contain wild cards and other kinds of
8372 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8373 always fixed strings, just as for any other single-key lookup type.
8374
8375 If you want to use a file to contain wild-card patterns that form part of a
8376 list, just give the filename on its own, without a search type, as described
8377 in the previous section. You could also use the &(wildlsearch)& or
8378 &(nwildlsearch)&, but there is no advantage in doing this.
8379
8380
8381
8382
8383 .subsection "Named lists" SECTnamedlists
8384 .cindex "named lists"
8385 .cindex "list" "named"
8386 A list of domains, hosts, email addresses, or local parts can be given a name
8387 which is then used to refer to the list elsewhere in the configuration. This is
8388 particularly convenient if the same list is required in several different
8389 places. It also allows lists to be given meaningful names, which can improve
8390 the readability of the configuration. For example, it is conventional to define
8391 a domain list called &'local_domains'& for all the domains that are handled
8392 locally on a host, using a configuration line such as
8393 .code
8394 domainlist local_domains = localhost:my.dom.example
8395 .endd
8396 Named lists are referenced by giving their name preceded by a plus sign, so,
8397 for example, a router that is intended to handle local domains would be
8398 configured with the line
8399 .code
8400 domains = +local_domains
8401 .endd
8402 The first router in a configuration is often one that handles all domains
8403 except the local ones, using a configuration with a negated item like this:
8404 .code
8405 dnslookup:
8406   driver = dnslookup
8407   domains = ! +local_domains
8408   transport = remote_smtp
8409   no_more
8410 .endd
8411 The four kinds of named list are created by configuration lines starting with
8412 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8413 respectively. Then there follows the name that you are defining, followed by an
8414 equals sign and the list itself. For example:
8415 .code
8416 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8417 addresslist bad_senders = cdb;/etc/badsenders
8418 .endd
8419 A named list may refer to other named lists:
8420 .code
8421 domainlist  dom1 = first.example : second.example
8422 domainlist  dom2 = +dom1 : third.example
8423 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8424 .endd
8425 &*Warning*&: If the last item in a referenced list is a negative one, the
8426 effect may not be what you intended, because the negation does not propagate
8427 out to the higher level. For example, consider:
8428 .code
8429 domainlist  dom1 = !a.b
8430 domainlist  dom2 = +dom1 : *.b
8431 .endd
8432 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8433 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8434 means it matches the second list as well. The effect is not the same as
8435 .code
8436 domainlist  dom2 = !a.b : *.b
8437 .endd
8438 where &'x.y'& does not match. It's best to avoid negation altogether in
8439 referenced lists if you can.
8440
8441 .cindex "hiding named list values"
8442 .cindex "named lists" "hiding value of"
8443 Some named list definitions may contain sensitive data, for example, passwords for
8444 accessing databases. To stop non-admin users from using the &%-bP%& command
8445 line option to read these values, you can precede the definition with the
8446 word &"hide"&. For example:
8447 .code
8448 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8449 .endd
8450
8451
8452 Named lists may have a performance advantage. When Exim is routing an
8453 address or checking an incoming message, it caches the result of tests on named
8454 lists. So, if you have a setting such as
8455 .code
8456 domains = +local_domains
8457 .endd
8458 on several of your routers
8459 or in several ACL statements,
8460 the actual test is done only for the first one. However, the caching works only
8461 if there are no expansions within the list itself or any sublists that it
8462 references. In other words, caching happens only for lists that are known to be
8463 the same each time they are referenced.
8464
8465 By default, there may be up to 16 named lists of each type. This limit can be
8466 extended by changing a compile-time variable. The use of domain and host lists
8467 is recommended for concepts such as local domains, relay domains, and relay
8468 hosts. The default configuration is set up like this.
8469
8470
8471
8472 .subsection "Named lists compared with macros" SECID78
8473 .cindex "list" "named compared with macro"
8474 .cindex "macro" "compared with named list"
8475 At first sight, named lists might seem to be no different from macros in the
8476 configuration file. However, macros are just textual substitutions. If you
8477 write
8478 .code
8479 ALIST = host1 : host2
8480 auth_advertise_hosts = !ALIST
8481 .endd
8482 it probably won't do what you want, because that is exactly the same as
8483 .code
8484 auth_advertise_hosts = !host1 : host2
8485 .endd
8486 Notice that the second host name is not negated. However, if you use a host
8487 list, and write
8488 .code
8489 hostlist alist = host1 : host2
8490 auth_advertise_hosts = ! +alist
8491 .endd
8492 the negation applies to the whole list, and so that is equivalent to
8493 .code
8494 auth_advertise_hosts = !host1 : !host2
8495 .endd
8496
8497
8498 .subsection "Named list caching" SECID79
8499 .cindex "list" "caching of named"
8500 .cindex "caching" "named lists"
8501 While processing a message, Exim caches the result of checking a named list if
8502 it is sure that the list is the same each time. In practice, this means that
8503 the cache operates only if the list contains no $ characters, which guarantees
8504 that it will not change when it is expanded. Sometimes, however, you may have
8505 an expanded list that you know will be the same each time within a given
8506 message. For example:
8507 .code
8508 domainlist special_domains = \
8509            ${lookup{$sender_host_address}cdb{/some/file}}
8510 .endd
8511 This provides a list of domains that depends only on the sending host's IP
8512 address. If this domain list is referenced a number of times (for example,
8513 in several ACL lines, or in several routers) the result of the check is not
8514 cached by default, because Exim does not know that it is going to be the
8515 same list each time.
8516
8517 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8518 cache the result anyway. For example:
8519 .code
8520 domainlist_cache special_domains = ${lookup{...
8521 .endd
8522 If you do this, you should be absolutely sure that caching is going to do
8523 the right thing in all cases. When in doubt, leave it out.
8524
8525
8526
8527 .section "Domain lists" "SECTdomainlist"
8528 .cindex "domain list" "patterns for"
8529 .cindex "list" "domain list"
8530 Domain lists contain patterns that are to be matched against a mail domain.
8531 The following types of item may appear in domain lists:
8532
8533 .ilist
8534 .cindex "primary host name"
8535 .cindex "host name" "matched in domain list"
8536 .oindex "&%primary_hostname%&"
8537 .cindex "domain list" "matching primary host name"
8538 .cindex "@ in a domain list"
8539 If a pattern consists of a single @ character, it matches the local host name,
8540 as set by the &%primary_hostname%& option (or defaulted). This makes it
8541 possible to use the same configuration file on several different hosts that
8542 differ only in their names.
8543
8544 The value for a match will be the primary host name.
8545
8546
8547 .next
8548 .cindex "@[] in a domain list"
8549 .cindex "domain list" "matching local IP interfaces"
8550 .cindex "domain literal"
8551 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8552 in square brackets (as in an email address that contains a domain literal), but
8553 only if that IP address is recognized as local for email routing purposes. The
8554 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8555 control which of a host's several IP addresses are treated as local.
8556 In today's Internet, the use of domain literals is controversial;
8557 see the &%allow_domain_literals%& main option.
8558
8559 The value for a match will be the string &`@[]`&.
8560
8561
8562 .next
8563 .cindex "@mx_any"
8564 .cindex "@mx_primary"
8565 .cindex "@mx_secondary"
8566 .cindex "domain list" "matching MX pointers to local host"
8567 If a pattern consists of the string &`@mx_any`& it matches any domain that
8568 has an MX record pointing to the local host or to any host that is listed in
8569 .oindex "&%hosts_treat_as_local%&"
8570 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8571 are similar, except that the first matches only when a primary MX target is the
8572 local host, and the second only when no primary MX target is the local host,
8573 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8574 preference value &-- there may of course be more than one of them.
8575
8576 The MX lookup that takes place when matching a pattern of this type is
8577 performed with the resolver options for widening names turned off. Thus, for
8578 example, a single-component domain will &'not'& be expanded by adding the
8579 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8580 options of the &(dnslookup)& router for a discussion of domain widening.
8581
8582 Sometimes you may want to ignore certain IP addresses when using one of these
8583 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8584 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8585 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8586 on a router). For example:
8587 .code
8588 domains = @mx_any/ignore=127.0.0.1
8589 .endd
8590 This example matches any domain that has an MX record pointing to one of
8591 the local host's IP addresses other than 127.0.0.1.
8592
8593 The list of IP addresses is in fact processed by the same code that processes
8594 host lists, so it may contain CIDR-coded network specifications and it may also
8595 contain negative items.
8596
8597 Because the list of IP addresses is a sublist within a domain list, you have to
8598 be careful about delimiters if there is more than one address. Like any other
8599 list, the default delimiter can be changed. Thus, you might have:
8600 .code
8601 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8602           an.other.domain : ...
8603 .endd
8604 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8605 involved, it is easiest to change the delimiter for the main list as well:
8606 .code
8607 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8608           an.other.domain ? ...
8609 .endd
8610 The value for a match will be the list element string (starting &`@mx_`&).
8611
8612
8613 .next
8614 .cindex "asterisk" "in domain list"
8615 .cindex "domain list" "asterisk in"
8616 .cindex "domain list" "matching &""ends with""&"
8617 If a pattern starts with an asterisk, the remaining characters of the pattern
8618 are compared with the terminating characters of the domain. The use of &"*"& in
8619 domain lists differs from its use in partial matching lookups. In a domain
8620 list, the character following the asterisk need not be a dot, whereas partial
8621 matching works only in terms of dot-separated components. For example, a domain
8622 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8623 &'cipher.key.ex'&.
8624
8625 The value for a match will be the list element string (starting with the asterisk).
8626 Additionally, &$0$& will be set to the matched string
8627 and &$1$& to the variable portion which the asterisk matched.
8628
8629 .next
8630 .cindex "regular expressions" "in domain list"
8631 .cindex "domain list" "matching regular expression"
8632 If a pattern starts with a circumflex character, it is treated as a regular
8633 expression, and matched against the domain using a regular expression matching
8634 function. The circumflex is treated as part of the regular expression.
8635 Email domains are case-independent, so this regular expression match is by
8636 default case-independent, but you can make it case-dependent by starting it
8637 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8638 are given in chapter &<<CHAPregexp>>&.
8639
8640 &*Warning*&: Because domain lists are expanded before being processed, you
8641 must escape any backslash and dollar characters in the regular expression, or
8642 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8643 it is not to be expanded (unless you really do want to build a regular
8644 expression by expansion, of course).
8645
8646 The value for a match will be the list element string (starting with the circumflex).
8647 Additionally, &$0$& will be set to the string matching the regular expression,
8648 and &$1$& (onwards) to any submatches identified by parentheses.
8649
8650
8651
8652 .next
8653 .cindex "lookup" "in domain list"
8654 .cindex "domain list" "matching by lookup"
8655 If a pattern starts with the name of a single-key lookup type followed by a
8656 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8657 must be a filename in a suitable format for the lookup type. For example, for
8658 &"cdb;"& it must be an absolute path:
8659 .code
8660 domains = cdb;/etc/mail/local_domains.cdb
8661 .endd
8662 The appropriate type of lookup is done on the file using the domain name as the
8663 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8664 only in whether or not the key is present in the file. However, when a lookup
8665 is used for the &%domains%& option on a router
8666 or a &%domains%& condition in an ACL statement, the value is preserved in the
8667 &$domain_data$& variable and can be referred to in other router options or
8668 other statements in the same ACL.
8669 .cindex "tainted data" "de-tainting"
8670 .cindex "de-tainting" "using ACL domains condition"
8671 The value will be untainted.
8672
8673 &*Note*&: If the data result of the lookup (as opposed to the key)
8674 is empty, then this empty value is stored in &$domain_data$&.
8675 The option to return the key for the lookup, as the value,
8676 may be what is wanted.
8677
8678
8679 .next
8680 Any of the single-key lookup type names may be preceded by
8681 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8682 .code
8683 domains = partial-dbm;/partial/domains
8684 .endd
8685 This causes partial matching logic to be invoked; a description of how this
8686 works is given in section &<<SECTpartiallookup>>&.
8687
8688 .next
8689 .cindex "asterisk" "in lookup type"
8690 Any of the single-key lookup types may be followed by an asterisk. This causes
8691 a default lookup for a key consisting of a single asterisk to be done if the
8692 original lookup fails. This is not a useful feature when using a domain list to
8693 select particular domains (because any domain would match), but it might have
8694 value if the result of the lookup is being used via the &$domain_data$&
8695 expansion variable.
8696
8697 .next
8698 If the pattern starts with the name of a query-style lookup type followed by a
8699 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8700 pattern must be an appropriate query for the lookup type, as described in
8701 chapter &<<CHAPfdlookup>>&. For example:
8702 .code
8703 hold_domains = mysql;select domain from holdlist \
8704   where domain = '${quote_mysql:$domain}';
8705 .endd
8706 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8707 example, it doesn't matter what field you select). Exim is interested only in
8708 whether or not the query succeeds. However, when a lookup is used for the
8709 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8710 variable and can be referred to in other options.
8711 .cindex "tainted data" "de-tainting"
8712 .cindex "de-tainting" "using router domains option"
8713 The value will be untainted.
8714
8715 .next
8716 If the pattern starts with the name of a lookup type
8717 of either kind (single-key or query-style) it may be
8718 followed by a comma and options,
8719 The options are lookup-type specific and consist of a comma-separated list.
8720 Each item starts with a tag and and equals "=" sign.
8721
8722 .next
8723 .cindex "domain list" "matching literal domain name"
8724 If none of the above cases apply, a caseless textual comparison is made
8725 between the pattern and the domain.
8726
8727 The value for a match will be the list element string.
8728 .cindex "tainted data" "de-tainting"
8729 Note that this is commonly untainted
8730 (depending on the way the list was created).
8731 Specifically, explicit text in the configuration file in not tainted.
8732 This is a useful way of obtaining an untainted equivalent to
8733 the domain, for later operations.
8734
8735 However if the list (including one-element lists)
8736 is created by expanding a variable containing tainted data,
8737 it is tainted and so will the match value be.
8738 .endlist
8739
8740
8741 Here is an example that uses several different kinds of pattern:
8742 .code
8743 domainlist funny_domains = \
8744   @ : \
8745   lib.unseen.edu : \
8746   *.foundation.fict.example : \
8747   \N^[1-2]\d{3}\.fict\.example$\N : \
8748   partial-dbm;/opt/data/penguin/book : \
8749   nis;domains.byname : \
8750   nisplus;[name=$domain,status=local],domains.org_dir
8751 .endd
8752 There are obvious processing trade-offs among the various matching modes. Using
8753 an asterisk is faster than a regular expression, and listing a few names
8754 explicitly probably is too. The use of a file or database lookup is expensive,
8755 but may be the only option if hundreds of names are required. Because the
8756 patterns are tested in order, it makes sense to put the most commonly matched
8757 patterns earlier.
8758
8759
8760
8761 .section "Host lists" "SECThostlist"
8762 .cindex "host list" "patterns in"
8763 .cindex "list" "host list"
8764 Host lists are used to control what remote hosts are allowed to do. For
8765 example, some hosts may be allowed to use the local host as a relay, and some
8766 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8767 two different ways, by name or by IP address. In a host list, some types of
8768 pattern are matched to a host name, and some are matched to an IP address.
8769 You need to be particularly careful with this when single-key lookups are
8770 involved, to ensure that the right value is being used as the key.
8771
8772
8773 .subsection "Special host list patterns" SECID80
8774 .cindex "empty item in hosts list"
8775 .cindex "host list" "empty string in"
8776 If a host list item is the empty string, it matches only when no remote host is
8777 involved. This is the case when a message is being received from a local
8778 process using SMTP on the standard input, that is, when a TCP/IP connection is
8779 not used.
8780
8781 .cindex "asterisk" "in host list"
8782 The special pattern &"*"& in a host list matches any host or no host. Neither
8783 the IP address nor the name is actually inspected.
8784
8785
8786
8787 .subsection "Host list patterns that match by IP address" SECThoslispatip
8788 .cindex "host list" "matching IP addresses"
8789 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8790 the incoming address actually appears in the IPv6 host as
8791 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8792 list, it is converted into a traditional IPv4 address first. (Not all operating
8793 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8794 concerns.)
8795
8796 The following types of pattern in a host list check the remote host by
8797 inspecting its IP address:
8798
8799 .ilist
8800 If the pattern is a plain domain name (not a regular expression, not starting
8801 with *, not a lookup of any kind), Exim calls the operating system function
8802 to find the associated IP address(es). Exim uses the newer
8803 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8804 This typically causes a forward DNS lookup of the name. The result is compared
8805 with the IP address of the subject host.
8806
8807 If there is a temporary problem (such as a DNS timeout) with the host name
8808 lookup, a temporary error occurs. For example, if the list is being used in an
8809 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8810 temporary SMTP error code. If no IP address can be found for the host name,
8811 what happens is described in section &<<SECTbehipnot>>& below.
8812
8813 .next
8814 .cindex "@ in a host list"
8815 If the pattern is &"@"&, the primary host name is substituted and used as a
8816 domain name, as just described.
8817
8818 .next
8819 If the pattern is an IP address, it is matched against the IP address of the
8820 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8821 IPv6 addresses can be given in colon-separated format, but the colons have to
8822 be doubled so as not to be taken as item separators when the default list
8823 separator is used. IPv6 addresses are recognized even when Exim is compiled
8824 without IPv6 support. This means that if they appear in a host list on an
8825 IPv4-only host, Exim will not treat them as host names. They are just addresses
8826 that can never match a client host.
8827
8828 .next
8829 .cindex "@[] in a host list"
8830 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8831 the local host. For example, if the local host is an IPv4 host with one
8832 interface address 10.45.23.56, these two ACL statements have the same effect:
8833 .code
8834 accept hosts = 127.0.0.1 : 10.45.23.56
8835 accept hosts = @[]
8836 .endd
8837 .next
8838 .cindex "CIDR notation"
8839 If the pattern is an IP address followed by a slash and a mask length, for
8840 example
8841 .code
8842 10.11.42.0/24
8843 .endd
8844 , it is matched against the IP address of the subject
8845 host under the given mask. This allows an entire network of hosts to be
8846 included (or excluded) by a single item. The mask uses CIDR notation; it
8847 specifies the number of address bits that must match, starting from the most
8848 significant end of the address.
8849
8850 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8851 of a range of addresses. It is the number of bits in the network portion of the
8852 address. The above example specifies a 24-bit netmask, so it matches all 256
8853 addresses in the 10.11.42.0 network. An item such as
8854 .code
8855 192.168.23.236/31
8856 .endd
8857 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8858 32 for an IPv4 address is the same as no mask at all; just a single address
8859 matches.
8860
8861 Here is another example which shows an IPv4 and an IPv6 network:
8862 .code
8863 recipient_unqualified_hosts = 192.168.0.0/16: \
8864                               3ffe::ffff::836f::::/48
8865 .endd
8866 The doubling of list separator characters applies only when these items
8867 appear inline in a host list. It is not required when indirecting via a file.
8868 For example:
8869 .code
8870 recipient_unqualified_hosts = /opt/exim/unqualnets
8871 .endd
8872 could make use of a file containing
8873 .code
8874 172.16.0.0/12
8875 3ffe:ffff:836f::/48
8876 .endd
8877 to have exactly the same effect as the previous example. When listing IPv6
8878 addresses inline, it is usually more convenient to use the facility for
8879 changing separator characters. This list contains the same two networks:
8880 .code
8881 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8882                                  3ffe:ffff:836f::/48
8883 .endd
8884 The separator is changed to semicolon by the leading &"<;"& at the start of the
8885 list.
8886 .endlist
8887
8888
8889
8890 .subsection "Host list patterns for single-key lookups by host address" &&&
8891          SECThoslispatsikey
8892 .cindex "host list" "lookup of IP address"
8893 When a host is to be identified by a single-key lookup of its complete IP
8894 address, the pattern takes this form:
8895 .display
8896 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8897 .endd
8898 For example:
8899 .code
8900 hosts_lookup = net-cdb;/hosts-by-ip.db
8901 .endd
8902 The text form of the IP address of the subject host is used as the lookup key.
8903 IPv6 addresses are converted to an unabbreviated form, using lower case
8904 letters, with dots as separators because colon is the key terminator in
8905 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8906 quoting the keys, but this is a facility that was added later.] The data
8907 returned by the lookup is not used.
8908
8909 .cindex "IP address" "masking"
8910 .cindex "host list" "masked IP address"
8911 Single-key lookups can also be performed using masked IP addresses, using
8912 patterns of this form:
8913 .display
8914 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8915 .endd
8916 For example:
8917 .code
8918 net24-dbm;/networks.db
8919 .endd
8920 The IP address of the subject host is masked using <&'number'&> as the mask
8921 length. A textual string is constructed from the masked value, followed by the
8922 mask, and this is used as the lookup key. For example, if the host's IP address
8923 is 192.168.34.6, the key that is looked up for the above example is
8924 &"192.168.34.0/24"&.
8925
8926 When an IPv6 address is converted to a string, dots are normally used instead
8927 of colons, so that keys in &(lsearch)& files need not contain colons (which
8928 terminate &(lsearch)& keys). This was implemented some time before the ability
8929 to quote keys was made available in &(lsearch)& files. However, the more
8930 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8931 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8932 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8933 converted using colons and not dots.
8934 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8935 addresses are always used.
8936 The latter are converted to IPv4 addresses, in dotted-quad form.
8937
8938 Ideally, it would be nice to tidy up this anomalous situation by changing to
8939 colons in all cases, given that quoting is now available for &(lsearch)&.
8940 However, this would be an incompatible change that might break some existing
8941 configurations.
8942
8943 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8944 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8945 the former case the key strings include the mask value, whereas in the latter
8946 case the IP address is used on its own.
8947
8948
8949
8950 .subsection "Host list patterns that match by host name" SECThoslispatnam
8951 .cindex "host" "lookup failures"
8952 .cindex "unknown host name"
8953 .cindex "host list" "matching host name"
8954 There are several types of pattern that require Exim to know the name of the
8955 remote host. These are either wildcard patterns or lookups by name. (If a
8956 complete hostname is given without any wildcarding, it is used to find an IP
8957 address to match against, as described in section &<<SECThoslispatip>>&
8958 above.)
8959
8960 If the remote host name is not already known when Exim encounters one of these
8961 patterns, it has to be found from the IP address.
8962 Although many sites on the Internet are conscientious about maintaining reverse
8963 DNS data for their hosts, there are also many that do not do this.
8964 Consequently, a name cannot always be found, and this may lead to unwanted
8965 effects. Take care when configuring host lists with wildcarded name patterns.
8966 Consider what will happen if a name cannot be found.
8967
8968 Because of the problems of determining host names from IP addresses, matching
8969 against host names is not as common as matching against IP addresses.
8970
8971 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8972 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8973 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8974 are done can be changed by setting the &%host_lookup_order%& option. For
8975 security, once Exim has found one or more names, it looks up the IP addresses
8976 for these names and compares them with the IP address that it started with.
8977 Only those names whose IP addresses match are accepted. Any other names are
8978 discarded. If no names are left, Exim behaves as if the host name cannot be
8979 found. In the most common case there is only one name and one IP address.
8980
8981 There are some options that control what happens if a host name cannot be
8982 found. These are described in section &<<SECTbehipnot>>& below.
8983
8984 .cindex "host" "alias for"
8985 .cindex "alias for host"
8986 As a result of aliasing, hosts may have more than one name. When processing any
8987 of the following types of pattern, all the host's names are checked:
8988
8989 .ilist
8990 .cindex "asterisk" "in host list"
8991 If a pattern starts with &"*"& the remainder of the item must match the end of
8992 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8993 &'.b.c'&. This special simple form is provided because this is a very common
8994 requirement. Other kinds of wildcarding require the use of a regular
8995 expression.
8996 .next
8997 .cindex "regular expressions" "in host list"
8998 .cindex "host list" "regular expression in"
8999 If the item starts with &"^"& it is taken to be a regular expression which is
9000 matched against the host name. Host names are case-independent, so this regular
9001 expression match is by default case-independent, but you can make it
9002 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9003 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9004 example,
9005 .code
9006 ^(a|b)\.c\.d$
9007 .endd
9008 is a regular expression that matches either of the two hosts &'a.c.d'& or
9009 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9010 that backslash and dollar characters are not misinterpreted as part of the
9011 string expansion. The simplest way to do this is to use &`\N`& to mark that
9012 part of the string as non-expandable. For example:
9013 .code
9014 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9015 .endd
9016 &*Warning*&: If you want to match a complete host name, you must include the
9017 &`$`& terminating metacharacter in the regular expression, as in the above
9018 example. Without it, a match at the start of the host name is all that is
9019 required.
9020 .endlist
9021
9022
9023
9024
9025 .subsection "Behaviour when an IP address or name cannot be found" SECTbehipnot
9026 .cindex "host" "lookup failures, permanent"
9027 While processing a host list, Exim may need to look up an IP address from a
9028 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9029 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9030 behaviour when it fails to find the information it is seeking is the same.
9031
9032 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9033 apply to temporary DNS errors, whose handling is described in the next section.
9034
9035 .cindex "&`+include_unknown`&"
9036 .cindex "&`+ignore_unknown`&"
9037 Exim parses a host list from left to right. If it encounters a permanent
9038 lookup failure in any item in the host list before it has found a match,
9039 Exim treats it as a failure and the default behavior is as if the host
9040 does not match the list. This may not always be what you want to happen.
9041 To change Exim's behaviour, the special items &`+include_unknown`& or
9042 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9043 not recognized in an indirected file).
9044
9045 .ilist
9046 If any item that follows &`+include_unknown`& requires information that
9047 cannot found, Exim behaves as if the host does match the list. For example,
9048 .code
9049 host_reject_connection = +include_unknown:*.enemy.ex
9050 .endd
9051 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9052 any hosts whose name it cannot find.
9053
9054 .next
9055 If any item that follows &`+ignore_unknown`& requires information that cannot
9056 be found, Exim ignores that item and proceeds to the rest of the list. For
9057 example:
9058 .code
9059 accept hosts = +ignore_unknown : friend.example : \
9060                192.168.4.5
9061 .endd
9062 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9063 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9064 name can be found for 192.168.4.5, it is rejected.
9065 .endlist
9066
9067 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9068 list. The effect of each one lasts until the next, or until the end of the
9069 list.
9070
9071 .subsection "Mixing wildcarded host names and addresses in host lists" &&&
9072          SECTmixwilhos
9073 .cindex "host list" "mixing names and addresses in"
9074
9075 This section explains the host/ip processing logic with the same concepts
9076 as the previous section, but specifically addresses what happens when a
9077 wildcarded hostname is one of the items in the hostlist.
9078
9079 .ilist
9080 If you have name lookups or wildcarded host names and
9081 IP addresses in the same host list, you should normally put the IP
9082 addresses first. For example, in an ACL you could have:
9083 .code
9084 accept hosts = 10.9.8.7 : *.friend.example
9085 .endd
9086 The reason you normally would order it this way lies in the
9087 left-to-right way that Exim processes lists.  It can test IP addresses
9088 without doing any DNS lookups, but when it reaches an item that requires
9089 a host name, it fails if it cannot find a host name to compare with the
9090 pattern. If the above list is given in the opposite order, the
9091 &%accept%& statement fails for a host whose name cannot be found, even
9092 if its IP address is 10.9.8.7.
9093
9094 .next
9095 If you really do want to do the name check first, and still recognize the IP
9096 address, you can rewrite the ACL like this:
9097 .code
9098 accept hosts = *.friend.example
9099 accept hosts = 10.9.8.7
9100 .endd
9101 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9102 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9103 &`+ignore_unknown`&, which was discussed in depth in the first example in
9104 this section.
9105 .endlist
9106
9107
9108 .subsection "Temporary DNS errors when looking up host information" &&&
9109          SECTtemdnserr
9110 .cindex "host" "lookup failures, temporary"
9111 .cindex "&`+include_defer`&"
9112 .cindex "&`+ignore_defer`&"
9113 A temporary DNS lookup failure normally causes a defer action (except when
9114 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9115 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9116 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9117 section. These options should be used with care, probably only in non-critical
9118 host lists such as whitelists.
9119
9120
9121
9122 .subsection "Host list patterns for single-key lookups by host name" &&&
9123          SECThoslispatnamsk
9124 .cindex "unknown host name"
9125 .cindex "host list" "matching host name"
9126 If a pattern is of the form
9127 .display
9128 <&'single-key-search-type'&>;<&'search-data'&>
9129 .endd
9130 for example
9131 .code
9132 dbm;/host/accept/list
9133 .endd
9134 a single-key lookup is performed, using the host name as its key. If the
9135 lookup succeeds, the host matches the item. The actual data that is looked up
9136 is not used.
9137
9138 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9139 keys in the file, not IP addresses. If you want to do lookups based on IP
9140 addresses, you must precede the search type with &"net-"& (see section
9141 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9142 two items in the same list, one doing an address lookup and one doing a name
9143 lookup, both using the same file.
9144
9145
9146
9147 .subsection "Host list patterns for query-style lookups" SECID81
9148 If a pattern is of the form
9149 .display
9150 <&'query-style-search-type'&>;<&'query'&>
9151 .endd
9152 the query is obeyed, and if it succeeds, the host matches the item. The actual
9153 data that is looked up is not used. The variables &$sender_host_address$& and
9154 &$sender_host_name$& can be used in the query. For example:
9155 .code
9156 hosts_lookup = pgsql;\
9157   select ip from hostlist where ip='$sender_host_address'
9158 .endd
9159 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9160 can use the &%sg%& expansion item to change this if you need to. If you want to
9161 use masked IP addresses in database queries, you can use the &%mask%& expansion
9162 operator.
9163
9164 If the query contains a reference to &$sender_host_name$&, Exim automatically
9165 looks up the host name if it has not already done so. (See section
9166 &<<SECThoslispatnam>>& for comments on finding host names.)
9167
9168 Historical note: prior to release 4.30, Exim would always attempt to find a
9169 host name before running the query, unless the search type was preceded by
9170 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9171 still recognized for query-style lookups, but its presence or absence has no
9172 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9173 See section &<<SECThoslispatsikey>>&.)
9174
9175
9176
9177
9178
9179 .section "Address lists" "SECTaddresslist"
9180 .cindex "list" "address list"
9181 .cindex "address list" "empty item"
9182 .cindex "address list" "patterns"
9183 Address lists contain patterns that are matched against mail addresses. There
9184 is one special case to be considered: the sender address of a bounce message is
9185 always empty. You can test for this by providing an empty item in an address
9186 list. For example, you can set up a router to process bounce messages by
9187 using this option setting:
9188 .code
9189 senders = :
9190 .endd
9191 The presence of the colon creates an empty item. If you do not provide any
9192 data, the list is empty and matches nothing. The empty sender can also be
9193 detected by a regular expression that matches an empty string,
9194 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9195
9196 Non-empty items in an address list can be straightforward email addresses. For
9197 example:
9198 .code
9199 senders = jbc@askone.example : hs@anacreon.example
9200 .endd
9201 A certain amount of wildcarding is permitted. If a pattern contains an @
9202 character, but is not a regular expression and does not begin with a
9203 semicolon-terminated lookup type (described below), the local part of the
9204 subject address is compared with the local part of the pattern, which may start
9205 with an asterisk. If the local parts match, the domain is checked in exactly
9206 the same way as for a pattern in a domain list. For example, the domain can be
9207 wildcarded, refer to a named list, or be a lookup:
9208 .code
9209 deny senders = *@*.spamming.site:\
9210                *@+hostile_domains:\
9211                bozo@partial-lsearch;/list/of/dodgy/sites:\
9212                *@dbm;/bad/domains.db
9213 .endd
9214 .cindex "local part" "starting with !"
9215 .cindex "address list" "local part starting with !"
9216 If a local part that begins with an exclamation mark is required, it has to be
9217 specified using a regular expression, because otherwise the exclamation mark is
9218 treated as a sign of negation, as is standard in lists.
9219
9220 If a non-empty pattern that is not a regular expression or a lookup does not
9221 contain an @ character, it is matched against the domain part of the subject
9222 address. The only two formats that are recognized this way are a literal
9223 domain, or a domain pattern that starts with *. In both these cases, the effect
9224 is the same as if &`*@`& preceded the pattern. For example:
9225 .code
9226 deny senders = enemy.domain : *.enemy.domain
9227 .endd
9228
9229 The following kinds of more complicated address list pattern can match any
9230 address, including the empty address that is characteristic of bounce message
9231 senders:
9232
9233 .ilist
9234 .cindex "regular expressions" "in address list"
9235 .cindex "address list" "regular expression in"
9236 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9237 done against the complete address, with the pattern as the regular expression.
9238 You must take care that backslash and dollar characters are not misinterpreted
9239 as part of the string expansion. The simplest way to do this is to use &`\N`&
9240 to mark that part of the string as non-expandable. For example:
9241 .code
9242 deny senders = \N^.*this.*@example\.com$\N : \
9243                \N^\d{8}.+@spamhaus.example$\N : ...
9244 .endd
9245 The &`\N`& sequences are removed by the expansion, so these items do indeed
9246 start with &"^"& by the time they are being interpreted as address patterns.
9247
9248 .next
9249 .cindex "address list" "lookup for complete address"
9250 Complete addresses can be looked up by using a pattern that starts with a
9251 lookup type terminated by a semicolon, followed by the data for the lookup. For
9252 example:
9253 .code
9254 deny senders = cdb;/etc/blocked.senders : \
9255   mysql;select address from blocked where \
9256   address='${quote_mysql:$sender_address}'
9257 .endd
9258 Both query-style and single-key lookup types can be used. For a single-key
9259 lookup type, Exim uses the complete address as the key. However, empty keys are
9260 not supported for single-key lookups, so a match against the empty address
9261 always fails. This restriction does not apply to query-style lookups.
9262
9263 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9264 cannot be used, and is ignored if specified, with an entry being written to the
9265 panic log.
9266 .cindex "*@ with single-key lookup"
9267 However, you can configure lookup defaults, as described in section
9268 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9269 default. For example, with this lookup:
9270 .code
9271 accept senders = lsearch*@;/some/file
9272 .endd
9273 the file could contains lines like this:
9274 .code
9275 user1@domain1.example
9276 *@domain2.example
9277 .endd
9278 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9279 that are tried is:
9280 .code
9281 nimrod@jaeger.example
9282 *@jaeger.example
9283 *
9284 .endd
9285 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9286 would mean that every address matches, thus rendering the test useless.
9287
9288 &*Warning 2*&: Do not confuse these two kinds of item:
9289 .code
9290 deny recipients = dbm*@;/some/file
9291 deny recipients = *@dbm;/some/file
9292 .endd
9293 The first does a whole address lookup, with defaulting, as just described,
9294 because it starts with a lookup type. The second matches the local part and
9295 domain independently, as described in a bullet point below.
9296 .endlist
9297
9298
9299 The following kinds of address list pattern can match only non-empty addresses.
9300 If the subject address is empty, a match against any of these pattern types
9301 always fails.
9302
9303
9304 .ilist
9305 .cindex "@@ with single-key lookup"
9306 .cindex "address list" "@@ lookup type"
9307 .cindex "address list" "split local part and domain"
9308 If a pattern starts with &"@@"& followed by a single-key lookup item
9309 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9310 split into a local part and a domain. The domain is looked up in the file. If
9311 it is not found, there is no match. If it is found, the data that is looked up
9312 from the file is treated as a colon-separated list of local part patterns, each
9313 of which is matched against the subject local part in turn.
9314
9315 .cindex "asterisk" "in address list"
9316 The lookup may be a partial one, and/or one involving a search for a default
9317 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9318 patterns that are looked up can be regular expressions or begin with &"*"&, or
9319 even be further lookups. They may also be independently negated. For example,
9320 with
9321 .code
9322 deny senders = @@dbm;/etc/reject-by-domain
9323 .endd
9324 the data from which the DBM file is built could contain lines like
9325 .code
9326 baddomain.com:  !postmaster : *
9327 .endd
9328 to reject all senders except &%postmaster%& from that domain.
9329
9330 .cindex "local part" "starting with !"
9331 If a local part that actually begins with an exclamation mark is required, it
9332 has to be specified using a regular expression. In &(lsearch)& files, an entry
9333 may be split over several lines by indenting the second and subsequent lines,
9334 but the separating colon must still be included at line breaks. White space
9335 surrounding the colons is ignored. For example:
9336 .code
9337 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9338   spammer3 : spammer4
9339 .endd
9340 As in all colon-separated lists in Exim, a colon can be included in an item by
9341 doubling.
9342
9343 If the last item in the list starts with a right angle-bracket, the remainder
9344 of the item is taken as a new key to look up in order to obtain a continuation
9345 list of local parts. The new key can be any sequence of characters. Thus one
9346 might have entries like
9347 .code
9348 aol.com: spammer1 : spammer 2 : >*
9349 xyz.com: spammer3 : >*
9350 *:       ^\d{8}$
9351 .endd
9352 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9353 local parts for all domains, in addition to the specific local parts listed for
9354 each domain. Of course, using this feature costs another lookup each time a
9355 chain is followed, but the effort needed to maintain the data is reduced.
9356
9357 .cindex "loop" "in lookups"
9358 It is possible to construct loops using this facility, and in order to catch
9359 them, the chains may be no more than fifty items long.
9360
9361 .next
9362 The @@<&'lookup'&> style of item can also be used with a query-style
9363 lookup, but in this case, the chaining facility is not available. The lookup
9364 can only return a single list of local parts.
9365 .endlist
9366
9367 &*Warning*&: There is an important difference between the address list items
9368 in these two examples:
9369 .code
9370 senders = +my_list
9371 senders = *@+my_list
9372 .endd
9373 In the first one, &`my_list`& is a named address list, whereas in the second
9374 example it is a named domain list.
9375
9376
9377
9378
9379 .subsection "Case of letters in address lists" SECTcasletadd
9380 .cindex "case of local parts"
9381 .cindex "address list" "case forcing"
9382 .cindex "case forcing in address lists"
9383 Domains in email addresses are always handled caselessly, but for local parts
9384 case may be significant on some systems (see &%caseful_local_part%& for how
9385 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9386 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9387 blocking lists should be done in a case-independent manner. Since most address
9388 lists in Exim are used for this kind of control, Exim attempts to do this by
9389 default.
9390
9391 The domain portion of an address is always lowercased before matching it to an
9392 address list. The local part is lowercased by default, and any string
9393 comparisons that take place are done caselessly. This means that the data in
9394 the address list itself, in files included as plain filenames, and in any file
9395 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9396 keys in files that are looked up by a search type other than &(lsearch)& (which
9397 works caselessly) must be in lower case, because these lookups are not
9398 case-independent.
9399
9400 .cindex "&`+caseful`&"
9401 To allow for the possibility of caseful address list matching, if an item in
9402 an address list is the string &"+caseful"&, the original case of the local
9403 part is restored for any comparisons that follow, and string comparisons are no
9404 longer case-independent. This does not affect the domain, which remains in
9405 lower case. However, although independent matches on the domain alone are still
9406 performed caselessly, regular expressions that match against an entire address
9407 become case-sensitive after &"+caseful"& has been seen.
9408
9409
9410
9411 .section "Local part lists" "SECTlocparlis"
9412 .cindex "list" "local part list"
9413 .cindex "local part" "list"
9414 These behave in the same way as domain and host lists, with the following
9415 changes:
9416
9417 Case-sensitivity in local part lists is handled in the same way as for address
9418 lists, as just described. The &"+caseful"& item can be used if required. In a
9419 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9420 set false, the subject is lowercased and the matching is initially
9421 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9422 matching in the local part list, but not elsewhere in the router. If
9423 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9424 option is case-sensitive from the start.
9425
9426 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9427 comments are handled in the same way as address lists &-- they are recognized
9428 only if the # is preceded by white space or the start of the line.
9429 Otherwise, local part lists are matched in the same way as domain lists, except
9430 that the special items that refer to the local host (&`@`&, &`@[]`&,
9431 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9432 Refer to section &<<SECTdomainlist>>& for details of the other available item
9433 types.
9434 .ecindex IIDdohoadli
9435
9436
9437
9438
9439 . ////////////////////////////////////////////////////////////////////////////
9440 . ////////////////////////////////////////////////////////////////////////////
9441
9442 .chapter "String expansions" "CHAPexpand"
9443 .scindex IIDstrexp "expansion" "of strings"
9444 Many strings in Exim's runtime configuration are expanded before use. Some of
9445 them are expanded every time they are used; others are expanded only once.
9446
9447 When a string is being expanded it is copied verbatim from left to right except
9448 .cindex expansion "string concatenation"
9449 when a dollar or backslash character is encountered. A dollar specifies the
9450 start of a portion of the string that is interpreted and replaced as described
9451 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9452 escape character, as described in the following section.
9453
9454 Whether a string is expanded depends upon the context.  Usually this is solely
9455 dependent upon the option for which a value is sought; in this documentation,
9456 options for which string expansion is performed are marked with &dagger; after
9457 the data type.  ACL rules always expand strings.  A couple of expansion
9458 conditions do not expand some of the brace-delimited branches, for security
9459 reasons,
9460 .cindex "tainted data" expansion
9461 .cindex "tainted data" definition
9462 .cindex expansion "tainted data"
9463 and expansion of data deriving from the sender (&"tainted data"&)
9464 is not permitted (including acessing a file using a tainted name).
9465
9466 Common ways of obtaining untainted equivalents of variables with
9467 tainted values
9468 .cindex "tainted data" "de-tainting"
9469 come down to using the tainted value as a lookup key in a trusted database.
9470 This database could be the filesystem structure,
9471 or the password file,
9472 or accessed via a DBMS.
9473 Specific methods are indexed under &"de-tainting"&.
9474
9475
9476
9477 .section "Literal text in expanded strings" "SECTlittext"
9478 .cindex "expansion" "including literal text"
9479 An uninterpreted dollar can be included in an expanded string by putting a
9480 backslash in front of it. A backslash can be used to prevent any special
9481 character being treated specially in an expansion, including backslash itself.
9482 If the string appears in quotes in the configuration file, two backslashes are
9483 required because the quotes themselves cause interpretation of backslashes when
9484 the string is read in (see section &<<SECTstrings>>&).
9485
9486 .cindex "expansion" "non-expandable substrings"
9487 A portion of the string can specified as non-expandable by placing it between
9488 two occurrences of &`\N`&. This is particularly useful for protecting regular
9489 expressions, which often contain backslashes and dollar signs. For example:
9490 .code
9491 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9492 .endd
9493 On encountering the first &`\N`&, the expander copies subsequent characters
9494 without interpretation until it reaches the next &`\N`& or the end of the
9495 string.
9496
9497
9498
9499 .section "Character escape sequences in expanded strings" "SECID82"
9500 .cindex "expansion" "escape sequences"
9501 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9502 expanded string is recognized as an escape sequence for the character newline,
9503 carriage return, or tab, respectively. A backslash followed by up to three
9504 octal digits is recognized as an octal encoding for a single character, and a
9505 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9506 encoding.
9507
9508 These escape sequences are also recognized in quoted strings when they are read
9509 in. Their interpretation in expansions as well is useful for unquoted strings,
9510 and for other cases such as looked-up strings that are then expanded.
9511
9512
9513 .section "Testing string expansions" "SECID83"
9514 .cindex "expansion" "testing"
9515 .cindex "testing" "string expansion"
9516 .oindex "&%-be%&"
9517 Many expansions can be tested by calling Exim with the &%-be%& option. This
9518 takes the command arguments, or lines from the standard input if there are no
9519 arguments, runs them through the string expansion code, and writes the results
9520 to the standard output. Variables based on configuration values are set up, but
9521 since no message is being processed, variables such as &$local_part$& have no
9522 value. Nevertheless the &%-be%& option can be useful for checking out file and
9523 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9524 and &%nhash%&.
9525
9526 .new
9527 When reading lines from the standard input,
9528 macros can be defined and ACL variables can be set.
9529 For example:
9530 .code
9531 MY_MACRO = foo
9532 set acl_m_myvar = bar
9533 .endd
9534 Such macros and variables can then be used in later input lines.
9535 .wen
9536
9537 Exim gives up its root privilege when it is called with the &%-be%& option, and
9538 instead runs under the uid and gid it was called with, to prevent users from
9539 using &%-be%& for reading files to which they do not have access.
9540
9541 .oindex "&%-bem%&"
9542 If you want to test expansions that include variables whose values are taken
9543 from a message, there are two other options that can be used. The &%-bem%&
9544 option is like &%-be%& except that it is followed by a filename. The file is
9545 read as a message before doing the test expansions. For example:
9546 .code
9547 exim -bem /tmp/test.message '$h_subject:'
9548 .endd
9549 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9550 Exim message identifier. For example:
9551 .code
9552 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9553 .endd
9554 This loads the message from Exim's spool before doing the test expansions, and
9555 is therefore restricted to admin users.
9556
9557
9558 .section "Forced expansion failure" "SECTforexpfai"
9559 .cindex "expansion" "forced failure"
9560 A number of expansions that are described in the following section have
9561 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9562 (which are sometimes called &"curly brackets"&). Which of the two strings is
9563 used depends on some condition that is evaluated as part of the expansion. If,
9564 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9565 the entire string expansion fails in a way that can be detected by the code
9566 that requested the expansion. This is called &"forced expansion failure"&, and
9567 its consequences depend on the circumstances. In some cases it is no different
9568 from any other expansion failure, but in others a different action may be
9569 taken. Such variations are mentioned in the documentation of the option that is
9570 being expanded.
9571
9572
9573
9574
9575 .section "Expansion items" "SECTexpansionitems"
9576 The following items are recognized in expanded strings. White space may be used
9577 between sub-items that are keywords or substrings enclosed in braces inside an
9578 outer set of braces, to improve readability. &*Warning*&: Within braces,
9579 white space is significant.
9580
9581 .vlist
9582 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9583 .cindex "expansion" "variables"
9584 Substitute the contents of the named variable, for example:
9585 .code
9586 $local_part
9587 ${domain}
9588 .endd
9589 The second form can be used to separate the name from subsequent alphanumeric
9590 characters. This form (using braces) is available only for variables; it does
9591 &'not'& apply to message headers. The names of the variables are given in
9592 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9593 given, the expansion fails.
9594
9595 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9596 .cindex "expansion" "operators"
9597 The string is first itself expanded, and then the operation specified by
9598 <&'op'&> is applied to it. For example:
9599 .code
9600 ${lc:$local_part}
9601 .endd
9602 The string starts with the first character after the colon, which may be
9603 leading white space. A list of operators is given in section &<<SECTexpop>>&
9604 below. The operator notation is used for simple expansion items that have just
9605 one argument, because it reduces the number of braces and therefore makes the
9606 string easier to understand.
9607
9608 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9609 This item inserts &"basic"& header lines. It is described with the &%header%&
9610 expansion item below.
9611
9612
9613 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9614 .cindex "expansion" "calling an acl"
9615 .cindex "&%acl%&" "call from expansion"
9616 The name and zero to nine argument strings are first expanded separately.  The expanded
9617 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9618 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9619 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9620 and may use the variables; if another acl expansion is used the values
9621 are restored after it returns.  If the ACL sets
9622 a value using a "message =" modifier and returns accept or deny, the value becomes
9623 the result of the expansion.
9624 If no message is set and the ACL returns accept or deny
9625 the expansion result is an empty string.
9626 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9627
9628
9629 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9630 .cindex authentication "results header"
9631 .chindex Authentication-Results:
9632 .cindex authentication "expansion item"
9633 This item returns a string suitable for insertion as an
9634 &'Authentication-Results:'&
9635 header line.
9636 The given <&'authserv-id'&> is included in the result; typically this
9637 will be a domain name identifying the system performing the authentications.
9638 Methods that might be present in the result include:
9639 .code
9640 none
9641 iprev
9642 auth
9643 spf
9644 dkim
9645 .endd
9646
9647 Example use (as an ACL modifier):
9648 .code
9649       add_header = :at_start:${authresults {$primary_hostname}}
9650 .endd
9651 This is safe even if no authentication results are available.
9652
9653
9654 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9655        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9656 .cindex "expansion" "extracting certificate fields"
9657 .cindex "&%certextract%&" "certificate fields"
9658 .cindex "certificate" "extracting fields"
9659 The <&'certificate'&> must be a variable of type certificate.
9660 The field name is expanded and used to retrieve the relevant field from
9661 the certificate.  Supported fields are:
9662 .display
9663 &`version        `&
9664 &`serial_number  `&
9665 &`subject        `& RFC4514 DN
9666 &`issuer         `& RFC4514 DN
9667 &`notbefore      `& time
9668 &`notafter       `& time
9669 &`sig_algorithm  `&
9670 &`signature      `&
9671 &`subj_altname   `& tagged list
9672 &`ocsp_uri       `& list
9673 &`crl_uri        `& list
9674 .endd
9675 If the field is found,
9676 <&'string2'&> is expanded, and replaces the whole item;
9677 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9678 variable &$value$& contains the value that has been extracted. Afterwards, it
9679 is restored to any previous value it might have had.
9680
9681 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9682 key is not found. If {<&'string2'&>} is also omitted, the value that was
9683 extracted is used.
9684
9685 Some field names take optional modifiers, appended and separated by commas.
9686
9687 The field selectors marked as "RFC4514" above
9688 output a Distinguished Name string which is
9689 not quite
9690 parseable by Exim as a comma-separated tagged list
9691 (the exceptions being elements containing commas).
9692 RDN elements of a single type may be selected by
9693 a modifier of the type label; if so the expansion
9694 result is a list (newline-separated by default).
9695 The separator may be changed by another modifier of
9696 a right angle-bracket followed immediately by the new separator.
9697 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9698
9699 The field selectors marked as "time" above
9700 take an optional modifier of "int"
9701 for which the result is the number of seconds since epoch.
9702 Otherwise the result is a human-readable string
9703 in the timezone selected by the main "timezone" option.
9704
9705 The field selectors marked as "list" above return a list,
9706 newline-separated by default,
9707 (embedded separator characters in elements are doubled).
9708 The separator may be changed by a modifier of
9709 a right angle-bracket followed immediately by the new separator.
9710
9711 The field selectors marked as "tagged" above
9712 prefix each list element with a type string and an equals sign.
9713 Elements of only one type may be selected by a modifier
9714 which is one of "dns", "uri" or "mail";
9715 if so the element tags are omitted.
9716
9717 If not otherwise noted field values are presented in human-readable form.
9718
9719 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9720        {*&<&'arg'&>&*}...}*&"
9721 .cindex &%dlfunc%&
9722 This expansion dynamically loads and then calls a locally-written C function.
9723 This functionality is available only if Exim is compiled with
9724 .code
9725 EXPAND_DLFUNC=yes
9726 .endd
9727 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9728 object so that it doesn't reload the same object file in the same Exim process
9729 (but of course Exim does start new processes frequently).
9730
9731 There may be from zero to eight arguments to the function.
9732
9733 When compiling
9734 a local function that is to be called in this way,
9735 first &_DLFUNC_IMPL_& should be defined,
9736 and second &_local_scan.h_& should be included.
9737 The Exim variables and functions that are defined by that API
9738 are also available for dynamically loaded functions. The function itself
9739 must have the following type:
9740 .code
9741 int dlfunction(uschar **yield, int argc, uschar *argv[])
9742 .endd
9743 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9744 function should return one of the following values:
9745
9746 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9747 into the expanded string that is being built.
9748
9749 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9750 from &'yield'&, if it is set.
9751
9752 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9753 taken from &'yield'& if it is set.
9754
9755 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9756
9757 When compiling a function that is to be used in this way with gcc,
9758 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9759 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9760
9761
9762 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9763 .cindex "expansion" "extracting value from environment"
9764 .cindex "environment" "values from"
9765 The key is first expanded separately, and leading and trailing white space
9766 removed.
9767 This is then searched for as a name in the environment.
9768 If a variable is found then its value is placed in &$value$&
9769 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9770
9771 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9772 appear, for example:
9773 .code
9774 ${env{USER}{$value} fail }
9775 .endd
9776 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9777 {<&'string1'&>} must be present for &"fail"& to be recognized.
9778
9779 If {<&'string2'&>} is omitted an empty string is substituted on
9780 search failure.
9781 If {<&'string1'&>} is omitted the search result is substituted on
9782 search success.
9783
9784 The environment is adjusted by the &%keep_environment%& and
9785 &%add_environment%& main section options.
9786
9787
9788 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9789        {*&<&'string3'&>&*}}*&"
9790 .cindex "expansion" "extracting substrings by key"
9791 .cindex "&%extract%&" "substrings by key"
9792 The key and <&'string1'&> are first expanded separately. Leading and trailing
9793 white space is removed from the key (but not from any of the strings). The key
9794 must not be empty and must not consist entirely of digits.
9795 The expanded <&'string1'&> must be of the form:
9796 .display
9797 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9798 .endd
9799 .vindex "&$value$&"
9800 where the equals signs and spaces (but not both) are optional. If any of the
9801 values contain white space, they must be enclosed in double quotes, and any
9802 values that are enclosed in double quotes are subject to escape processing as
9803 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9804 for the value that corresponds to the key. The search is case-insensitive. If
9805 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9806 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9807 variable &$value$& contains the value that has been extracted. Afterwards, it
9808 is restored to any previous value it might have had.
9809
9810 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9811 key is not found. If {<&'string2'&>} is also omitted, the value that was
9812 extracted is used. Thus, for example, these two expansions are identical, and
9813 yield &"2001"&:
9814 .code
9815 ${extract{gid}{uid=1984 gid=2001}}
9816 ${extract{gid}{uid=1984 gid=2001}{$value}}
9817 .endd
9818 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9819 appear, for example:
9820 .code
9821 ${extract{Z}{A=... B=...}{$value} fail }
9822 .endd
9823 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9824 {<&'string2'&>} must be present for &"fail"& to be recognized.
9825
9826 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9827        {*&<&'string3'&>&*}}*&" &&&
9828        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9829        {*&<&'string3'&>&*}}*&"
9830 .cindex "expansion" "extracting from JSON object"
9831 .cindex JSON expansions
9832 The key and <&'string1'&> are first expanded separately. Leading and trailing
9833 white space is removed from the key (but not from any of the strings). The key
9834 must not be empty and must not consist entirely of digits.
9835 The expanded <&'string1'&> must be of the form:
9836 .display
9837 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9838 .endd
9839 .vindex "&$value$&"
9840 The braces, commas and colons, and the quoting of the member name are required;
9841 the spaces are optional.
9842 Matching of the key against the member names is done case-sensitively.
9843 For the &"json"& variant,
9844 if a returned value is a JSON string, it retains its leading and
9845 trailing quotes.
9846 For the &"jsons"& variant, which is intended for use with JSON strings, the
9847 leading and trailing quotes are removed from the returned value.
9848 . XXX should be a UTF-8 compare
9849
9850 The results of matching are handled as above.
9851
9852
9853 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9854         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9855 .cindex "expansion" "extracting substrings by number"
9856 .cindex "&%extract%&" "substrings by number"
9857 The <&'number'&> argument must consist entirely of decimal digits,
9858 apart from leading and trailing white space, which is ignored.
9859 This is what distinguishes this form of &%extract%& from the previous kind. It
9860 behaves in the same way, except that, instead of extracting a named field, it
9861 extracts from <&'string1'&> the field whose number is given as the first
9862 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9863 <&'string3'&> as before.
9864
9865 The fields in the string are separated by any one of the characters in the
9866 separator string. These may include space or tab characters.
9867 The first field is numbered one. If the number is negative, the fields are
9868 counted from the end of the string, with the rightmost one numbered -1. If the
9869 number given is zero, the entire string is returned. If the modulus of the
9870 number is greater than the number of fields in the string, the result is the
9871 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9872 provided. For example:
9873 .code
9874 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9875 .endd
9876 yields &"42"&, and
9877 .code
9878 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9879 .endd
9880 yields &"99"&. Two successive separators mean that the field between them is
9881 empty (for example, the fifth field above).
9882
9883
9884 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9885         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9886        "&*${extract jsons{*&<&'number'&>&*}}&&&
9887         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9888 .cindex "expansion" "extracting from JSON array"
9889 .cindex JSON expansions
9890 The <&'number'&> argument must consist entirely of decimal digits,
9891 apart from leading and trailing white space, which is ignored.
9892
9893 Field selection and result handling is as above;
9894 there is no choice of field separator.
9895 For the &"json"& variant,
9896 if a returned value is a JSON string, it retains its leading and
9897 trailing quotes.
9898 For the &"jsons"& variant, which is intended for use with JSON strings, the
9899 leading and trailing quotes are removed from the returned value.
9900
9901
9902 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9903 .cindex "list" "selecting by condition"
9904 .cindex "expansion" "selecting from list by condition"
9905 .vindex "&$item$&"
9906 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9907 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9908 For each item
9909 in this list, its value is place in &$item$&, and then the condition is
9910 evaluated. If the condition is true, &$item$& is added to the output as an
9911 item in a new list; if the condition is false, the item is discarded. The
9912 separator used for the output list is the same as the one used for the
9913 input, but a separator setting is not included in the output. For example:
9914 .code
9915 ${filter{a:b:c}{!eq{$item}{b}}}
9916 .endd
9917 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9918 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9919
9920
9921 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9922 .cindex "hash function" "textual"
9923 .cindex "expansion" "textual hash"
9924 This is a textual hashing function, and was the first to be implemented in
9925 early versions of Exim. In current releases, there are other hashing functions
9926 (numeric, MD5, and SHA-1), which are described below.
9927
9928 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9929 <&'n'&>. If you are using fixed values for these numbers, that is, if
9930 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9931 use the simpler operator notation that avoids some of the braces:
9932 .code
9933 ${hash_<n>_<m>:<string>}
9934 .endd
9935 The second number is optional (in both notations). If <&'n'&> is greater than
9936 or equal to the length of the string, the expansion item returns the string.
9937 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9938 function to the string. The new string consists of characters taken from the
9939 first <&'m'&> characters of the string
9940 .code
9941 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9942 .endd
9943 If <&'m'&> is not present the value 26 is used, so that only lower case
9944 letters appear. For example:
9945 .display
9946 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9947 &`$hash{5}{monty}}           `&   yields  &`monty`&
9948 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9949 .endd
9950
9951 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9952         &*$h_*&<&'header&~name'&>&*:*&" &&&
9953        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9954         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9955        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9956         &*$lh_*&<&'header&~name'&>&*:*&" &&&
9957        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9958         &*$rh_*&<&'header&~name'&>&*:*&"
9959 .cindex "expansion" "header insertion"
9960 .vindex "&$header_$&"
9961 .vindex "&$bheader_$&"
9962 .vindex "&$lheader_$&"
9963 .vindex "&$rheader_$&"
9964 .cindex "header lines" "in expansion strings"
9965 .cindex "header lines" "character sets"
9966 .cindex "header lines" "decoding"
9967 Substitute the contents of the named message header line, for example
9968 .code
9969 $header_reply-to:
9970 .endd
9971 The newline that terminates a header line is not included in the expansion, but
9972 internal newlines (caused by splitting the header line over several physical
9973 lines) may be present.
9974
9975 The difference between the four pairs of expansions is in the way
9976 the data in the header line is interpreted.
9977
9978 .ilist
9979 .cindex "white space" "in header lines"
9980 &%rheader%& gives the original &"raw"& content of the header line, with no
9981 processing at all, and without the removal of leading and trailing white space.
9982
9983 .next
9984 .cindex "list" "of header lines"
9985 &%lheader%& gives a colon-separated list, one element per header when there
9986 are multiple headers with a given name.
9987 Any embedded colon characters within an element are doubled, so normal Exim
9988 list-processing facilities can be used.
9989 The terminating newline of each element is removed; in other respects
9990 the content is &"raw"&.
9991
9992 .next
9993 .cindex "base64 encoding" "in header lines"
9994 &%bheader%& removes leading and trailing white space, and then decodes base64
9995 or quoted-printable MIME &"words"& within the header text, but does no
9996 character set translation. If decoding of what looks superficially like a MIME
9997 &"word"& fails, the raw string is returned. If decoding
9998 .cindex "binary zero" "in header line"
9999 produces a binary zero character, it is replaced by a question mark &-- this is
10000 what Exim does for binary zeros that are actually received in header lines.
10001
10002 .next
10003 &%header%& tries to translate the string as decoded by &%bheader%& to a
10004 standard character set. This is an attempt to produce the same string as would
10005 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10006 returned. Translation is attempted only on operating systems that support the
10007 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10008 a system Makefile or in &_Local/Makefile_&.
10009 .endlist ilist
10010
10011 In a filter file, the target character set for &%header%& can be specified by a
10012 command of the following form:
10013 .code
10014 headers charset "UTF-8"
10015 .endd
10016 This command affects all references to &$h_$& (or &$header_$&) expansions in
10017 subsequently obeyed filter commands. In the absence of this command, the target
10018 character set in a filter is taken from the setting of the &%headers_charset%&
10019 option in the runtime configuration. The value of this option defaults to the
10020 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10021 ISO-8859-1.
10022
10023 Header names follow the syntax of RFC 2822, which states that they may contain
10024 any printing characters except space and colon. Consequently, curly brackets
10025 &'do not'& terminate header names, and should not be used to enclose them as
10026 if they were variables. Attempting to do so causes a syntax error.
10027
10028 Only header lines that are common to all copies of a message are visible to
10029 this mechanism. These are the original header lines that are received with the
10030 message, and any that are added by an ACL statement or by a system
10031 filter. Header lines that are added to a particular copy of a message by a
10032 router or transport are not accessible.
10033
10034 For incoming SMTP messages, no header lines are visible in
10035 ACLs that are obeyed before the data phase completes,
10036 because the header structure is not set up until the message is received.
10037 They are visible in DKIM, PRDR and DATA ACLs.
10038 Header lines that are added in a RCPT ACL (for example)
10039 are saved until the message's incoming header lines are available, at which
10040 point they are added.
10041 When any of the above ACLs are
10042 running, however, header lines added by earlier ACLs are visible.
10043
10044 Upper case and lower case letters are synonymous in header names. If the
10045 following character is white space, the terminating colon may be omitted, but
10046 this is not recommended, because you may then forget it when it is needed. When
10047 white space terminates the header name, this white space is included in the
10048 expanded string.  If the message does not contain the given header, the
10049 expansion item is replaced by an empty string. (See the &%def%& condition in
10050 section &<<SECTexpcond>>& for a means of testing for the existence of a
10051 header.)
10052
10053 If there is more than one header with the same name, they are all concatenated
10054 to form the substitution string, up to a maximum length of 64K. Unless
10055 &%rheader%& is being used, leading and trailing white space is removed from
10056 each header before concatenation, and a completely empty header is ignored. A
10057 newline character is then inserted between non-empty headers, but there is no
10058 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10059 those headers that contain lists of addresses, a comma is also inserted at the
10060 junctions between headers. This does not happen for the &%rheader%& expansion.
10061
10062 .cindex "tainted data" "message headers"
10063 When the headers are from an incoming message,
10064 the result of expanding any of these variables is tainted.
10065
10066
10067 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10068 .cindex "expansion" "hmac hashing"
10069 .cindex &%hmac%&
10070 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10071 shared secret and some text into a message authentication code, as specified in
10072 RFC 2104. This differs from &`${md5:secret_text...}`& or
10073 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10074 cryptographic hash, allowing for authentication that is not possible with MD5
10075 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10076 present. For example:
10077 .code
10078 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10079 .endd
10080 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10081 produces:
10082 .code
10083 dd97e3ba5d1a61b5006108f8c8252953
10084 .endd
10085 As an example of how this might be used, you might put in the main part of
10086 an Exim configuration:
10087 .code
10088 SPAMSCAN_SECRET=cohgheeLei2thahw
10089 .endd
10090 In a router or a transport you could then have:
10091 .code
10092 headers_add = \
10093   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10094   ${hmac{md5}{SPAMSCAN_SECRET}\
10095   {${primary_hostname},${message_exim_id},$h_message-id:}}
10096 .endd
10097 Then given a message, you can check where it was scanned by looking at the
10098 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10099 this header line is authentic by recomputing the authentication code from the
10100 host name, message ID and the &'Message-id:'& header line. This can be done
10101 using Exim's &%-be%& option, or by other means, for example, by using the
10102 &'hmac_md5_hex()'& function in Perl.
10103
10104
10105 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10106 .cindex "expansion" "conditional"
10107 .cindex "&%if%&, expansion item"
10108 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10109 item; otherwise <&'string2'&> is used. The available conditions are described
10110 in section &<<SECTexpcond>>& below. For example:
10111 .code
10112 ${if eq {$local_part}{postmaster} {yes}{no} }
10113 .endd
10114 The second string need not be present; if it is not and the condition is not
10115 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10116 be present instead of the second string (without any curly brackets). In this
10117 case, the expansion is forced to fail if the condition is not true (see section
10118 &<<SECTforexpfai>>&).
10119
10120 If both strings are omitted, the result is the string &`true`& if the condition
10121 is true, and the empty string if the condition is false. This makes it less
10122 cumbersome to write custom ACL and router conditions. For example, instead of
10123 .code
10124 condition = ${if >{$acl_m4}{3}{true}{false}}
10125 .endd
10126 you can use
10127 .code
10128 condition = ${if >{$acl_m4}{3}}
10129 .endd
10130
10131
10132
10133 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10134 .cindex expansion "imap folder"
10135 .cindex "&%imapfolder%& expansion item"
10136 This item converts a (possibly multilevel, or with non-ASCII characters)
10137 folder specification to a Maildir name for filesystem use.
10138 For information on internationalisation support see &<<SECTi18nMDA>>&.
10139
10140
10141
10142 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10143 .cindex "expansion" "string truncation"
10144 .cindex "&%length%& expansion item"
10145 The &%length%& item is used to extract the initial portion of a string. Both
10146 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10147 you are using a fixed value for the number, that is, if <&'string1'&> does not
10148 change when expanded, you can use the simpler operator notation that avoids
10149 some of the braces:
10150 .code
10151 ${length_<n>:<string>}
10152 .endd
10153 The result of this item is either the first <&'n'&> bytes or the whole
10154 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10155 &%strlen%&, which gives the length of a string.
10156 All measurement is done in bytes and is not UTF-8 aware.
10157
10158
10159 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10160         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10161 .cindex "expansion" "extracting list elements by number"
10162 .cindex "&%listextract%&" "extract list elements by number"
10163 .cindex "list" "extracting elements by number"
10164 The <&'number'&> argument must consist entirely of decimal digits,
10165 apart from an optional leading minus,
10166 and leading and trailing white space (which is ignored).
10167
10168 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10169 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10170
10171 The first field of the list is numbered one.
10172 If the number is negative, the fields are
10173 counted from the end of the list, with the rightmost one numbered -1.
10174 The numbered element of the list is extracted and placed in &$value$&,
10175 then <&'string2'&> is expanded as the result.
10176
10177 If the modulus of the
10178 number is zero or greater than the number of fields in the string,
10179 the result is the expansion of <&'string3'&>.
10180
10181 For example:
10182 .code
10183 ${listextract{2}{x:42:99}}
10184 .endd
10185 yields &"42"&, and
10186 .code
10187 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10188 .endd
10189 yields &"result: 42"&.
10190
10191 If {<&'string3'&>} is omitted, an empty string is used for string3.
10192 If {<&'string2'&>} is also omitted, the value that was
10193 extracted is used.
10194 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10195
10196
10197 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10198 .cindex quoting "for list"
10199 .cindex list quoting
10200 This item doubles any occurrence of the separator character
10201 in the given string.
10202 An empty string is replaced with a single space.
10203 This converts the string into a safe form for use as a list element,
10204 in a list using the given separator.
10205
10206
10207 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10208         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10209        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10210         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10211 .cindex "expansion" "lookup in"
10212 .cindex "file" "lookups"
10213 .cindex "lookup" "in expanded string"
10214 The two forms of lookup item specify data lookups in files and databases, as
10215 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10216 lookups, and the second is used for query-style lookups. The <&'key'&>,
10217 <&'file'&>, and <&'query'&> strings are expanded before use.
10218
10219 If there is any white space in a lookup item which is part of a filter command,
10220 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10221 other place where white space is significant, the lookup item must be enclosed
10222 in double quotes. The use of data lookups in users' filter files may be locked
10223 out by the system administrator.
10224
10225 .vindex "&$value$&"
10226 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10227 During its expansion, the variable &$value$& contains the data returned by the
10228 lookup. Afterwards it reverts to the value it had previously (at the outer
10229 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10230 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10231 string on failure. If <&'string2'&> is provided, it can itself be a nested
10232 lookup, thus providing a mechanism for looking up a default value when the
10233 original lookup fails.
10234
10235 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10236 data for the outer lookup while the parameters of the second lookup are
10237 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10238 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10239 appear, and in this case, if the lookup fails, the entire expansion is forced
10240 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10241 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10242 successful lookup, and nothing in the case of failure.
10243
10244 For single-key lookups, the string &"partial"& is permitted to precede the
10245 search type in order to do partial matching, and * or *@ may follow a search
10246 type to request default lookups if the key does not match (see sections
10247 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10248
10249 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10250 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10251 and non-wild parts of the key during the expansion of the replacement text.
10252 They return to their previous values at the end of the lookup item.
10253
10254 This example looks up the postmaster alias in the conventional alias file:
10255 .code
10256 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10257 .endd
10258 This example uses NIS+ to look up the full name of the user corresponding to
10259 the local part of an address, forcing the expansion to fail if it is not found:
10260 .code
10261 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10262   {$value}fail}
10263 .endd
10264
10265
10266 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10267 .cindex "expansion" "list creation"
10268 .vindex "&$item$&"
10269 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10270 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10271 For each item
10272 in this list, its value is place in &$item$&, and then <&'string2'&> is
10273 expanded and added to the output as an item in a new list. The separator used
10274 for the output list is the same as the one used for the input, but a separator
10275 setting is not included in the output. For example:
10276 .code
10277 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10278 .endd
10279 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10280 value of &$item$& is restored to what it was before. See also the &%filter%&
10281 and &%reduce%& expansion items.
10282
10283 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10284 .cindex "expansion" "numeric hash"
10285 .cindex "hash function" "numeric"
10286 The three strings are expanded; the first two must yield numbers. Call them
10287 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10288 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10289 can use the simpler operator notation that avoids some of the braces:
10290 .code
10291 ${nhash_<n>_<m>:<string>}
10292 .endd
10293 The second number is optional (in both notations). If there is only one number,
10294 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10295 processed by a div/mod hash function that returns two numbers, separated by a
10296 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10297 example,
10298 .code
10299 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10300 .endd
10301 returns the string &"6/33"&.
10302
10303
10304
10305 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10306 .cindex "Perl" "use in expanded string"
10307 .cindex "expansion" "calling Perl from"
10308 This item is available only if Exim has been built to include an embedded Perl
10309 interpreter. The subroutine name and the arguments are first separately
10310 expanded, and then the Perl subroutine is called with those arguments. No
10311 additional arguments need be given; the maximum number permitted, including the
10312 name of the subroutine, is nine.
10313
10314 The return value of the subroutine is inserted into the expanded string, unless
10315 the return value is &%undef%&. In that case, the entire expansion is
10316 forced to fail, in the same way as an explicit &"fail"& on a lookup item
10317 does (see section &<<SECTforexpfai>>&).  Whatever you return is evaluated
10318 in a scalar context, thus the return value is a scalar.  For example, if you
10319 return a Perl vector, the return value is the size of the vector,
10320 not its contents.
10321
10322 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10323 with the error message that was passed to &%die%&. More details of the embedded
10324 Perl facility are given in chapter &<<CHAPperl>>&.
10325
10326 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10327 out the use of this expansion item in filter files.
10328
10329
10330 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10331 .cindex "&%prvs%& expansion item"
10332 The first argument is a complete email address and the second is secret
10333 keystring. The third argument, specifying a key number, is optional. If absent,
10334 it defaults to 0. The result of the expansion is a prvs-signed email address,
10335 to be typically used with the &%return_path%& option on an &(smtp)& transport
10336 as part of a bounce address tag validation (BATV) scheme. For more discussion
10337 and an example, see section &<<SECTverifyPRVS>>&.
10338
10339 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10340         {*&<&'string'&>&*}}*&"
10341 .cindex "&%prvscheck%& expansion item"
10342 This expansion item is the complement of the &%prvs%& item. It is used for
10343 checking prvs-signed addresses. If the expansion of the first argument does not
10344 yield a syntactically valid prvs-signed address, the whole item expands to the
10345 empty string. When the first argument does expand to a syntactically valid
10346 prvs-signed address, the second argument is expanded, with the prvs-decoded
10347 version of the address and the key number extracted from the address in the
10348 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10349
10350 These two variables can be used in the expansion of the second argument to
10351 retrieve the secret. The validity of the prvs-signed address is then checked
10352 against the secret. The result is stored in the variable &$prvscheck_result$&,
10353 which is empty for failure or &"1"& for success.
10354
10355 The third argument is optional; if it is missing, it defaults to an empty
10356 string. This argument is now expanded. If the result is an empty string, the
10357 result of the expansion is the decoded version of the address. This is the case
10358 whether or not the signature was valid. Otherwise, the result of the expansion
10359 is the expansion of the third argument.
10360
10361 All three variables can be used in the expansion of the third argument.
10362 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10363 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10364
10365 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10366 .cindex "expansion" "inserting an entire file"
10367 .cindex "file" "inserting into expansion"
10368 .cindex "&%readfile%& expansion item"
10369 The filename and end-of-line (eol) string are first expanded separately. The file is
10370 then read, and its contents replace the entire item. All newline characters in
10371 the file are replaced by the end-of-line string if it is present. Otherwise,
10372 newlines are left in the string.
10373 String expansion is not applied to the contents of the file. If you want this,
10374 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10375 the string expansion fails.
10376
10377 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10378 locks out the use of this expansion item in filter files.
10379
10380
10381
10382 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10383         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10384 .cindex "expansion" "inserting from a socket"
10385 .cindex "socket, use of in expansion"
10386 .cindex "&%readsocket%& expansion item"
10387 This item inserts data from a Unix domain or TCP socket into the expanded
10388 string. The minimal way of using it uses just two arguments, as in these
10389 examples:
10390 .code
10391 ${readsocket{/socket/name}{request string}}
10392 ${readsocket{inet:some.host:1234}{request string}}
10393 .endd
10394 For a Unix domain socket, the first substring must be the path to the socket.
10395 For an Internet socket, the first substring must contain &`inet:`& followed by
10396 a host name or IP address, followed by a colon and a port, which can be a
10397 number or the name of a TCP port in &_/etc/services_&. An IP address may
10398 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10399 example:
10400 .code
10401 ${readsocket{inet:[::1]:1234}{request string}}
10402 .endd
10403 Only a single host name may be given, but if looking it up yields more than
10404 one IP address, they are each tried in turn until a connection is made. For
10405 both kinds of socket, Exim makes a connection, writes the request string
10406 (unless it is an empty string; no terminating NUL is ever sent)
10407 and reads from the socket until an end-of-file
10408 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10409 extend what can be done. Firstly, you can vary the timeout. For example:
10410 .code
10411 ${readsocket{/socket/name}{request string}{3s}}
10412 .endd
10413
10414 The third argument is a list of options, of which the first element is the timeout
10415 and must be present if any options are given.
10416 Further elements are options of form &'name=value'&.
10417 Example:
10418 .code
10419 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10420 .endd
10421
10422 The following option names are recognised:
10423 .ilist
10424 &*cache*&
10425 Defines if the result data can be cached for use by a later identical
10426 request in the same process.
10427 Values are &"yes"& or &"no"& (the default).
10428 If not, all cached results for this connection specification
10429 will be invalidated.
10430
10431 .next
10432 &*shutdown*&
10433 Defines whether or not a write-shutdown is done on the connection after
10434 sending the request. Values are &"yes"& (the default) or &"no"&
10435 (preferred, eg. by some webservers).
10436
10437 .next
10438 &*tls*&
10439 Controls the use of TLS on the connection.
10440 Values are &"yes"& or &"no"& (the default).
10441 If it is enabled, a shutdown as described above is never done.
10442 .endlist
10443
10444
10445 A fourth argument allows you to change any newlines that are in the data
10446 that is read, in the same way as for &%readfile%& (see above). This example
10447 turns them into spaces:
10448 .code
10449 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10450 .endd
10451 As with all expansions, the substrings are expanded before the processing
10452 happens. Errors in these sub-expansions cause the expansion to fail. In
10453 addition, the following errors can occur:
10454
10455 .ilist
10456 Failure to create a socket file descriptor;
10457 .next
10458 Failure to connect the socket;
10459 .next
10460 Failure to write the request string;
10461 .next
10462 Timeout on reading from the socket.
10463 .endlist
10464
10465 By default, any of these errors causes the expansion to fail. However, if
10466 you supply a fifth substring, it is expanded and used when any of the above
10467 errors occurs. For example:
10468 .code
10469 ${readsocket{/socket/name}{request string}{3s}{\n}\
10470   {socket failure}}
10471 .endd
10472 You can test for the existence of a Unix domain socket by wrapping this
10473 expansion in &`${if exists`&, but there is a race condition between that test
10474 and the actual opening of the socket, so it is safer to use the fifth argument
10475 if you want to be absolutely sure of avoiding an expansion error for a
10476 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10477
10478 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10479 locks out the use of this expansion item in filter files.
10480
10481
10482 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10483 .cindex "expansion" "reducing a list to a scalar"
10484 .cindex "list" "reducing to a scalar"
10485 .vindex "&$value$&"
10486 .vindex "&$item$&"
10487 This operation reduces a list to a single, scalar string. After expansion,
10488 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10489 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10490 Then <&'string2'&> is expanded and
10491 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10492 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10493 them. The result of that expansion is assigned to &$value$& before the next
10494 iteration. When the end of the list is reached, the final value of &$value$& is
10495 added to the expansion output. The &%reduce%& expansion item can be used in a
10496 number of ways. For example, to add up a list of numbers:
10497 .code
10498 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10499 .endd
10500 The result of that expansion would be &`6`&. The maximum of a list of numbers
10501 can be found:
10502 .code
10503 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10504 .endd
10505 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10506 restored to what they were before. See also the &%filter%& and &%map%&
10507 expansion items.
10508
10509 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10510 This item inserts &"raw"& header lines. It is described with the &%header%&
10511 expansion item in section &<<SECTexpansionitems>>& above.
10512
10513 .vitem "&*${run <&'options'&> {*&<&'command&~arg&~list'&>&*}{*&<&'string1'&>&*}&&&
10514         {*&<&'string2'&>&*}}*&"
10515 .cindex "expansion" "running a command"
10516 .cindex "&%run%& expansion item"
10517 This item runs an external command, as a subprocess.
10518 One option is supported after the word &'run'&, comma-separated.
10519
10520 If the option &'preexpand'& is not used,
10521 the command string is split into individual arguments by spaces
10522 and then each argument is expanded.
10523 Then the command is run
10524 in a separate process, but under the same uid and gid.  As in other command
10525 executions from Exim, a shell is not used by default. If the command requires
10526 a shell, you must explicitly code it.
10527 The command name may not be tainted, but the remaining arguments can be.
10528
10529 &*Note*&: if tainted arguments are used, they are supplied by a
10530 potential attacker;
10531 a careful assessment for security vulnerabilities should be done.
10532
10533 If the option &'preexpand'& is used,
10534 the command and its arguments are first expanded as one string. The result is
10535 split apart into individual arguments by spaces, and then the command is run
10536 as above.
10537 Since the arguments are split by spaces, when there is a variable expansion
10538 which has an empty result, it will cause the situation that the argument will
10539 simply be omitted when the program is actually executed by Exim. If the
10540 script/program requires a specific number of arguments and the expanded
10541 variable could possibly result in this empty expansion, the variable must be
10542 quoted. This is more difficult if the expanded variable itself could result
10543 in a string containing quotes, because it would interfere with the quotes
10544 around the command arguments. A possible guard against this is to wrap the
10545 variable in the &%sg%& operator to change any quote marks to some other
10546 character.
10547 Neither the command nor any argument may be tainted.
10548
10549 The standard input for the command exists, but is empty. The standard output
10550 and standard error are set to the same file descriptor.
10551 .cindex "return code" "from &%run%& expansion"
10552 .vindex "&$value$&"
10553 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10554 and replaces the entire item; during this expansion, the standard output/error
10555 from the command is in the variable &$value$&. If the command fails,
10556 <&'string2'&>, if present, is expanded and used. Once again, during the
10557 expansion, the standard output/error from the command is in the variable
10558 &$value$&.
10559
10560 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10561 can be the word &"fail"& (not in braces) to force expansion failure if the
10562 command does not succeed. If both strings are omitted, the result is contents
10563 of the standard output/error on success, and nothing on failure.
10564
10565 .vindex "&$run_in_acl$&"
10566 The standard output/error of the command is put in the variable &$value$&.
10567 In this ACL example, the output of a command is logged for the admin to
10568 troubleshoot:
10569 .code
10570 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10571       log_message  = Output of id: $value
10572 .endd
10573 If the command requires shell idioms, such as the > redirect operator, the
10574 shell must be invoked directly, such as with:
10575 .code
10576 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10577 .endd
10578
10579 .vindex "&$runrc$&"
10580 The return code from the command is put in the variable &$runrc$&, and this
10581 remains set afterwards, so in a filter file you can do things like this:
10582 .code
10583 if "${run{x y z}{}}$runrc" is 1 then ...
10584   elif $runrc is 2 then ...
10585   ...
10586 endif
10587 .endd
10588 If execution of the command fails (for example, the command does not exist),
10589 the return code is 127 &-- the same code that shells use for non-existent
10590 commands.
10591
10592 &*Warning*&: In a router or transport, you cannot assume the order in which
10593 option values are expanded, except for those preconditions whose order of
10594 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10595 by the expansion of one option, and use it in another.
10596
10597 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10598 out the use of this expansion item in filter files.
10599
10600
10601 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10602 .cindex "expansion" "string substitution"
10603 .cindex "&%sg%& expansion item"
10604 This item works like Perl's substitution operator (s) with the global (/g)
10605 option; hence its name. However, unlike the Perl equivalent, Exim does not
10606 modify the subject string; instead it returns the modified string for insertion
10607 into the overall expansion. The item takes three arguments: the subject string,
10608 a regular expression, and a substitution string. For example:
10609 .code
10610 ${sg{abcdefabcdef}{abc}{xyz}}
10611 .endd
10612 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10613 if any $, } or \ characters are required in the regular expression or in the
10614 substitution string, they have to be escaped. For example:
10615 .code
10616 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10617 .endd
10618 yields &"defabc"&, and
10619 .code
10620 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10621 .endd
10622 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10623 the regular expression from string expansion.
10624
10625 The regular expression is compiled in 8-bit mode, working against bytes
10626 rather than any Unicode-aware character handling.
10627
10628
10629 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10630 .cindex sorting "a list"
10631 .cindex list sorting
10632 .cindex expansion "list sorting"
10633 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10634 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10635 The <&'comparator'&> argument is interpreted as the operator
10636 of a two-argument expansion condition.
10637 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10638 The comparison should return true when applied to two values
10639 if the first value should sort before the second value.
10640 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10641 the element being placed in &$item$&,
10642 to give values for comparison.
10643
10644 The item result is a sorted list,
10645 with the original list separator,
10646 of the list elements (in full) of the original.
10647
10648 Examples:
10649 .code
10650 ${sort{3:2:1:4}{<}{$item}}
10651 .endd
10652 sorts a list of numbers, and
10653 .code
10654 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10655 .endd
10656 will sort an MX lookup into priority order.
10657
10658
10659
10660 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10661 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10662
10663
10664
10665 .vitem &*${substr{*&<&'start'&>&*}{*&<&'len'&>&*}{*&<&'subject'&>&*}}*&
10666 .cindex "&%substr%& expansion item"
10667 .cindex "substring extraction"
10668 .cindex "expansion" "substring extraction"
10669 The three strings are expanded; the first two must yield numbers. Call them
10670 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10671 if <&'start'&> and <&'len'&> do not change when they are expanded, you
10672 can use the simpler operator notation that avoids some of the braces:
10673 .code
10674 ${substr_<n>_<m>:<subject>}
10675 .endd
10676 The second number is optional (in both notations).
10677 If it is absent in the simpler format, the preceding underscore must also be
10678 omitted.
10679
10680 The &%substr%& item can be used to extract more general substrings than
10681 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10682 length required. For example
10683 .code
10684 ${substr{3}{2}{$local_part}}
10685 .endd
10686 If the starting offset is greater than the string length the result is the
10687 null string; if the length plus starting offset is greater than the string
10688 length, the result is the right-hand part of the string, starting from the
10689 given offset. The first byte (character) in the string has offset zero.
10690
10691 The &%substr%& expansion item can take negative offset values to count
10692 from the right-hand end of its operand. The last byte (character) is offset -1,
10693 the second-last is offset -2, and so on. Thus, for example,
10694 .code
10695 ${substr{-5}{2}{1234567}}
10696 .endd
10697 yields &"34"&. If the absolute value of a negative offset is greater than the
10698 length of the string, the substring starts at the beginning of the string, and
10699 the length is reduced by the amount of overshoot. Thus, for example,
10700 .code
10701 ${substr{-5}{2}{12}}
10702 .endd
10703 yields an empty string, but
10704 .code
10705 ${substr{-3}{2}{12}}
10706 .endd
10707 yields &"1"&.
10708
10709 When the second number is omitted from &%substr%&, the remainder of the string
10710 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10711 string preceding the offset point are taken. For example, an offset of -1 and
10712 no length, as in these semantically identical examples:
10713 .code
10714 ${substr_-1:abcde}
10715 ${substr{-1}{abcde}}
10716 .endd
10717 yields all but the last character of the string, that is, &"abcd"&.
10718
10719 All measurement is done in bytes and is not UTF-8 aware.
10720
10721
10722
10723 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10724         {*&<&'replacements'&>&*}}*&"
10725 .cindex "expansion" "character translation"
10726 .cindex "&%tr%& expansion item"
10727 This item does single-character (in bytes) translation on its subject string. The second
10728 argument is a list of characters to be translated in the subject string. Each
10729 matching character is replaced by the corresponding character from the
10730 replacement list. For example
10731 .code
10732 ${tr{abcdea}{ac}{13}}
10733 .endd
10734 yields &`1b3de1`&. If there are duplicates in the second character string, the
10735 last occurrence is used. If the third string is shorter than the second, its
10736 last character is replicated. However, if it is empty, no translation takes
10737 place.
10738
10739 All character handling is done in bytes and is not UTF-8 aware.
10740
10741 .endlist
10742
10743
10744
10745 .section "Expansion operators" "SECTexpop"
10746 .cindex "expansion" "operators"
10747 For expansion items that perform transformations on a single argument string,
10748 the &"operator"& notation is used because it is simpler and uses fewer braces.
10749 The substring is first expanded before the operation is applied to it. The
10750 following operations can be performed:
10751
10752 .vlist
10753 .vitem &*${address:*&<&'string'&>&*}*&
10754 .cindex "expansion" "RFC 2822 address handling"
10755 .cindex "&%address%& expansion item"
10756 The string is interpreted as an RFC 2822 address, as it might appear in a
10757 header line, and the effective address is extracted from it. If the string does
10758 not parse successfully, the result is empty.
10759
10760 The parsing correctly handles SMTPUTF8 Unicode in the string.
10761
10762
10763 .vitem &*${addresses:*&<&'string'&>&*}*&
10764 .cindex "expansion" "RFC 2822 address handling"
10765 .cindex "&%addresses%& expansion item"
10766 The string (after expansion) is interpreted as a list of addresses in RFC
10767 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10768 operative address (&'local-part@domain'&) is extracted from each item, and the
10769 result of the expansion is a colon-separated list, with appropriate
10770 doubling of colons should any happen to be present in the email addresses.
10771 Syntactically invalid RFC2822 address items are omitted from the output.
10772
10773 It is possible to specify a character other than colon for the output
10774 separator by starting the string with > followed by the new separator
10775 character. For example:
10776 .code
10777 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10778 .endd
10779 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10780 first, so if the expanded string starts with >, it may change the output
10781 separator unintentionally. This can be avoided by setting the output
10782 separator explicitly:
10783 .code
10784 ${addresses:>:$h_from:}
10785 .endd
10786
10787 Compare the &%address%& (singular)
10788 expansion item, which extracts the working address from a single RFC2822
10789 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10790 processing lists.
10791
10792 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10793 a strict interpretation of header line formatting.  Exim parses the bare,
10794 unquoted portion of an email address and if it finds a comma, treats it as an
10795 email address separator. For the example header line:
10796 .code
10797 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10798 .endd
10799 The first example below demonstrates that Q-encoded email addresses are parsed
10800 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10801 It does not see the comma because it's still encoded as "=2C".  The second
10802 example below is passed the contents of &`$header_from:`&, meaning it gets
10803 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10804 The third example shows that the presence of a comma is skipped when it is
10805 quoted.  The fourth example shows SMTPUTF8 handling.
10806 .code
10807 # exim -be '${addresses:From: \
10808 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10809 user@example.com
10810 # exim -be '${addresses:From: Last, First <user@example.com>}'
10811 Last:user@example.com
10812 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10813 user@example.com
10814 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10815 フィリップ@example.jp
10816 .endd
10817
10818 .vitem &*${base32:*&<&'digits'&>&*}*&
10819 .cindex "&%base32%& expansion item"
10820 .cindex "expansion" "conversion to base 32"
10821 The string must consist entirely of decimal digits. The number is converted to
10822 base 32 and output as a (empty, for zero) string of characters.
10823 Only lowercase letters are used.
10824
10825 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10826 .cindex "&%base32d%& expansion item"
10827 .cindex "expansion" "conversion to base 32"
10828 The string must consist entirely of base-32 digits.
10829 The number is converted to decimal and output as a string.
10830
10831 .vitem &*${base62:*&<&'digits'&>&*}*&
10832 .cindex "&%base62%& expansion item"
10833 .cindex "expansion" "conversion to base 62"
10834 The string must consist entirely of decimal digits. The number is converted to
10835 base 62 and output as a string of six characters, including leading zeros. In
10836 the few operating environments where Exim uses base 36 instead of base 62 for
10837 its message identifiers (because those systems do not have case-sensitive
10838 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10839 to be absolutely clear: this is &'not'& base64 encoding.
10840
10841 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10842 .cindex "&%base62d%& expansion item"
10843 .cindex "expansion" "conversion to base 62"
10844 The string must consist entirely of base-62 digits, or, in operating
10845 environments where Exim uses base 36 instead of base 62 for its message
10846 identifiers, base-36 digits. The number is converted to decimal and output as a
10847 string.
10848
10849 .vitem &*${base64:*&<&'string'&>&*}*&
10850 .cindex "expansion" "base64 encoding"
10851 .cindex "base64 encoding" "in string expansion"
10852 .cindex "&%base64%& expansion item"
10853 .cindex certificate "base64 of DER"
10854 This operator converts a string into one that is base64 encoded.
10855
10856 If the string is a single variable of type certificate,
10857 returns the base64 encoding of the DER form of the certificate.
10858
10859
10860 .vitem &*${base64d:*&<&'string'&>&*}*&
10861 .cindex "expansion" "base64 decoding"
10862 .cindex "base64 decoding" "in string expansion"
10863 .cindex "&%base64d%& expansion item"
10864 This operator converts a base64-encoded string into the un-coded form.
10865
10866
10867 .vitem &*${domain:*&<&'string'&>&*}*&
10868 .cindex "domain" "extraction"
10869 .cindex "expansion" "domain extraction"
10870 The string is interpreted as an RFC 2822 address and the domain is extracted
10871 from it. If the string does not parse successfully, the result is empty.
10872
10873
10874 .vitem &*${escape:*&<&'string'&>&*}*&
10875 .cindex "expansion" "escaping non-printing characters"
10876 .cindex "&%escape%& expansion item"
10877 If the string contains any non-printing characters, they are converted to
10878 escape sequences starting with a backslash. Whether characters with the most
10879 significant bit set (so-called &"8-bit characters"&) count as printing or not
10880 is controlled by the &%print_topbitchars%& option.
10881
10882 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10883 .cindex "expansion" "escaping 8-bit characters"
10884 .cindex "&%escape8bit%& expansion item"
10885 If the string contains any characters with the most significant bit set,
10886 they are converted to escape sequences starting with a backslash.
10887 Backslashes and DEL characters are also converted.
10888
10889
10890 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10891 .cindex "expansion" "expression evaluation"
10892 .cindex "expansion" "arithmetic expression"
10893 .cindex "&%eval%& expansion item"
10894 These items supports simple arithmetic and bitwise logical operations in
10895 expansion strings. The string (after expansion) must be a conventional
10896 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10897 logical operators, and parentheses. All operations are carried out using
10898 integer arithmetic. The operator priorities are as follows (the same as in the
10899 C programming language):
10900 .table2 70pt 300pt
10901 .irow &'highest:'& "not (~), negate (-)"
10902 .irow ""   "multiply (*), divide (/), remainder (%)"
10903 .irow ""   "plus (+), minus (-)"
10904 .irow ""   "shift-left (<<), shift-right (>>)"
10905 .irow ""   "and (&&)"
10906 .irow ""   "xor (^)"
10907 .irow &'lowest:'&  "or (|)"
10908 .endtable
10909 Binary operators with the same priority are evaluated from left to right. White
10910 space is permitted before or after operators.
10911
10912 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10913 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10914 decimal, even if they start with a leading zero; hexadecimal numbers are not
10915 permitted. This can be useful when processing numbers extracted from dates or
10916 times, which often do have leading zeros.
10917
10918 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10919 or 1024*1024*1024,
10920 respectively. Negative numbers are supported. The result of the computation is
10921 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10922
10923 .display
10924 &`${eval:1+1}            `&  yields 2
10925 &`${eval:1+2*3}          `&  yields 7
10926 &`${eval:(1+2)*3}        `&  yields 9
10927 &`${eval:2+42%5}         `&  yields 4
10928 &`${eval:0xc&amp;5}          `&  yields 4
10929 &`${eval:0xc|5}          `&  yields 13
10930 &`${eval:0xc^5}          `&  yields 9
10931 &`${eval:0xc>>1}         `&  yields 6
10932 &`${eval:0xc<<1}         `&  yields 24
10933 &`${eval:~255&amp;0x1234}    `&  yields 4608
10934 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10935 .endd
10936
10937 As a more realistic example, in an ACL you might have
10938 .code
10939 deny   condition =                    \
10940          ${if and {                   \
10941            {>{$rcpt_count}{10}}       \
10942            {                          \
10943            <                          \
10944              {$recipients_count}      \
10945              {${eval:$rcpt_count/2}}  \
10946            }                          \
10947          }{yes}{no}}
10948        message = Too many bad recipients
10949 .endd
10950 The condition is true if there have been more than 10 RCPT commands and
10951 fewer than half of them have resulted in a valid recipient.
10952
10953
10954 .vitem &*${expand:*&<&'string'&>&*}*&
10955 .cindex "expansion" "re-expansion of substring"
10956 The &%expand%& operator causes a string to be expanded for a second time. For
10957 example,
10958 .code
10959 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10960 .endd
10961 first looks up a string in a file while expanding the operand for &%expand%&,
10962 and then re-expands what it has found.
10963
10964
10965 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10966 .cindex "Unicode"
10967 .cindex "UTF-8" "conversion from"
10968 .cindex "expansion" "UTF-8 conversion"
10969 .cindex "&%from_utf8%& expansion item"
10970 The world is slowly moving towards Unicode, although there are no standards for
10971 email yet. However, other applications (including some databases) are starting
10972 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10973 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10974 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10975 the result is an undefined sequence of bytes.
10976
10977 Unicode code points with values less than 256 are compatible with ASCII and
10978 ISO-8859-1 (also known as Latin-1).
10979 For example, character 169 is the copyright symbol in both cases, though the
10980 way it is encoded is different. In UTF-8, more than one byte is needed for
10981 characters with code values greater than 127, whereas ISO-8859-1 is a
10982 single-byte encoding (but thereby limited to 256 characters). This makes
10983 translation from UTF-8 to ISO-8859-1 straightforward.
10984
10985
10986 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10987 .cindex "hash function" "textual"
10988 .cindex "expansion" "textual hash"
10989 The &%hash%& operator is a simpler interface to the hashing function that can
10990 be used when the two parameters are fixed numbers (as opposed to strings that
10991 change when expanded). The effect is the same as
10992 .code
10993 ${hash{<n>}{<m>}{<string>}}
10994 .endd
10995 See the description of the general &%hash%& item above for details. The
10996 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10997
10998
10999
11000 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11001 .cindex "base64 encoding" "conversion from hex"
11002 .cindex "expansion" "hex to base64"
11003 .cindex "&%hex2b64%& expansion item"
11004 This operator converts a hex string into one that is base64 encoded. This can
11005 be useful for processing the output of the various hashing functions.
11006
11007
11008
11009 .vitem &*${hexquote:*&<&'string'&>&*}*&
11010 .cindex "quoting" "hex-encoded unprintable characters"
11011 .cindex "&%hexquote%& expansion item"
11012 This operator converts non-printable characters in a string into a hex
11013 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11014 as is, and other byte values are converted to &`\xNN`&, for example, a
11015 byte value 127 is converted to &`\x7f`&.
11016
11017
11018 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11019 .cindex "&%ipv6denorm%& expansion item"
11020 .cindex "IP address" normalisation
11021 This expands an IPv6 address to a full eight-element colon-separated set
11022 of hex digits including leading zeroes.
11023 A trailing ipv4-style dotted-decimal set is converted to hex.
11024 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11025
11026 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11027 .cindex "&%ipv6norm%& expansion item"
11028 .cindex "IP address" normalisation
11029 .cindex "IP address" "canonical form"
11030 This converts an IPv6 address to canonical form.
11031 Leading zeroes of groups are omitted, and the longest
11032 set of zero-valued groups is replaced with a double colon.
11033 A trailing ipv4-style dotted-decimal set is converted to hex.
11034 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11035
11036
11037 .vitem &*${lc:*&<&'string'&>&*}*&
11038 .cindex "case forcing in strings"
11039 .cindex "string" "case forcing"
11040 .cindex "lower casing"
11041 .cindex "expansion" "case forcing"
11042 .cindex "&%lc%& expansion item"
11043 This forces the letters in the string into lower-case, for example:
11044 .code
11045 ${lc:$local_part}
11046 .endd
11047 Case is defined per the system C locale.
11048
11049 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11050 .cindex "expansion" "string truncation"
11051 .cindex "&%length%& expansion item"
11052 The &%length%& operator is a simpler interface to the &%length%& function that
11053 can be used when the parameter is a fixed number (as opposed to a string that
11054 changes when expanded). The effect is the same as
11055 .code
11056 ${length{<number>}{<string>}}
11057 .endd
11058 See the description of the general &%length%& item above for details. Note that
11059 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11060 when &%length%& is used as an operator.
11061 All measurement is done in bytes and is not UTF-8 aware.
11062
11063
11064 .vitem &*${listcount:*&<&'string'&>&*}*&
11065 .cindex "expansion" "list item count"
11066 .cindex "list" "item count"
11067 .cindex "list" "count of items"
11068 .cindex "&%listcount%& expansion item"
11069 The string is interpreted as a list and the number of items is returned.
11070
11071
11072 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11073 .cindex "expansion" "named list"
11074 .cindex "&%listnamed%& expansion item"
11075 The name is interpreted as a named list and the content of the list is returned,
11076 expanding any referenced lists, re-quoting as needed for colon-separation.
11077 If the optional type is given it must be one of "a", "d", "h" or "l"
11078 and selects address-, domain-, host- or localpart- lists to search among respectively.
11079 Otherwise all types are searched in an undefined order and the first
11080 matching list is returned.
11081 &*Note*&: Neither string-expansion of lists referenced by named-list syntax elements,
11082 nor expansion of lookup elements, is done by the &%listnamed%& operator.
11083
11084
11085 .vitem &*${local_part:*&<&'string'&>&*}*&
11086 .cindex "expansion" "local part extraction"
11087 .cindex "&%local_part%& expansion item"
11088 The string is interpreted as an RFC 2822 address and the local part is
11089 extracted from it. If the string does not parse successfully, the result is
11090 empty.
11091 The parsing correctly handles SMTPUTF8 Unicode in the string.
11092
11093
11094 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*& &&&
11095        &*${mask_n:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11096 .cindex "masked IP address"
11097 .cindex "IP address" "masking"
11098 .cindex "CIDR notation"
11099 .cindex "expansion" "IP address masking"
11100 .cindex "&%mask%& expansion item"
11101 If the form of the string to be operated on is not an IP address followed by a
11102 slash and an integer (that is, a network address in CIDR notation), the
11103 expansion fails. Otherwise, this operator converts the IP address to binary,
11104 masks off the least significant bits according to the bit count, and converts
11105 the result back to text, with mask appended. For example,
11106 .code
11107 ${mask:10.111.131.206/28}
11108 .endd
11109 returns the string &"10.111.131.192/28"&.
11110
11111 Since this operation is expected to
11112 be mostly used for looking up masked addresses in files, the
11113 normal
11114 result for an IPv6
11115 address uses dots to separate components instead of colons, because colon
11116 terminates a key string in lsearch files. So, for example,
11117 .code
11118 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11119 .endd
11120 returns the string
11121 .code
11122 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11123 .endd
11124 If the optional form &*mask_n*& is used, IPv6 address result are instead
11125 returned in normailsed form, using colons and with zero-compression.
11126 Letters in IPv6 addresses are always output in lower case.
11127
11128
11129 .vitem &*${md5:*&<&'string'&>&*}*&
11130 .cindex "MD5 hash"
11131 .cindex "expansion" "MD5 hash"
11132 .cindex certificate fingerprint
11133 .cindex "&%md5%& expansion item"
11134 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11135 as a 32-digit hexadecimal number, in which any letters are in lower case.
11136
11137 If the string is a single variable of type certificate,
11138 returns the MD5 hash fingerprint of the certificate.
11139
11140
11141 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11142 .cindex "expansion" "numeric hash"
11143 .cindex "hash function" "numeric"
11144 The &%nhash%& operator is a simpler interface to the numeric hashing function
11145 that can be used when the two parameters are fixed numbers (as opposed to
11146 strings that change when expanded). The effect is the same as
11147 .code
11148 ${nhash{<n>}{<m>}{<string>}}
11149 .endd
11150 See the description of the general &%nhash%& item above for details.
11151
11152
11153 .vitem &*${quote:*&<&'string'&>&*}*&
11154 .cindex "quoting" "in string expansions"
11155 .cindex "expansion" "quoting"
11156 .cindex "&%quote%& expansion item"
11157 The &%quote%& operator puts its argument into double quotes if it
11158 is an empty string or
11159 contains anything other than letters, digits, underscores, dots, and hyphens.
11160 Any occurrences of double quotes and backslashes are escaped with a backslash.
11161 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11162 respectively For example,
11163 .code
11164 ${quote:ab"*"cd}
11165 .endd
11166 becomes
11167 .code
11168 "ab\"*\"cd"
11169 .endd
11170 The place where this is useful is when the argument is a substitution from a
11171 variable or a message header.
11172
11173 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11174 .cindex "&%quote_local_part%& expansion item"
11175 This operator is like &%quote%&, except that it quotes the string only if
11176 required to do so by the rules of RFC 2822 for quoting local parts. For
11177 example, a plus sign would not cause quoting (but it would for &%quote%&).
11178 If you are creating a new email address from the contents of &$local_part$&
11179 (or any other unknown data), you should always use this operator.
11180
11181 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11182 will likely use the quoting form.
11183 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11184
11185
11186 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11187 .cindex "quoting" "lookup-specific"
11188 This operator applies lookup-specific quoting rules to the string. Each
11189 query-style lookup type has its own quoting rules which are described with
11190 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11191 .code
11192 ${quote_ldap:two * two}
11193 .endd
11194 returns
11195 .code
11196 two%20%5C2A%20two
11197 .endd
11198 For single-key lookup types, no quoting is ever necessary and this operator
11199 yields an unchanged string.
11200
11201
11202 .vitem &*${randint:*&<&'n'&>&*}*&
11203 .cindex "random number"
11204 This operator returns a somewhat random number which is less than the
11205 supplied number and is at least 0.  The quality of this randomness depends
11206 on how Exim was built; the values are not suitable for keying material.
11207 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11208 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11209 for versions of GnuTLS with that function.
11210 Otherwise, the implementation may be arc4random(), random() seeded by
11211 srandomdev() or srandom(), or a custom implementation even weaker than
11212 random().
11213
11214
11215 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11216 .cindex "expansion" "IP address"
11217 This operator reverses an IP address; for IPv4 addresses, the result is in
11218 dotted-quad decimal form, while for IPv6 addresses the result is in
11219 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11220 for DNS.  For example,
11221 .code
11222 ${reverse_ip:192.0.2.4}
11223 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11224 .endd
11225 returns
11226 .code
11227 4.2.0.192
11228 f.7.2.0.0.0.0.c.d.c.b.a.1.0.0.0.9.0.0.0.2.4.c.0.8.b.d.0.1.0.0.2
11229 .endd
11230
11231
11232 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11233 .cindex "expansion" "RFC 2047"
11234 .cindex "RFC 2047" "expansion operator"
11235 .cindex "&%rfc2047%& expansion item"
11236 This operator encodes text according to the rules of RFC 2047. This is an
11237 encoding that is used in header lines to encode non-ASCII characters. It is
11238 assumed that the input string is in the encoding specified by the
11239 &%headers_charset%& option, which gets its default at build time. If the string
11240 contains only characters in the range 33&--126, and no instances of the
11241 characters
11242 .code
11243 ? = ( ) < > @ , ; : \ " . [ ] _
11244 .endd
11245 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11246 string, using as many &"encoded words"& as necessary to encode all the
11247 characters.
11248
11249
11250 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11251 .cindex "expansion" "RFC 2047"
11252 .cindex "RFC 2047" "decoding"
11253 .cindex "&%rfc2047d%& expansion item"
11254 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11255 bytes are replaced by question marks. Characters are converted into the
11256 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11257 not recognized unless &%check_rfc2047_length%& is set false.
11258
11259 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11260 access a header line, RFC 2047 decoding is done automatically. You do not need
11261 to use this operator as well.
11262
11263
11264
11265 .vitem &*${rxquote:*&<&'string'&>&*}*&
11266 .cindex "quoting" "in regular expressions"
11267 .cindex "regular expressions" "quoting"
11268 .cindex "&%rxquote%& expansion item"
11269 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11270 characters in its argument. This is useful when substituting the values of
11271 variables or headers inside regular expressions.
11272
11273
11274 .vitem &*${sha1:*&<&'string'&>&*}*&
11275 .cindex "SHA-1 hash"
11276 .cindex "expansion" "SHA-1 hashing"
11277 .cindex certificate fingerprint
11278 .cindex "&%sha1%& expansion item"
11279 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11280 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11281
11282 If the string is a single variable of type certificate,
11283 returns the SHA-1 hash fingerprint of the certificate.
11284
11285
11286 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11287        &*${sha2:*&<&'string'&>&*}*& &&&
11288        &*${sha2_<n>:*&<&'string'&>&*}*&
11289 .cindex "SHA-256 hash"
11290 .cindex "SHA-2 hash"
11291 .cindex certificate fingerprint
11292 .cindex "expansion" "SHA-256 hashing"
11293 .cindex "&%sha256%& expansion item"
11294 .cindex "&%sha2%& expansion item"
11295 The &%sha256%& operator computes the SHA-256 hash value of the string
11296 and returns
11297 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11298
11299 If the string is a single variable of type certificate,
11300 returns the SHA-256 hash fingerprint of the certificate.
11301
11302 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11303 (except for certificates, which are not supported).
11304 Finally, if an underbar
11305 and a number is appended it specifies the output length, selecting a
11306 member of the SHA-2 family of hash functions.
11307 Values of 256, 384 and 512 are accepted, with 256 being the default.
11308
11309
11310 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11311        &*${sha3_<n>:*&<&'string'&>&*}*&
11312 .cindex "SHA3 hash"
11313 .cindex "expansion" "SHA3 hashing"
11314 .cindex "&%sha3%& expansion item"
11315 The &%sha3%& operator computes the SHA3-256 hash value of the string
11316 and returns
11317 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11318
11319 If a number is appended, separated by an underbar, it specifies
11320 the output length.  Values of 224, 256, 384 and 512 are accepted;
11321 with 256 being the default.
11322
11323 The &%sha3%& expansion item is only supported if Exim has been
11324 compiled with GnuTLS 3.5.0 or later,
11325 or OpenSSL 1.1.1 or later.
11326 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11327
11328
11329 .vitem &*${stat:*&<&'string'&>&*}*&
11330 .cindex "expansion" "statting a file"
11331 .cindex "file" "extracting characteristics"
11332 .cindex "&%stat%& expansion item"
11333 The string, after expansion, must be a file path. A call to the &[stat()]&
11334 function is made for this path. If &[stat()]& fails, an error occurs and the
11335 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11336 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11337 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11338 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11339 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11340 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11341 can extract individual fields using the &%extract%& expansion item.
11342
11343 The use of the &%stat%& expansion in users' filter files can be locked out by
11344 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11345 systems for files larger than 2GB.
11346
11347 .vitem &*${str2b64:*&<&'string'&>&*}*&
11348 .cindex "&%str2b64%& expansion item"
11349 Now deprecated, a synonym for the &%base64%& expansion operator.
11350
11351
11352
11353 .vitem &*${strlen:*&<&'string'&>&*}*&
11354 .cindex "expansion" "string length"
11355 .cindex "string" "length in expansion"
11356 .cindex "&%strlen%& expansion item"
11357 The item is replaced by the length of the expanded string, expressed as a
11358 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11359 All measurement is done in bytes and is not UTF-8 aware.
11360
11361
11362 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11363 .cindex "&%substr%& expansion item"
11364 .cindex "substring extraction"
11365 .cindex "expansion" "substring expansion"
11366 The &%substr%& operator is a simpler interface to the &%substr%& function that
11367 can be used when the two parameters are fixed numbers (as opposed to strings
11368 that change when expanded). The effect is the same as
11369 .code
11370 ${substr{<start>}{<length>}{<string>}}
11371 .endd
11372 See the description of the general &%substr%& item above for details. The
11373 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11374 All measurement is done in bytes and is not UTF-8 aware.
11375
11376 .vitem &*${time_eval:*&<&'string'&>&*}*&
11377 .cindex "&%time_eval%& expansion item"
11378 .cindex "time interval" "decoding"
11379 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11380 seconds.
11381
11382 .vitem &*${time_interval:*&<&'string'&>&*}*&
11383 .cindex "&%time_interval%& expansion item"
11384 .cindex "time interval" "formatting"
11385 The argument (after sub-expansion) must be a sequence of decimal digits that
11386 represents an interval of time as a number of seconds. It is converted into a
11387 number of larger units and output in Exim's normal time format, for example,
11388 &`1w3d4h2m6s`&.
11389
11390 .vitem &*${uc:*&<&'string'&>&*}*&
11391 .cindex "case forcing in strings"
11392 .cindex "string" "case forcing"
11393 .cindex "upper casing"
11394 .cindex "expansion" "case forcing"
11395 .cindex "&%uc%& expansion item"
11396 This forces the letters in the string into upper-case.
11397 Case is defined per the system C locale.
11398
11399 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11400 .cindex "correction of invalid utf-8 sequences in strings"
11401 .cindex "utf-8" "utf-8 sequences"
11402 .cindex "incorrect utf-8"
11403 .cindex "expansion" "utf-8 forcing"
11404 .cindex "&%utf8clean%& expansion item"
11405 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11406 In versions of Exim before 4.92, this did not correctly do so for a truncated
11407 final codepoint's encoding, and the character would be silently dropped.
11408 If you must handle detection of this scenario across both sets of Exim behavior,
11409 the complexity will depend upon the task.
11410 For instance, to detect if the first character is multibyte and a 1-byte
11411 extraction can be successfully used as a path component (as is common for
11412 dividing up delivery folders), you might use:
11413 .code
11414 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11415 .endd
11416 (which will false-positive if the first character of the local part is a
11417 literal question mark).
11418
11419 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11420        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11421        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11422        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11423 .cindex expansion UTF-8
11424 .cindex UTF-8 expansion
11425 .cindex EAI
11426 .cindex internationalisation
11427 .cindex "&%utf8_domain_to_alabel%& expansion item"
11428 .cindex "&%utf8_domain_from_alabel%& expansion item"
11429 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11430 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11431 These convert EAI mail name components between UTF-8 and a-label forms.
11432 For information on internationalisation support see &<<SECTi18nMTA>>&.
11433 .endlist
11434
11435
11436
11437
11438
11439
11440 .section "Expansion conditions" "SECTexpcond"
11441 .scindex IIDexpcond "expansion" "conditions"
11442 The following conditions are available for testing by the &%${if%& construct
11443 while expanding strings:
11444
11445 .vlist
11446 .vitem &*!*&<&'condition'&>
11447 .cindex "expansion" "negating a condition"
11448 .cindex "negation" "in expansion condition"
11449 Preceding any condition with an exclamation mark negates the result of the
11450 condition.
11451
11452 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11453 .cindex "numeric comparison"
11454 .cindex "expansion" "numeric comparison"
11455 There are a number of symbolic operators for doing numeric comparisons. They
11456 are:
11457 .itable none 0 0 2 10* left 90* left
11458 .irow "=   " "equal"
11459 .irow "==  " "equal"
11460 .irow ">   " "greater"
11461 .irow ">=  " "greater or equal"
11462 .irow "<   " "less"
11463 .irow "<=  " "less or equal"
11464 .endtable
11465 For example:
11466 .code
11467 ${if >{$message_size}{10M} ...
11468 .endd
11469 Note that the general negation operator provides for inequality testing. The
11470 two strings must take the form of optionally signed decimal integers,
11471 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11472 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11473 As a special case, the numerical value of an empty string is taken as
11474 zero.
11475
11476 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11477 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11478 10M, not if 10M is larger than &$message_size$&.
11479
11480
11481 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11482         {*&<&'arg2'&>&*}...}*&
11483 .cindex "expansion" "calling an acl"
11484 .cindex "&%acl%&" "expansion condition"
11485 The name and zero to nine argument strings are first expanded separately.  The expanded
11486 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11487 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11488 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11489 and may use the variables; if another acl expansion is used the values
11490 are restored after it returns.  If the ACL sets
11491 a value using a "message =" modifier the variable $value becomes
11492 the result of the expansion, otherwise it is empty.
11493 If the ACL returns accept the condition is true; if deny, false.
11494 If the ACL returns defer the result is a forced-fail.
11495
11496 .vitem &*bool&~{*&<&'string'&>&*}*&
11497 .cindex "expansion" "boolean parsing"
11498 .cindex "&%bool%& expansion condition"
11499 This condition turns a string holding a true or false representation into
11500 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11501 (case-insensitively); also integer numbers map to true if non-zero,
11502 false if zero.
11503 An empty string is treated as false.
11504 Leading and trailing whitespace is ignored;
11505 thus a string consisting only of whitespace is false.
11506 All other string values will result in expansion failure.
11507
11508 When combined with ACL variables, this expansion condition will let you
11509 make decisions in one place and act on those decisions in another place.
11510 For example:
11511 .code
11512 ${if bool{$acl_m_privileged_sender} ...
11513 .endd
11514
11515
11516 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11517 .cindex "expansion" "boolean parsing"
11518 .cindex "&%bool_lax%& expansion condition"
11519 Like &%bool%&, this condition turns a string into a boolean state.  But
11520 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11521 loose definition that the Router &%condition%& option uses.  The empty string
11522 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11523 true.  Leading and trailing whitespace is ignored.
11524
11525 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11526
11527 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11528 .cindex "expansion" "encrypted comparison"
11529 .cindex "encrypted strings, comparing"
11530 .cindex "&%crypteq%& expansion condition"
11531 This condition is included in the Exim binary if it is built to support any
11532 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11533 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11534 included in the binary.
11535
11536 The &%crypteq%& condition has two arguments. The first is encrypted and
11537 compared against the second, which is already encrypted. The second string may
11538 be in the LDAP form for storing encrypted strings, which starts with the
11539 encryption type in curly brackets, followed by the data. If the second string
11540 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11541 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11542 Typically this will be a field from a password file. An example of an encrypted
11543 string in LDAP form is:
11544 .code
11545 {md5}CY9rzUYh03PK3k6DJie09g==
11546 .endd
11547 If such a string appears directly in an expansion, the curly brackets have to
11548 be quoted, because they are part of the expansion syntax. For example:
11549 .code
11550 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11551 .endd
11552 The following encryption types (whose names are matched case-independently) are
11553 supported:
11554
11555 .ilist
11556 .cindex "MD5 hash"
11557 .cindex "base64 encoding" "in encrypted password"
11558 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11559 printable characters to compare with the remainder of the second string. If the
11560 length of the comparison string is 24, Exim assumes that it is base64 encoded
11561 (as in the above example). If the length is 32, Exim assumes that it is a
11562 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11563 comparison fails.
11564
11565 .next
11566 .cindex "SHA-1 hash"
11567 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11568 printable characters to compare with the remainder of the second string. If the
11569 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11570 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11571 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11572
11573 .next
11574 .cindex "&[crypt()]&"
11575 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11576 only the first eight characters of the password. However, in modern operating
11577 systems this is no longer true, and in many cases the entire password is used,
11578 whatever its length.
11579
11580 .next
11581 .cindex "&[crypt16()]&"
11582 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11583 use up to 16 characters of the password in some operating systems. Again, in
11584 modern operating systems, more characters may be used.
11585 .endlist
11586 Exim has its own version of &[crypt16()]&, which is just a double call to
11587 &[crypt()]&. For operating systems that have their own version, setting
11588 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11589 operating system version instead of its own. This option is set by default in
11590 the OS-dependent &_Makefile_& for those operating systems that are known to
11591 support &[crypt16()]&.
11592
11593 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11594 it was not using the same algorithm as some operating systems' versions. It
11595 turns out that as well as &[crypt16()]& there is a function called
11596 &[bigcrypt()]& in some operating systems. This may or may not use the same
11597 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11598
11599 However, since there is now a move away from the traditional &[crypt()]&
11600 functions towards using SHA1 and other algorithms, tidying up this area of
11601 Exim is seen as very low priority.
11602
11603 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11604 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11605 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11606 default is &`{crypt}`&. Whatever the default, you can always use either
11607 function by specifying it explicitly in curly brackets.
11608
11609 .vitem &*def:*&<&'variable&~name'&>
11610 .cindex "expansion" "checking for empty variable"
11611 .cindex "&%def%& expansion condition"
11612 The &%def%& condition must be followed by the name of one of the expansion
11613 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11614 variable does not contain the empty string. For example:
11615 .code
11616 ${if def:sender_ident {from $sender_ident}}
11617 .endd
11618 Note that the variable name is given without a leading &%$%& character. If the
11619 variable does not exist, the expansion fails.
11620
11621 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11622         &~&*def:h_*&<&'header&~name'&>&*:*&"
11623 .cindex "expansion" "checking header line existence"
11624 This condition is true if a message is being processed and the named header
11625 exists in the message. For example,
11626 .code
11627 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11628 .endd
11629 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11630 the header name must be terminated by a colon if white space does not follow.
11631
11632 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11633        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11634 .cindex "string" "comparison"
11635 .cindex "expansion" "string comparison"
11636 .cindex "&%eq%& expansion condition"
11637 .cindex "&%eqi%& expansion condition"
11638 The two substrings are first expanded. The condition is true if the two
11639 resulting strings are identical. For &%eq%& the comparison includes the case of
11640 letters, whereas for &%eqi%& the comparison is case-independent, where
11641 case is defined per the system C locale.
11642
11643 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11644 .cindex "expansion" "file existence test"
11645 .cindex "file" "existence test"
11646 .cindex "&%exists%&, expansion condition"
11647 The substring is first expanded and then interpreted as an absolute path. The
11648 condition is true if the named file (or directory) exists. The existence test
11649 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11650 users' filter files may be locked out by the system administrator.
11651
11652 &*Note:*& Testing a path using this condition is not a sufficient way of
11653 de-tainting it.
11654 Consider using a dsearch lookup.
11655
11656 .vitem &*first_delivery*&
11657 .cindex "delivery" "first"
11658 .cindex "first delivery"
11659 .cindex "expansion" "first delivery test"
11660 .cindex "&%first_delivery%& expansion condition"
11661 This condition, which has no data, is true during a message's first delivery
11662 attempt. It is false during any subsequent delivery attempts.
11663
11664
11665 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11666        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11667 .cindex "list" "iterative conditions"
11668 .cindex "expansion" "&*forall*& condition"
11669 .cindex "expansion" "&*forany*& condition"
11670 .vindex "&$item$&"
11671 These conditions iterate over a list. The first argument is expanded to form
11672 the list. By default, the list separator is a colon, but it can be changed by
11673 the normal method (&<<SECTlistsepchange>>&).
11674 The second argument is interpreted as a condition that is to
11675 be applied to each item in the list in turn. During the interpretation of the
11676 condition, the current list item is placed in a variable called &$item$&.
11677 .ilist
11678 For &*forany*&, interpretation stops if the condition is true for any item, and
11679 the result of the whole condition is true. If the condition is false for all
11680 items in the list, the overall condition is false.
11681 .next
11682 For &*forall*&, interpretation stops if the condition is false for any item,
11683 and the result of the whole condition is false. If the condition is true for
11684 all items in the list, the overall condition is true.
11685 .endlist
11686 Note that negation of &*forany*& means that the condition must be false for all
11687 items for the overall condition to succeed, and negation of &*forall*& means
11688 that the condition must be false for at least one item. In this example, the
11689 list separator is changed to a comma:
11690 .code
11691 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11692 .endd
11693 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11694 being processed, to enable these expansion items to be nested.
11695
11696 To scan a named list, expand it with the &*listnamed*& operator.
11697
11698 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11699        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11700        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11701        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11702 .cindex JSON "iterative conditions"
11703 .cindex JSON expansions
11704 .cindex expansion "&*forall_json*& condition"
11705 .cindex expansion "&*forany_json*& condition"
11706 .cindex expansion "&*forall_jsons*& condition"
11707 .cindex expansion "&*forany_jsons*& condition"
11708 As for the above, except that the first argument must, after expansion,
11709 be a JSON array.
11710 The array separator is not changeable.
11711 For the &"jsons"& variants the elements are expected to be JSON strings
11712 and have their quotes removed before the evaluation of the condition.
11713
11714
11715
11716 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11717        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11718 .cindex "string" "comparison"
11719 .cindex "expansion" "string comparison"
11720 .cindex "&%ge%& expansion condition"
11721 .cindex "&%gei%& expansion condition"
11722 The two substrings are first expanded. The condition is true if the first
11723 string is lexically greater than or equal to the second string. For &%ge%& the
11724 comparison includes the case of letters, whereas for &%gei%& the comparison is
11725 case-independent.
11726 Case and collation order are defined per the system C locale.
11727
11728 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11729        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11730 .cindex "string" "comparison"
11731 .cindex "expansion" "string comparison"
11732 .cindex "&%gt%& expansion condition"
11733 .cindex "&%gti%& expansion condition"
11734 The two substrings are first expanded. The condition is true if the first
11735 string is lexically greater than the second string. For &%gt%& the comparison
11736 includes the case of letters, whereas for &%gti%& the comparison is
11737 case-independent.
11738 Case and collation order are defined per the system C locale.
11739
11740
11741 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11742 SRS decode.  See SECT &<<SECTSRS>>& for details.
11743
11744
11745 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11746        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11747 .cindex "string" "comparison"
11748 .cindex "list" "iterative conditions"
11749 Both strings are expanded; the second string is treated as a list of simple
11750 strings; if the first string is a member of the second, then the condition
11751 is true.
11752 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11753
11754 These are simpler to use versions of the more powerful &*forany*& condition.
11755 Examples, and the &*forany*& equivalents:
11756 .code
11757 ${if inlist{needle}{foo:needle:bar}}
11758   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11759 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11760   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11761 .endd
11762
11763 The variable &$value$& will be set for a successful match and can be
11764 used in the success clause of an &%if%& expansion item using the condition.
11765 .cindex "tainted data" "de-tainting"
11766 .cindex "de-tainting" "using an inlist expansion condition"
11767 It will have the same taint status as the list; expansions such as
11768 .code
11769 ${if inlist {$h_mycode:} {0 : 1 : 42} {$value}}
11770 .endd
11771 can be used for de-tainting.
11772 Any previous &$value$& is restored after the if.
11773
11774
11775 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11776        &*isip4&~{*&<&'string'&>&*}*& &&&
11777        &*isip6&~{*&<&'string'&>&*}*&
11778 .cindex "IP address" "testing string format"
11779 .cindex "string" "testing for IP address"
11780 .cindex "&%isip%& expansion condition"
11781 .cindex "&%isip4%& expansion condition"
11782 .cindex "&%isip6%& expansion condition"
11783 The substring is first expanded, and then tested to see if it has the form of
11784 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11785 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11786
11787 For an IPv4 address, the test is for four dot-separated components, each of
11788 which consists of from one to three digits. For an IPv6 address, up to eight
11789 colon-separated components are permitted, each containing from one to four
11790 hexadecimal digits. There may be fewer than eight components if an empty
11791 component (adjacent colons) is present. Only one empty component is permitted.
11792
11793 &*Note*&: The checks used to be just on the form of the address; actual numerical
11794 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11795 check.
11796 This is no longer the case.
11797
11798 The main use of these tests is to distinguish between IP addresses and
11799 host names, or between IPv4 and IPv6 addresses. For example, you could use
11800 .code
11801 ${if isip4{$sender_host_address}...
11802 .endd
11803 to test which IP version an incoming SMTP connection is using.
11804
11805 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11806 .cindex "LDAP" "use for authentication"
11807 .cindex "expansion" "LDAP authentication test"
11808 .cindex "&%ldapauth%& expansion condition"
11809 This condition supports user authentication using LDAP. See section
11810 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11811 queries. For this use, the query must contain a user name and password. The
11812 query itself is not used, and can be empty. The condition is true if the
11813 password is not empty, and the user name and password are accepted by the LDAP
11814 server. An empty password is rejected without calling LDAP because LDAP binds
11815 with an empty password are considered anonymous regardless of the username, and
11816 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11817 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11818 this can be used.
11819
11820
11821 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11822        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11823 .cindex "string" "comparison"
11824 .cindex "expansion" "string comparison"
11825 .cindex "&%le%& expansion condition"
11826 .cindex "&%lei%& expansion condition"
11827 The two substrings are first expanded. The condition is true if the first
11828 string is lexically less than or equal to the second string. For &%le%& the
11829 comparison includes the case of letters, whereas for &%lei%& the comparison is
11830 case-independent.
11831 Case and collation order are defined per the system C locale.
11832
11833 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11834        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11835 .cindex "string" "comparison"
11836 .cindex "expansion" "string comparison"
11837 .cindex "&%lt%& expansion condition"
11838 .cindex "&%lti%& expansion condition"
11839 The two substrings are first expanded. The condition is true if the first
11840 string is lexically less than the second string. For &%lt%& the comparison
11841 includes the case of letters, whereas for &%lti%& the comparison is
11842 case-independent.
11843 Case and collation order are defined per the system C locale.
11844
11845
11846 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11847 .cindex "expansion" "regular expression comparison"
11848 .cindex "regular expressions" "match in expanded string"
11849 .cindex "&%match%& expansion condition"
11850 The two substrings are first expanded. The second is then treated as a regular
11851 expression and applied to the first. Because of the pre-expansion, if the
11852 regular expression contains dollar, or backslash characters, they must be
11853 escaped. Care must also be taken if the regular expression contains braces
11854 (curly brackets). A closing brace must be escaped so that it is not taken as a
11855 premature termination of <&'string2'&>. The easiest approach is to use the
11856 &`\N`& feature to disable expansion of the regular expression.
11857 For example,
11858 .code
11859 ${if match {$local_part}{\N^\d{3}\N} ...
11860 .endd
11861 If the whole expansion string is in double quotes, further escaping of
11862 backslashes is also required.
11863
11864 The condition is true if the regular expression match succeeds.
11865 The regular expression is not required to begin with a circumflex
11866 metacharacter, but if there is no circumflex, the expression is not anchored,
11867 and it may match anywhere in the subject, not just at the start. If you want
11868 the pattern to match at the end of the subject, you must include the &`$`&
11869 metacharacter at an appropriate point.
11870 All character handling is done in bytes and is not UTF-8 aware,
11871 but we might change this in a future Exim release.
11872
11873 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11874 At the start of an &%if%& expansion the values of the numeric variable
11875 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11876 succeeds causes them to be reset to the substrings of that condition and they
11877 will have these values during the expansion of the success string. At the end
11878 of the &%if%& expansion, the previous values are restored. After testing a
11879 combination of conditions using &%or%&, the subsequent values of the numeric
11880 variables are those of the condition that succeeded.
11881
11882 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11883 .cindex "&%match_address%& expansion condition"
11884 See &*match_local_part*&.
11885
11886 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11887 .cindex "&%match_domain%& expansion condition"
11888 See &*match_local_part*&.
11889
11890 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11891 .cindex "&%match_ip%& expansion condition"
11892 This condition matches an IP address to a list of IP address patterns. It must
11893 be followed by two argument strings. The first (after expansion) must be an IP
11894 address or an empty string. The second (not expanded) is a restricted host
11895 list that can match only an IP address, not a host name. For example:
11896 .code
11897 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11898 .endd
11899 The specific types of host list item that are permitted in the list are:
11900
11901 .ilist
11902 An IP address, optionally with a CIDR mask.
11903 .next
11904 A single asterisk, which matches any IP address.
11905 .next
11906 An empty item, which matches only if the IP address is empty. This could be
11907 useful for testing for a locally submitted message or one from specific hosts
11908 in a single test such as
11909 . ==== As this is a nested list, any displays it contains must be indented
11910 . ==== as otherwise they are too far to the left. This comment applies to
11911 . ==== the use of xmlto plus fop. There's no problem when formatting with
11912 . ==== sdop, with or without the extra indent.
11913 .code
11914   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11915 .endd
11916 where the first item in the list is the empty string.
11917 .next
11918 The item @[] matches any of the local host's interface addresses.
11919 .next
11920 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11921 even if &`net-`& is not specified. There is never any attempt to turn the IP
11922 address into a host name. The most common type of linear search for
11923 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11924 masks. For example:
11925 .code
11926   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11927 .endd
11928 It is of course possible to use other kinds of lookup, and in such a case, you
11929 do need to specify the &`net-`& prefix if you want to specify a specific
11930 address mask, for example:
11931 .code
11932   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11933 .endd
11934 However, unless you are combining a &%match_ip%& condition with others, it is
11935 just as easy to use the fact that a lookup is itself a condition, and write:
11936 .code
11937   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11938 .endd
11939 .endlist ilist
11940
11941 Note that <&'string2'&> is not itself subject to string expansion, unless
11942 Exim was built with the EXPAND_LISTMATCH_RHS option.
11943
11944 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11945
11946 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11947 .cindex "domain list" "in expansion condition"
11948 .cindex "address list" "in expansion condition"
11949 .cindex "local part" "list, in expansion condition"
11950 .cindex "&%match_local_part%& expansion condition"
11951 This condition, together with &%match_address%& and &%match_domain%&, make it
11952 possible to test domain, address, and local part lists within expansions. Each
11953 condition requires two arguments: an item and a list to match. A trivial
11954 example is:
11955 .code
11956 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11957 .endd
11958 In each case, the second argument may contain any of the allowable items for a
11959 list of the appropriate type. Also, because the second argument
11960 is a standard form of list, it is possible to refer to a named list.
11961 Thus, you can use conditions like this:
11962 .code
11963 ${if match_domain{$domain}{+local_domains}{...
11964 .endd
11965 .cindex "&`+caseful`&"
11966 For address lists, the matching starts off caselessly, but the &`+caseful`&
11967 item can be used, as in all address lists, to cause subsequent items to
11968 have their local parts matched casefully. Domains are always matched
11969 caselessly.
11970
11971 The variable &$value$& will be set for a successful match and can be
11972 used in the success clause of an &%if%& expansion item using the condition.
11973 .cindex "tainted data" "de-tainting"
11974 .cindex "de-tainting" "using a match_local_part expansion condition"
11975 It will have the same taint status as the list; expansions such as
11976 .code
11977 ${if match_local_part {$local_part} {alice : bill : charlotte : dave} {$value}}
11978 .endd
11979 can be used for de-tainting.
11980 Any previous &$value$& is restored after the if.
11981
11982 Note that <&'string2'&> is not itself subject to string expansion, unless
11983 Exim was built with the EXPAND_LISTMATCH_RHS option.
11984
11985 &*Note*&: Host lists are &'not'& supported in this way. This is because
11986 hosts have two identities: a name and an IP address, and it is not clear
11987 how to specify cleanly how such a test would work. However, IP addresses can be
11988 matched using &%match_ip%&.
11989
11990 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11991 .cindex "PAM authentication"
11992 .cindex "AUTH" "with PAM"
11993 .cindex "Solaris" "PAM support"
11994 .cindex "expansion" "PAM authentication test"
11995 .cindex "&%pam%& expansion condition"
11996 &'Pluggable Authentication Modules'&
11997 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11998 available in Solaris
11999 and in some GNU/Linux distributions.
12000 The Exim support, which is intended for use in conjunction with
12001 the SMTP AUTH command, is available only if Exim is compiled with
12002 .code
12003 SUPPORT_PAM=yes
12004 .endd
12005 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12006 in some releases of GNU/Linux &%-ldl%& is also needed.
12007
12008 The argument string is first expanded, and the result must be a
12009 colon-separated list of strings. Leading and trailing white space is ignored.
12010 The PAM module is initialized with the service name &"exim"& and the user name
12011 taken from the first item in the colon-separated data string (<&'string1'&>).
12012 The remaining items in the data string are passed over in response to requests
12013 from the authentication function. In the simple case there will only be one
12014 request, for a password, so the data consists of just two strings.
12015
12016 There can be problems if any of the strings are permitted to contain colon
12017 characters. In the usual way, these have to be doubled to avoid being taken as
12018 separators.
12019 The &%listquote%& expansion item can be used for this.
12020 For example, the configuration
12021 of a LOGIN authenticator might contain this setting:
12022 .code
12023 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12024 .endd
12025 In some operating systems, PAM authentication can be done only from a process
12026 running as root. Since Exim is running as the Exim user when receiving
12027 messages, this means that PAM cannot be used directly in those systems.
12028 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12029
12030
12031 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12032 .cindex "&'pwcheck'& daemon"
12033 .cindex "Cyrus"
12034 .cindex "expansion" "&'pwcheck'& authentication test"
12035 .cindex "&%pwcheck%& expansion condition"
12036 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12037 This is one way of making it possible for passwords to be checked by a process
12038 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12039 deprecated. Its replacement is &'saslauthd'& (see below).
12040
12041 The pwcheck support is not included in Exim by default. You need to specify
12042 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12043 building Exim. For example:
12044 .code
12045 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12046 .endd
12047 You do not need to install the full Cyrus software suite in order to use
12048 the pwcheck daemon. You can compile and install just the daemon alone
12049 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12050 access to the &_/var/pwcheck_& directory.
12051
12052 The &%pwcheck%& condition takes one argument, which must be the user name and
12053 password, separated by a colon. For example, in a LOGIN authenticator
12054 configuration, you might have this:
12055 .code
12056 server_condition = ${if pwcheck{$auth1:$auth2}}
12057 .endd
12058 Again, for a PLAIN authenticator configuration, this would be:
12059 .code
12060 server_condition = ${if pwcheck{$auth2:$auth3}}
12061 .endd
12062 .vitem &*queue_running*&
12063 .cindex "queue runner" "detecting when delivering from"
12064 .cindex "expansion" "queue runner test"
12065 .cindex "&%queue_running%& expansion condition"
12066 This condition, which has no data, is true during delivery attempts that are
12067 initiated by queue runner processes, and false otherwise.
12068
12069
12070 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12071 .cindex "Radius"
12072 .cindex "expansion" "Radius authentication"
12073 .cindex "&%radius%& expansion condition"
12074 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12075 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12076 the Radius client configuration file in order to build Exim with Radius
12077 support.
12078
12079 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12080 library, using the original API. If you are using release 0.4.0 or later of
12081 this library, you need to set
12082 .code
12083 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12084 .endd
12085 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12086 &%libradius%& library that comes with FreeBSD. To do this, set
12087 .code
12088 RADIUS_LIB_TYPE=RADLIB
12089 .endd
12090 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12091 You may also have to supply a suitable setting in EXTRALIBS so that the
12092 Radius library can be found when Exim is linked.
12093
12094 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12095 Radius client library, which calls the Radius server. The condition is true if
12096 the authentication is successful. For example:
12097 .code
12098 server_condition = ${if radius{<arguments>}}
12099 .endd
12100
12101
12102 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12103         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12104 .cindex "&'saslauthd'& daemon"
12105 .cindex "Cyrus"
12106 .cindex "expansion" "&'saslauthd'& authentication test"
12107 .cindex "&%saslauthd%& expansion condition"
12108 This condition supports user authentication using the Cyrus &'saslauthd'&
12109 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12110 Using this daemon is one way of making it possible for passwords to be checked
12111 by a process that is not running as root.
12112
12113 The saslauthd support is not included in Exim by default. You need to specify
12114 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12115 building Exim. For example:
12116 .code
12117 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12118 .endd
12119 You do not need to install the full Cyrus software suite in order to use
12120 the saslauthd daemon. You can compile and install just the daemon alone
12121 from the Cyrus SASL library.
12122
12123 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12124 two are mandatory. For example:
12125 .code
12126 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12127 .endd
12128 The service and the realm are optional (which is why the arguments are enclosed
12129 in their own set of braces). For details of the meaning of the service and
12130 realm, and how to run the daemon, consult the Cyrus documentation.
12131 .endlist vlist
12132
12133
12134
12135 .section "Combining expansion conditions" "SECID84"
12136 .cindex "expansion" "combining conditions"
12137 Several conditions can be tested at once by combining them using the &%and%&
12138 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12139 conditions on their own, and precede their lists of sub-conditions. Each
12140 sub-condition must be enclosed in braces within the overall braces that contain
12141 the list. No repetition of &%if%& is used.
12142
12143
12144 .vlist
12145 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12146 .cindex "&""or""& expansion condition"
12147 .cindex "expansion" "&""or""& of conditions"
12148 The sub-conditions are evaluated from left to right. The condition is true if
12149 any one of the sub-conditions is true.
12150 For example,
12151 .code
12152 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12153 .endd
12154 When a true sub-condition is found, the following ones are parsed but not
12155 evaluated. If there are several &"match"& sub-conditions the values of the
12156 numeric variables afterwards are taken from the first one that succeeds.
12157
12158 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12159 .cindex "&""and""& expansion condition"
12160 .cindex "expansion" "&""and""& of conditions"
12161 The sub-conditions are evaluated from left to right. The condition is true if
12162 all of the sub-conditions are true. If there are several &"match"&
12163 sub-conditions, the values of the numeric variables afterwards are taken from
12164 the last one. When a false sub-condition is found, the following ones are
12165 parsed but not evaluated.
12166 .endlist
12167 .ecindex IIDexpcond
12168
12169
12170
12171
12172 .section "Expansion variables" "SECTexpvar"
12173 .cindex "expansion" "variables, list of"
12174 This section contains an alphabetical list of all the expansion variables. Some
12175 of them are available only when Exim is compiled with specific options such as
12176 support for TLS or the content scanning extension.
12177 .cindex "tainted data"
12178 Variables marked as &'tainted'& are likely to carry data supplied by
12179 a potential attacker.
12180 Variables without such marking may also, depending on how their
12181 values are created.
12182 Such variables should not be further expanded,
12183 used as filenames
12184 or used as command-line arguments for external commands.
12185
12186 .vlist
12187 .vitem "&$0$&, &$1$&, etc"
12188 .cindex "numerical variables (&$1$& &$2$& etc)"
12189 When a &%match%& expansion condition succeeds, these variables contain the
12190 captured substrings identified by the regular expression during subsequent
12191 processing of the success string of the containing &%if%& expansion item.
12192 In the expansion condition case
12193 they do not retain their values afterwards; in fact, their previous
12194 values are restored at the end of processing an &%if%& item. The numerical
12195 variables may also be set externally by some other matching process which
12196 precedes the expansion of the string. For example, the commands available in
12197 Exim filter files include an &%if%& command with its own regular expression
12198 matching condition.
12199 If the subject string was tainted then any captured substring will also be.
12200
12201 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12202 Within an acl condition, expansion condition or expansion item
12203 any arguments are copied to these variables,
12204 any unused variables being made empty.
12205
12206 .vitem "&$acl_c...$&"
12207 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12208 can be given any name that starts with &$acl_c$& and is at least six characters
12209 long, but the sixth character must be either a digit or an underscore. For
12210 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12211 variables persist throughout the lifetime of an SMTP connection. They can be
12212 used to pass information between ACLs and between different invocations of the
12213 same ACL. When a message is received, the values of these variables are saved
12214 with the message, and can be accessed by filters, routers, and transports
12215 during subsequent delivery.
12216
12217 .vitem "&$acl_m...$&"
12218 These variables are like the &$acl_c...$& variables, except that their values
12219 are reset after a message has been received. Thus, if several messages are
12220 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12221 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12222 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12223 message is received, the values of these variables are saved with the message,
12224 and can be accessed by filters, routers, and transports during subsequent
12225 delivery.
12226
12227 .vitem &$acl_narg$&
12228 Within an acl condition, expansion condition or expansion item
12229 this variable has the number of arguments.
12230
12231 .vitem &$acl_verify_message$&
12232 .vindex "&$acl_verify_message$&"
12233 After an address verification has failed, this variable contains the failure
12234 message. It retains its value for use in subsequent modifiers of the verb.
12235 The message can be preserved by coding like this:
12236 .code
12237 warn !verify = sender
12238      set acl_m0 = $acl_verify_message
12239 .endd
12240 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12241 &%log_message%& modifiers, to include information about the verification
12242 failure.
12243 &*Note*&: The variable is cleared at the end of processing the ACL verb.
12244
12245 .vitem &$address_data$&
12246 .vindex "&$address_data$&"
12247 This variable is set by means of the &%address_data%& option in routers. The
12248 value then remains with the address while it is processed by subsequent routers
12249 and eventually a transport. If the transport is handling multiple addresses,
12250 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12251 for more details. &*Note*&: The contents of &$address_data$& are visible in
12252 user filter files.
12253
12254 If &$address_data$& is set when the routers are called from an ACL to verify
12255 a recipient address, the final value is still in the variable for subsequent
12256 conditions and modifiers of the ACL statement. If routing the address caused it
12257 to be redirected to just one address, the child address is also routed as part
12258 of the verification, and in this case the final value of &$address_data$& is
12259 from the child's routing.
12260
12261 If &$address_data$& is set when the routers are called from an ACL to verify a
12262 sender address, the final value is also preserved, but this time in
12263 &$sender_address_data$&, to distinguish it from data from a recipient
12264 address.
12265
12266 In both cases (recipient and sender verification), the value does not persist
12267 after the end of the current ACL statement. If you want to preserve
12268 these values for longer, you can save them in ACL variables.
12269
12270 .vitem &$address_file$&
12271 .vindex "&$address_file$&"
12272 When, as a result of aliasing, forwarding, or filtering, a message is directed
12273 to a specific file, this variable holds the name of the file when the transport
12274 is running. At other times, the variable is empty. For example, using the
12275 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12276 .code
12277 /home/r2d2/savemail
12278 .endd
12279 then when the &(address_file)& transport is running, &$address_file$&
12280 contains the text string &`/home/r2d2/savemail`&.
12281 .cindex "Sieve filter" "value of &$address_file$&"
12282 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12283 then up to the transport configuration to generate an appropriate absolute path
12284 to the relevant file.
12285
12286 .vitem &$address_pipe$&
12287 .vindex "&$address_pipe$&"
12288 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12289 this variable holds the pipe command when the transport is running.
12290
12291 .vitem "&$auth1$& &-- &$auth4$&"
12292 .vindex "&$auth1$&, &$auth2$&, etc"
12293 These variables are used in SMTP authenticators (see chapters
12294 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12295
12296 .vitem &$authenticated_id$&
12297 .cindex "authentication" "id"
12298 .vindex "&$authenticated_id$&"
12299 When a server successfully authenticates a client it may be configured to
12300 preserve some of the authentication information in the variable
12301 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12302 user/password authenticator configuration might preserve the user name for use
12303 in the routers. Note that this is not the same information that is saved in
12304 &$sender_host_authenticated$&.
12305
12306 When a message is submitted locally (that is, not over a TCP connection)
12307 the value of &$authenticated_id$& is normally the login name of the calling
12308 process. However, a trusted user can override this by means of the &%-oMai%&
12309 command line option.
12310 This second case also sets up information used by the
12311 &$authresults$& expansion item.
12312
12313 .vitem &$authenticated_fail_id$&
12314 .cindex "authentication" "fail" "id"
12315 .vindex "&$authenticated_fail_id$&"
12316 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12317 will contain the failed authentication id. If more than one authentication
12318 id is attempted, it will contain only the last one. The variable is
12319 available for processing in the ACL's, generally the quit or notquit ACL.
12320 A message to a local recipient could still be accepted without requiring
12321 authentication, which means this variable could also be visible in all of
12322 the ACL's as well.
12323
12324
12325 .tvar &$authenticated_sender$&
12326 .cindex "sender" "authenticated"
12327 .cindex "authentication" "sender"
12328 .cindex "AUTH" "on MAIL command"
12329 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12330 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12331 described in section &<<SECTauthparamail>>&. Unless the data is the string
12332 &"<>"&, it is set as the authenticated sender of the message, and the value is
12333 available during delivery in the &$authenticated_sender$& variable. If the
12334 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12335
12336 .vindex "&$qualify_domain$&"
12337 When a message is submitted locally (that is, not over a TCP connection), the
12338 value of &$authenticated_sender$& is an address constructed from the login
12339 name of the calling process and &$qualify_domain$&, except that a trusted user
12340 can override this by means of the &%-oMas%& command line option.
12341
12342
12343 .vitem &$authentication_failed$&
12344 .cindex "authentication" "failure"
12345 .vindex "&$authentication_failed$&"
12346 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12347 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12348 possible to distinguish between &"did not try to authenticate"&
12349 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12350 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12351 is empty and &$authentication_failed$& is set to &"1"&).
12352 Failure includes cancellation of a authentication attempt,
12353 and any negative response to an AUTH command,
12354 (including, for example, an attempt to use an undefined mechanism).
12355
12356 .vitem &$av_failed$&
12357 .cindex "content scanning" "AV scanner failure"
12358 This variable is available when Exim is compiled with the content-scanning
12359 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12360 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12361 the ACL malware condition.
12362
12363 .vitem &$body_linecount$&
12364 .cindex "message body" "line count"
12365 .cindex "body of message" "line count"
12366 .vindex "&$body_linecount$&"
12367 When a message is being received or delivered, this variable contains the
12368 number of lines in the message's body. See also &$message_linecount$&.
12369
12370 .vitem &$body_zerocount$&
12371 .cindex "message body" "binary zero count"
12372 .cindex "body of message" "binary zero count"
12373 .cindex "binary zero" "in message body"
12374 .vindex "&$body_zerocount$&"
12375 When a message is being received or delivered, this variable contains the
12376 number of binary zero bytes (ASCII NULs) in the message's body.
12377
12378 .vitem &$bounce_recipient$&
12379 .vindex "&$bounce_recipient$&"
12380 This is set to the recipient address of a bounce message while Exim is creating
12381 it. It is useful if a customized bounce message text file is in use (see
12382 chapter &<<CHAPemsgcust>>&).
12383
12384 .vitem &$bounce_return_size_limit$&
12385 .vindex "&$bounce_return_size_limit$&"
12386 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12387 up to a multiple of 1000. It is useful when a customized error message text
12388 file is in use (see chapter &<<CHAPemsgcust>>&).
12389
12390 .vitem &$caller_gid$&
12391 .cindex "gid (group id)" "caller"
12392 .vindex "&$caller_gid$&"
12393 The real group id under which the process that called Exim was running. This is
12394 not the same as the group id of the originator of a message (see
12395 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12396 incarnation normally contains the Exim gid.
12397
12398 .vitem &$caller_uid$&
12399 .cindex "uid (user id)" "caller"
12400 .vindex "&$caller_uid$&"
12401 The real user id under which the process that called Exim was running. This is
12402 not the same as the user id of the originator of a message (see
12403 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12404 incarnation normally contains the Exim uid.
12405
12406 .vitem &$callout_address$&
12407 .vindex "&$callout_address$&"
12408 After a callout for verification, spamd or malware daemon service, the
12409 address that was connected to.
12410
12411 .vitem &$compile_number$&
12412 .vindex "&$compile_number$&"
12413 The building process for Exim keeps a count of the number
12414 of times it has been compiled. This serves to distinguish different
12415 compilations of the same version of Exim.
12416
12417 .vitem &$config_dir$&
12418 .vindex "&$config_dir$&"
12419 The directory name of the main configuration file. That is, the content of
12420 &$config_file$& with the last component stripped. The value does not
12421 contain the trailing slash. If &$config_file$& does not contain a slash,
12422 &$config_dir$& is ".".
12423
12424 .vitem &$config_file$&
12425 .vindex "&$config_file$&"
12426 The name of the main configuration file Exim is using.
12427
12428 .vitem &$dkim_verify_status$&
12429 Results of DKIM verification.
12430 For details see section &<<SECDKIMVFY>>&.
12431
12432 .vitem &$dkim_cur_signer$& &&&
12433        &$dkim_verify_reason$& &&&
12434        &$dkim_domain$& &&&
12435        &$dkim_identity$& &&&
12436        &$dkim_selector$& &&&
12437        &$dkim_algo$& &&&
12438        &$dkim_canon_body$& &&&
12439        &$dkim_canon_headers$& &&&
12440        &$dkim_copiedheaders$& &&&
12441        &$dkim_bodylength$& &&&
12442        &$dkim_created$& &&&
12443        &$dkim_expires$& &&&
12444        &$dkim_headernames$& &&&
12445        &$dkim_key_testing$& &&&
12446        &$dkim_key_nosubdomains$& &&&
12447        &$dkim_key_srvtype$& &&&
12448        &$dkim_key_granularity$& &&&
12449        &$dkim_key_notes$& &&&
12450        &$dkim_key_length$&
12451 These variables are only available within the DKIM ACL.
12452 For details see section &<<SECDKIMVFY>>&.
12453
12454 .vitem &$dkim_signers$&
12455 .vindex &$dkim_signers$&
12456 When a message has been received this variable contains
12457 a colon-separated list of signer domains and identities for the message.
12458 For details see section &<<SECDKIMVFY>>&.
12459
12460 .vitem &$dmarc_domain_policy$& &&&
12461        &$dmarc_status$& &&&
12462        &$dmarc_status_text$& &&&
12463        &$dmarc_used_domains$&
12464 Results of DMARC verification.
12465 For details see section &<<SECDMARC>>&.
12466
12467 .vitem &$dnslist_domain$& &&&
12468        &$dnslist_matched$& &&&
12469        &$dnslist_text$& &&&
12470        &$dnslist_value$&
12471 .vindex "&$dnslist_domain$&"
12472 .vindex "&$dnslist_matched$&"
12473 .vindex "&$dnslist_text$&"
12474 .vindex "&$dnslist_value$&"
12475 .cindex "black list (DNS)"
12476 When a DNS (black) list lookup succeeds, these variables are set to contain
12477 the following data from the lookup: the list's domain name, the key that was
12478 looked up, the contents of any associated TXT record, and the value from the
12479 main A record. See section &<<SECID204>>& for more details.
12480
12481 .tvar &$domain$&
12482 When an address is being routed, or delivered on its own, this variable
12483 contains the domain. Uppercase letters in the domain are converted into lower
12484 case for &$domain$&.
12485
12486 Global address rewriting happens when a message is received, so the value of
12487 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12488 is set during user filtering, but not during system filtering, because a
12489 message may have many recipients and the system filter is called just once.
12490
12491 When more than one address is being delivered at once (for example, several
12492 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12493 have the same domain. Transports can be restricted to handling only one domain
12494 at a time if the value of &$domain$& is required at transport time &-- this is
12495 the default for local transports. For further details of the environment in
12496 which local transports are run, see chapter &<<CHAPenvironment>>&.
12497
12498 .oindex "&%delay_warning_condition%&"
12499 At the end of a delivery, if all deferred addresses have the same domain, it is
12500 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12501
12502 The &$domain$& variable is also used in some other circumstances:
12503
12504 .ilist
12505 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12506 the recipient address. The domain of the &'sender'& address is in
12507 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12508 normally set during the running of the MAIL ACL. However, if the sender address
12509 is verified with a callout during the MAIL ACL, the sender domain is placed in
12510 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12511 the &(smtp)& transport.
12512
12513 .next
12514 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12515 &$domain$& contains the domain portion of the address that is being rewritten;
12516 it can be used in the expansion of the replacement address, for example, to
12517 rewrite domains by file lookup.
12518
12519 .next
12520 With one important exception, whenever a domain list is being scanned,
12521 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12522 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12523 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12524 that, in a RCPT ACL, the sender domain list can be dependent on the
12525 recipient domain (which is what is in &$domain$& at this time).
12526
12527 .next
12528 .cindex "ETRN" "value of &$domain$&"
12529 .oindex "&%smtp_etrn_command%&"
12530 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12531 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12532 .endlist
12533
12534 .cindex "tainted data"
12535 If the origin of the data is an incoming message,
12536 the result of expanding this variable is tainted and may not
12537 be further expanded or used as a filename.
12538 When an untainted version is needed, one should be obtained from
12539 looking up the value in a local (therefore trusted) database.
12540 Often &$domain_data$& is usable in this role.
12541
12542
12543 .vitem &$domain_data$&
12544 .vindex "&$domain_data$&"
12545 When the &%domains%& condition on a router
12546 or an ACL
12547 matches a domain
12548 against a list, the match value is copied to &$domain_data$&.
12549 This is an enhancement over previous versions of Exim, when it only
12550 applied to the data read by a lookup.
12551 For details on match values see section &<<SECTlistresults>>& et. al.
12552
12553 If the router routes the
12554 address to a transport, the value is available in that transport. If the
12555 transport is handling multiple addresses, the value from the first address is
12556 used.
12557
12558 &$domain_data$& set in an ACL is available during
12559 the rest of the ACL statement.
12560
12561 .vitem &$exim_gid$&
12562 .vindex "&$exim_gid$&"
12563 This variable contains the numerical value of the Exim group id.
12564
12565 .vitem &$exim_path$&
12566 .vindex "&$exim_path$&"
12567 This variable contains the path to the Exim binary.
12568
12569 .vitem &$exim_uid$&
12570 .vindex "&$exim_uid$&"
12571 This variable contains the numerical value of the Exim user id.
12572
12573 .vitem &$exim_version$&
12574 .vindex "&$exim_version$&"
12575 This variable contains the version string of the Exim build.
12576 The first character is a major version number, currently 4.
12577 Then after a dot, the next group of digits is a minor version number.
12578 There may be other characters following the minor version.
12579 This value may be overridden by the &%exim_version%& main config option.
12580
12581 .vitem &$header_$&<&'name'&>
12582 .tmark
12583 This is not strictly an expansion variable. It is expansion syntax for
12584 inserting the message header line with the given name. Note that the name must
12585 be terminated by colon or white space, because it may contain a wide variety of
12586 characters. Note also that braces must &'not'& be used.
12587 See the full description in section &<<SECTexpansionitems>>& above.
12588
12589 .vitem &$headers_added$&
12590 .vindex "&$headers_added$&"
12591 Within an ACL this variable contains the headers added so far by
12592 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12593 The headers are a newline-separated list.
12594
12595 .vitem &$home$&
12596 .vindex "&$home$&"
12597 When the &%check_local_user%& option is set for a router, the user's home
12598 directory is placed in &$home$& when the check succeeds. In particular, this
12599 means it is set during the running of users' filter files. A router may also
12600 explicitly set a home directory for use by a transport; this can be overridden
12601 by a setting on the transport itself.
12602
12603 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12604 of the environment variable HOME, which is subject to the
12605 &%keep_environment%& and &%add_environment%& main config options.
12606
12607 .vitem &$host$&
12608 .vindex "&$host$&"
12609 If a router assigns an address to a transport (any transport), and passes a
12610 list of hosts with the address, the value of &$host$& when the transport starts
12611 to run is the name of the first host on the list. Note that this applies both
12612 to local and remote transports.
12613
12614 .cindex "transport" "filter"
12615 .cindex "filter" "transport filter"
12616 For the &(smtp)& transport, if there is more than one host, the value of
12617 &$host$& changes as the transport works its way through the list. In
12618 particular, when the &(smtp)& transport is expanding its options for encryption
12619 using TLS, or for specifying a transport filter (see chapter
12620 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12621 is connected.
12622
12623 When used in the client part of an authenticator configuration (see chapter
12624 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12625 client is connected.
12626
12627
12628 .vitem &$host_address$&
12629 .vindex "&$host_address$&"
12630 This variable is set to the remote host's IP address whenever &$host$& is set
12631 for a remote connection. It is also set to the IP address that is being checked
12632 when the &%ignore_target_hosts%& option is being processed.
12633
12634 .vitem &$host_data$&
12635 .vindex "&$host_data$&"
12636 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12637 result of the lookup is made available in the &$host_data$& variable. This
12638 allows you, for example, to do things like this:
12639 .code
12640 deny  hosts = net-lsearch;/some/file
12641       message = $host_data
12642 .endd
12643
12644 .vitem &$host_lookup_deferred$&
12645 .cindex "host name" "lookup, failure of"
12646 .vindex "&$host_lookup_deferred$&"
12647 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12648 message comes from a remote host and there is an attempt to look up the host's
12649 name from its IP address, and the attempt is not successful, one of these
12650 variables is set to &"1"&.
12651
12652 .ilist
12653 If the lookup receives a definite negative response (for example, a DNS lookup
12654 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12655
12656 .next
12657 If there is any kind of problem during the lookup, such that Exim cannot
12658 tell whether or not the host name is defined (for example, a timeout for a DNS
12659 lookup), &$host_lookup_deferred$& is set to &"1"&.
12660 .endlist ilist
12661
12662 Looking up a host's name from its IP address consists of more than just a
12663 single reverse lookup. Exim checks that a forward lookup of at least one of the
12664 names it receives from a reverse lookup yields the original IP address. If this
12665 is not the case, Exim does not accept the looked up name(s), and
12666 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12667 IP address (for example, the existence of a PTR record in the DNS) is not
12668 sufficient on its own for the success of a host name lookup. If the reverse
12669 lookup succeeds, but there is a lookup problem such as a timeout when checking
12670 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12671 &"1"&. See also &$sender_host_name$&.
12672
12673 .cindex authentication "expansion item"
12674 Performing these checks sets up information used by the
12675 &%authresults%& expansion item.
12676
12677
12678 .vitem &$host_lookup_failed$&
12679 .vindex "&$host_lookup_failed$&"
12680 See &$host_lookup_deferred$&.
12681
12682 .vitem &$host_port$&
12683 .vindex "&$host_port$&"
12684 This variable is set to the remote host's TCP port whenever &$host$& is set
12685 for an outbound connection.
12686
12687 .vitem &$initial_cwd$&
12688 .vindex "&$initial_cwd$&
12689 This variable contains the full path name of the initial working
12690 directory of the current Exim process. This may differ from the current
12691 working directory, as Exim changes this to "/" during early startup, and
12692 to &$spool_directory$& later.
12693
12694 .vitem &$inode$&
12695 .vindex "&$inode$&"
12696 The only time this variable is set is while expanding the &%directory_file%&
12697 option in the &(appendfile)& transport. The variable contains the inode number
12698 of the temporary file which is about to be renamed. It can be used to construct
12699 a unique name for the file.
12700
12701 .vitem &$interface_address$& &&&
12702        &$interface_port$&
12703 .vindex "&$interface_address$&"
12704 .vindex "&$interface_port$&"
12705 These are obsolete names for &$received_ip_address$& and &$received_port$&.
12706
12707 .vitem &$item$&
12708 .vindex "&$item$&"
12709 This variable is used during the expansion of &*forall*& and &*forany*&
12710 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12711 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12712 empty.
12713
12714 .vitem &$ldap_dn$&
12715 .vindex "&$ldap_dn$&"
12716 This variable, which is available only when Exim is compiled with LDAP support,
12717 contains the DN from the last entry in the most recently successful LDAP
12718 lookup.
12719
12720 .vitem &$load_average$&
12721 .vindex "&$load_average$&"
12722 This variable contains the system load average, multiplied by 1000 so that it
12723 is an integer. For example, if the load average is 0.21, the value of the
12724 variable is 210. The value is recomputed every time the variable is referenced.
12725
12726 .tvar &$local_part$&
12727 When an address is being routed, or delivered on its own, this
12728 variable contains the local part. When a number of addresses are being
12729 delivered together (for example, multiple RCPT commands in an SMTP
12730 session), &$local_part$& is not set.
12731
12732 Global address rewriting happens when a message is received, so the value of
12733 &$local_part$& during routing and delivery is the value after rewriting.
12734 &$local_part$& is set during user filtering, but not during system filtering,
12735 because a message may have many recipients and the system filter is called just
12736 once.
12737
12738 .cindex "tainted data"
12739 If the origin of the data is an incoming message,
12740 the result of expanding this variable is tainted and
12741 may not be further expanded or used as a filename.
12742
12743 &*Warning*&: the content of this variable is usually provided by a potential
12744 attacker.
12745 Consider carefully the implications of using it unvalidated as a name
12746 for file access.
12747 This presents issues for users' &_.forward_& and filter files.
12748 For traditional full user accounts, use &%check_local_users%& and the
12749 &$local_part_data$& variable rather than this one.
12750 For virtual users, store a suitable pathname component in the database
12751 which is used for account name validation, and use that retrieved value
12752 rather than this variable.
12753 Often &$local_part_data$& is usable in this role.
12754 If needed, use a router &%address_data%& or &%set%& option for
12755 the retrieved data.
12756
12757 When a message is being delivered to a file, pipe, or autoreply transport as a
12758 result of aliasing or forwarding, &$local_part$& is set to the local part of
12759 the parent address, not to the filename or command (see &$address_file$& and
12760 &$address_pipe$&).
12761
12762 When an ACL is running for a RCPT command, &$local_part$& contains the
12763 local part of the recipient address.
12764
12765 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12766 &$local_part$& contains the local part of the address that is being rewritten;
12767 it can be used in the expansion of the replacement address, for example.
12768
12769 In all cases, all quoting is removed from the local part. For example, for both
12770 the addresses
12771 .code
12772 "abc:xyz"@test.example
12773 abc\:xyz@test.example
12774 .endd
12775 the value of &$local_part$& is
12776 .code
12777 abc:xyz
12778 .endd
12779 If you use &$local_part$& to create another address, you should always wrap it
12780 inside a quoting operator. For example, in a &(redirect)& router you could
12781 have:
12782 .code
12783 data = ${quote_local_part:$local_part}@new.domain.example
12784 .endd
12785 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12786 to process local parts in a case-dependent manner in a router, you can set the
12787 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12788
12789 .vitem &$local_part_data$&
12790 .vindex "&$local_part_data$&"
12791 When the &%local_parts%& condition on a router or ACL
12792 matches a local part list
12793 the match value is copied to &$local_part_data$&.
12794 This is an enhancement over previous versions of Exim, when it only
12795 applied to the data read by a lookup.
12796 For details on match values see section &<<SECTlistresults>>& et. al.
12797
12798 The &%check_local_user%& router option also sets this variable.
12799
12800 .vindex &$local_part_prefix$& &&&
12801         &$local_part_prefix_v$& &&&
12802         &$local_part_suffix$& &&&
12803         &$local_part_suffix_v$&
12804 .cindex affix variables
12805 If a local part prefix or suffix has been recognized, it is not included in the
12806 value of &$local_part$& during routing and subsequent delivery. The values of
12807 any prefix or suffix are in &$local_part_prefix$& and
12808 &$local_part_suffix$&, respectively.
12809 .cindex "tainted data"
12810 If the specification did not include a wildcard then
12811 the affix variable value is not tainted.
12812
12813 If the affix specification included a wildcard then the portion of
12814 the affix matched by the wildcard is in
12815 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12816 and both the whole and varying values are tainted.
12817
12818 .vitem &$local_scan_data$&
12819 .vindex "&$local_scan_data$&"
12820 This variable contains the text returned by the &[local_scan()]& function when
12821 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12822
12823 .vitem &$local_user_gid$&
12824 .vindex "&$local_user_gid$&"
12825 See &$local_user_uid$&.
12826
12827 .vitem &$local_user_uid$&
12828 .vindex "&$local_user_uid$&"
12829 This variable and &$local_user_gid$& are set to the uid and gid after the
12830 &%check_local_user%& router precondition succeeds. This means that their values
12831 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12832 and &%condition%&), for the &%address_data%& expansion, and for any
12833 router-specific expansions. At all other times, the values in these variables
12834 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12835
12836 .vitem &$localhost_number$&
12837 .vindex "&$localhost_number$&"
12838 This contains the expanded value of the
12839 &%localhost_number%& option. The expansion happens after the main options have
12840 been read.
12841
12842 .vitem &$log_inodes$&
12843 .vindex "&$log_inodes$&"
12844 The number of free inodes in the disk partition where Exim's
12845 log files are being written. The value is recalculated whenever the variable is
12846 referenced. If the relevant file system does not have the concept of inodes,
12847 the value of is -1. See also the &%check_log_inodes%& option.
12848
12849 .vitem &$log_space$&
12850 .vindex "&$log_space$&"
12851 The amount of free space (as a number of kilobytes) in the disk
12852 partition where Exim's log files are being written. The value is recalculated
12853 whenever the variable is referenced. If the operating system does not have the
12854 ability to find the amount of free space (only true for experimental systems),
12855 the space value is -1. See also the &%check_log_space%& option.
12856
12857
12858 .vitem &$lookup_dnssec_authenticated$&
12859 .vindex "&$lookup_dnssec_authenticated$&"
12860 This variable is set after a DNS lookup done by
12861 a dnsdb lookup expansion, dnslookup router or smtp transport.
12862 .cindex "DNS" "DNSSEC"
12863 It will be empty if &(DNSSEC)& was not requested,
12864 &"no"& if the result was not labelled as authenticated data
12865 and &"yes"& if it was.
12866 Results that are labelled as authoritative answer that match
12867 the &%dns_trust_aa%& configuration variable count also
12868 as authenticated data.
12869
12870 .vitem &$mailstore_basename$&
12871 .vindex "&$mailstore_basename$&"
12872 This variable is set only when doing deliveries in &"mailstore"& format in the
12873 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12874 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12875 contains the basename of the files that are being written, that is, the name
12876 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12877 variable is empty.
12878
12879 .vitem &$malware_name$&
12880 .vindex "&$malware_name$&"
12881 This variable is available when Exim is compiled with the
12882 content-scanning extension. It is set to the name of the virus that was found
12883 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12884
12885 .vitem &$max_received_linelength$&
12886 .vindex "&$max_received_linelength$&"
12887 .cindex "maximum" "line length"
12888 .cindex "line length" "maximum"
12889 This variable contains the number of bytes in the longest line that was
12890 received as part of the message, not counting the line termination
12891 character(s).
12892 It is not valid if the &%spool_wireformat%& option is used.
12893
12894 .vitem &$message_age$&
12895 .cindex "message" "age of"
12896 .vindex "&$message_age$&"
12897 This variable is set at the start of a delivery attempt to contain the number
12898 of seconds since the message was received. It does not change during a single
12899 delivery attempt.
12900
12901 .tvar &$message_body$&
12902 .cindex "body of message" "expansion variable"
12903 .cindex "message body" "in expansion"
12904 .cindex "binary zero" "in message body"
12905 .oindex "&%message_body_visible%&"
12906 This variable contains the initial portion of a message's body while it is
12907 being delivered, and is intended mainly for use in filter files. The maximum
12908 number of characters of the body that are put into the variable is set by the
12909 &%message_body_visible%& configuration option; the default is 500.
12910
12911 .oindex "&%message_body_newlines%&"
12912 By default, newlines are converted into spaces in &$message_body$&, to make it
12913 easier to search for phrases that might be split over a line break. However,
12914 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12915 zeros are always converted into spaces.
12916
12917 .tvar &$message_body_end$&
12918 .cindex "body of message" "expansion variable"
12919 .cindex "message body" "in expansion"
12920 This variable contains the final portion of a message's
12921 body while it is being delivered. The format and maximum size are as for
12922 &$message_body$&.
12923
12924 .vitem &$message_body_size$&
12925 .cindex "body of message" "size"
12926 .cindex "message body" "size"
12927 .vindex "&$message_body_size$&"
12928 When a message is being delivered, this variable contains the size of the body
12929 in bytes. The count starts from the character after the blank line that
12930 separates the body from the header. Newlines are included in the count. See
12931 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12932
12933 If the spool file is wireformat
12934 (see the &%spool_wireformat%& main option)
12935 the CRLF line-terminators are included in the count.
12936
12937 .vitem &$message_exim_id$&
12938 .vindex "&$message_exim_id$&"
12939 When a message is being received or delivered, this variable contains the
12940 unique message id that is generated and used by Exim to identify the message.
12941 An id is not created for a message until after its header has been successfully
12942 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12943 line; it is the local id that Exim assigns to the message, for example:
12944 &`1BXTIK-0001yO-VA`&.
12945
12946 .tvar &$message_headers$&
12947 This variable contains a concatenation of all the header lines when a message
12948 is being processed, except for lines added by routers or transports. The header
12949 lines are separated by newline characters. Their contents are decoded in the
12950 same way as a header line that is inserted by &%bheader%&.
12951
12952 .tvar &$message_headers_raw$&
12953 This variable is like &$message_headers$& except that no processing of the
12954 contents of header lines is done.
12955
12956 .vitem &$message_id$&
12957 This is an old name for &$message_exim_id$&. It is now deprecated.
12958
12959 .vitem &$message_linecount$&
12960 .vindex "&$message_linecount$&"
12961 This variable contains the total number of lines in the header and body of the
12962 message. Compare &$body_linecount$&, which is the count for the body only.
12963 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12964 number of lines received. Before delivery happens (that is, before filters,
12965 routers, and transports run) the count is increased to include the
12966 &'Received:'& header line that Exim standardly adds, and also any other header
12967 lines that are added by ACLs. The blank line that separates the message header
12968 from the body is not counted.
12969
12970 As with the special case of &$message_size$&, during the expansion of the
12971 appendfile transport's maildir_tag option in maildir format, the value of
12972 &$message_linecount$& is the precise size of the number of newlines in the
12973 file that has been written (minus one for the blank line between the
12974 header and the body).
12975
12976 Here is an example of the use of this variable in a DATA ACL:
12977 .code
12978 deny condition = \
12979       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12980      message   = Too many lines in message header
12981 .endd
12982 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12983 message has not yet been received.
12984
12985 This variable is not valid if the &%spool_wireformat%& option is used.
12986
12987 .vitem &$message_size$&
12988 .cindex "size" "of message"
12989 .cindex "message" "size"
12990 .vindex "&$message_size$&"
12991 When a message is being processed, this variable contains its size in bytes. In
12992 most cases, the size includes those headers that were received with the
12993 message, but not those (such as &'Envelope-to:'&) that are added to individual
12994 deliveries as they are written. However, there is one special case: during the
12995 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12996 doing a delivery in maildir format, the value of &$message_size$& is the
12997 precise size of the file that has been written. See also
12998 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12999
13000 .cindex "RCPT" "value of &$message_size$&"
13001 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13002 contains the size supplied on the MAIL command, or -1 if no size was given. The
13003 value may not, of course, be truthful.
13004
13005 .vitem &$mime_anomaly_level$& &&&
13006        &$mime_anomaly_text$& &&&
13007        &$mime_boundary$& &&&
13008        &$mime_charset$& &&&
13009        &$mime_content_description$& &&&
13010        &$mime_content_disposition$& &&&
13011        &$mime_content_id$& &&&
13012        &$mime_content_size$& &&&
13013        &$mime_content_transfer_encoding$& &&&
13014        &$mime_content_type$& &&&
13015        &$mime_decoded_filename$& &&&
13016        &$mime_filename$& &&&
13017        &$mime_is_coverletter$& &&&
13018        &$mime_is_multipart$& &&&
13019        &$mime_is_rfc822$& &&&
13020        &$mime_part_count$&
13021 A number of variables whose names start with &$mime$& are
13022 available when Exim is compiled with the content-scanning extension. For
13023 details, see section &<<SECTscanmimepart>>&.
13024
13025 .vitem "&$n0$& &-- &$n9$&"
13026 These variables are counters that can be incremented by means
13027 of the &%add%& command in filter files.
13028
13029 .tvar &$original_domain$&
13030 .vindex "&$domain$&"
13031 When a top-level address is being processed for delivery, this contains the
13032 same value as &$domain$&. However, if a &"child"& address (for example,
13033 generated by an alias, forward, or filter file) is being processed, this
13034 variable contains the domain of the original address (lower cased). This
13035 differs from &$parent_domain$& only when there is more than one level of
13036 aliasing or forwarding. When more than one address is being delivered in a
13037 single transport run, &$original_domain$& is not set.
13038
13039 If a new address is created by means of a &%deliver%& command in a system
13040 filter, it is set up with an artificial &"parent"& address. This has the local
13041 part &'system-filter'& and the default qualify domain.
13042
13043 .tvar &$original_local_part$&
13044 .vindex "&$local_part$&"
13045 When a top-level address is being processed for delivery, this contains the
13046 same value as &$local_part$&, unless a prefix or suffix was removed from the
13047 local part, because &$original_local_part$& always contains the full local
13048 part. When a &"child"& address (for example, generated by an alias, forward, or
13049 filter file) is being processed, this variable contains the full local part of
13050 the original address.
13051
13052 If the router that did the redirection processed the local part
13053 case-insensitively, the value in &$original_local_part$& is in lower case.
13054 This variable differs from &$parent_local_part$& only when there is more than
13055 one level of aliasing or forwarding. When more than one address is being
13056 delivered in a single transport run, &$original_local_part$& is not set.
13057
13058 If a new address is created by means of a &%deliver%& command in a system
13059 filter, it is set up with an artificial &"parent"& address. This has the local
13060 part &'system-filter'& and the default qualify domain.
13061
13062 .vitem &$originator_gid$&
13063 .cindex "gid (group id)" "of originating user"
13064 .cindex "sender" "gid"
13065 .vindex "&$caller_gid$&"
13066 .vindex "&$originator_gid$&"
13067 This variable contains the value of &$caller_gid$& that was set when the
13068 message was received. For messages received via the command line, this is the
13069 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13070 normally the gid of the Exim user.
13071
13072 .vitem &$originator_uid$&
13073 .cindex "uid (user id)" "of originating user"
13074 .cindex "sender" "uid"
13075 .vindex "&$caller_uid$&"
13076 .vindex "&$originator_uid$&"
13077 The value of &$caller_uid$& that was set when the message was received. For
13078 messages received via the command line, this is the uid of the sending user.
13079 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13080 user.
13081
13082 .tvar &$parent_domain$&
13083 This variable is similar to &$original_domain$& (see
13084 above), except that it refers to the immediately preceding parent address.
13085
13086 .tvar &$parent_local_part$&
13087 This variable is similar to &$original_local_part$&
13088 (see above), except that it refers to the immediately preceding parent address.
13089
13090 .vitem &$pid$&
13091 .cindex "pid (process id)" "of current process"
13092 .vindex "&$pid$&"
13093 This variable contains the current process id.
13094
13095 .vitem &$pipe_addresses$&
13096 .cindex "filter" "transport filter"
13097 .cindex "transport" "filter"
13098 .vindex "&$pipe_addresses$&"
13099 This is not an expansion variable, but is mentioned here because the string
13100 &`$pipe_addresses`& is handled specially in the command specification for the
13101 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13102 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13103 It cannot be used in general expansion strings, and provokes an &"unknown
13104 variable"& error if encountered.
13105 &*Note*&: This value permits data supplied by a potential attacker to
13106 be used in the command for a &(pipe)& transport.
13107 Such configurations should be carefully assessed for security vulnerbilities.
13108
13109 .vitem &$primary_hostname$&
13110 .vindex "&$primary_hostname$&"
13111 This variable contains the value set by &%primary_hostname%& in the
13112 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13113 a single-component name, Exim calls &[gethostbyname()]& (or
13114 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13115 qualified host name. See also &$smtp_active_hostname$&.
13116
13117
13118 .vitem &$proxy_external_address$& &&&
13119        &$proxy_external_port$& &&&
13120        &$proxy_local_address$& &&&
13121        &$proxy_local_port$& &&&
13122        &$proxy_session$&
13123 These variables are only available when built with Proxy Protocol
13124 or SOCKS5 support.
13125 For details see chapter &<<SECTproxyInbound>>&.
13126
13127 .vitem &$prdr_requested$&
13128 .cindex "PRDR" "variable for"
13129 This variable is set to &"yes"& if PRDR was requested by the client for the
13130 current message, otherwise &"no"&.
13131
13132 .vitem &$prvscheck_address$& &&&
13133        &$prvscheck_keynum$& &&&
13134        &$prvscheck_result$&
13135 These variables are used in conjunction with the &%prvscheck%& expansion item,
13136 which is described in sections &<<SECTexpansionitems>>& and
13137 &<<SECTverifyPRVS>>&.
13138
13139 .vitem &$qualify_domain$&
13140 .vindex "&$qualify_domain$&"
13141 The value set for the &%qualify_domain%& option in the configuration file.
13142
13143 .vitem &$qualify_recipient$&
13144 .vindex "&$qualify_recipient$&"
13145 The value set for the &%qualify_recipient%& option in the configuration file,
13146 or if not set, the value of &$qualify_domain$&.
13147
13148 .vitem &$queue_name$&
13149 .vindex &$queue_name$&
13150 .cindex "named queues" variable
13151 .cindex queues named
13152 The name of the spool queue in use; empty for the default queue.
13153
13154 .vitem &$queue_size$&
13155 .vindex "&$queue_size$&"
13156 .cindex "queue" "size of"
13157 .cindex "spool" "number of messages"
13158 This variable contains the number of messages queued.
13159 It is evaluated on demand, but no more often than once every minute.
13160 If there is no daemon notifier socket open, the value will be
13161 an empty string.
13162
13163 .vitem &$r_...$&
13164 .vindex &$r_...$&
13165 .cindex router variables
13166 Values can be placed in these variables by the &%set%& option of a router.
13167 They can be given any name that starts with &$r_$&.
13168 The values persist for the address being handled through subsequent routers
13169 and the eventual transport.
13170
13171 .vitem &$rcpt_count$&
13172 .vindex "&$rcpt_count$&"
13173 When a message is being received by SMTP, this variable contains the number of
13174 RCPT commands received for the current message. If this variable is used in a
13175 RCPT ACL, its value includes the current command.
13176
13177 .vitem &$rcpt_defer_count$&
13178 .vindex "&$rcpt_defer_count$&"
13179 .cindex "4&'xx'& responses" "count of"
13180 When a message is being received by SMTP, this variable contains the number of
13181 RCPT commands in the current message that have previously been rejected with a
13182 temporary (4&'xx'&) response.
13183
13184 .vitem &$rcpt_fail_count$&
13185 .vindex "&$rcpt_fail_count$&"
13186 When a message is being received by SMTP, this variable contains the number of
13187 RCPT commands in the current message that have previously been rejected with a
13188 permanent (5&'xx'&) response.
13189
13190 .vitem &$received_count$&
13191 .vindex "&$received_count$&"
13192 This variable contains the number of &'Received:'& header lines in the message,
13193 including the one added by Exim (so its value is always greater than zero). It
13194 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13195 delivering.
13196
13197 .tvar &$received_for$&
13198 If there is only a single recipient address in an incoming message, this
13199 variable contains that address when the &'Received:'& header line is being
13200 built. The value is copied after recipient rewriting has happened, but before
13201 the &[local_scan()]& function is run.
13202
13203 .vitem &$received_ip_address$& &&&
13204        &$received_port$&
13205 .vindex "&$received_ip_address$&"
13206 .vindex "&$received_port$&"
13207 As soon as an Exim server starts processing an incoming TCP/IP connection, these
13208 variables are set to the address and port on the local IP interface.
13209 (The remote IP address and port are in
13210 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13211 the port value is -1 unless it has been set using the &%-oMi%& command line
13212 option.
13213
13214 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13215 could be used, for example, to make the filename for a TLS certificate depend
13216 on which interface and/or port is being used for the incoming connection. The
13217 values of &$received_ip_address$& and &$received_port$& are saved with any
13218 messages that are received, thus making these variables available at delivery
13219 time.
13220 For outbound connections see &$sending_ip_address$&.
13221
13222 .vitem &$received_protocol$&
13223 .vindex "&$received_protocol$&"
13224 When a message is being processed, this variable contains the name of the
13225 protocol by which it was received. Most of the names used by Exim are defined
13226 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13227 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13228 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13229 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13230 connection and the client was successfully authenticated.
13231
13232 Exim uses the protocol name &"smtps"& for the case when encryption is
13233 automatically set up on connection without the use of STARTTLS (see
13234 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13235 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13236 where the client initially uses EHLO, sets up an encrypted connection using
13237 STARTTLS, and then uses HELO afterwards.
13238
13239 The &%-oMr%& option provides a way of specifying a custom protocol name for
13240 messages that are injected locally by trusted callers. This is commonly used to
13241 identify messages that are being re-injected after some kind of scanning.
13242
13243 .vitem &$received_time$&
13244 .vindex "&$received_time$&"
13245 This variable contains the date and time when the current message was received,
13246 as a number of seconds since the start of the Unix epoch.
13247
13248 .vitem &$recipient_data$&
13249 .vindex "&$recipient_data$&"
13250 This variable is set after an indexing lookup success in an ACL &%recipients%&
13251 condition. It contains the data from the lookup, and the value remains set
13252 until the next &%recipients%& test. Thus, you can do things like this:
13253 .display
13254 &`require recipients  = cdb*@;/some/file`&
13255 &`deny    `&&'some further test involving'& &`$recipient_data`&
13256 .endd
13257 &*Warning*&: This variable is set only when a lookup is used as an indexing
13258 method in the address list, using the semicolon syntax as in the example above.
13259 The variable is not set for a lookup that is used as part of the string
13260 expansion that all such lists undergo before being interpreted.
13261
13262 .vitem &$recipient_verify_failure$&
13263 .vindex "&$recipient_verify_failure$&"
13264 In an ACL, when a recipient verification fails, this variable contains
13265 information about the failure. It is set to one of the following words:
13266
13267 .ilist
13268 &"qualify"&: The address was unqualified (no domain), and the message
13269 was neither local nor came from an exempted host.
13270
13271 .next
13272 &"route"&: Routing failed.
13273
13274 .next
13275 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13276 or before the MAIL command (that is, on initial connection, HELO, or
13277 MAIL).
13278
13279 .next
13280 &"recipient"&: The RCPT command in a callout was rejected.
13281 .next
13282
13283 &"postmaster"&: The postmaster check in a callout was rejected.
13284 .endlist
13285
13286 The main use of this variable is expected to be to distinguish between
13287 rejections of MAIL and rejections of RCPT.
13288
13289 .tvar &$recipients$&
13290 This variable contains a list of envelope recipients for a message. A comma and
13291 a space separate the addresses in the replacement text. However, the variable
13292 is not generally available, to prevent exposure of Bcc recipients in
13293 unprivileged users' filter files. You can use &$recipients$& only in these
13294 cases:
13295
13296 .olist
13297 In a system filter file.
13298 .next
13299 In the ACLs associated with the DATA command and with non-SMTP messages, that
13300 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13301 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13302 &%acl_not_smtp_mime%&.
13303 .next
13304 From within a &[local_scan()]& function.
13305 .endlist
13306
13307
13308 .vitem &$recipients_count$&
13309 .vindex "&$recipients_count$&"
13310 When a message is being processed, this variable contains the number of
13311 envelope recipients that came with the message. Duplicates are not excluded
13312 from the count. While a message is being received over SMTP, the number
13313 increases for each accepted recipient. It can be referenced in an ACL.
13314
13315
13316 .vitem &$regex_match_string$&
13317 .vindex "&$regex_match_string$&"
13318 This variable is set to contain the matching regular expression after a
13319 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13320
13321 .vitem "&$regex1$&, &$regex2$&, etc"
13322 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13323 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13324 these variables contain the
13325 captured substrings identified by the regular expression.
13326 If the subject string was tainted then so will any captured substring.
13327
13328
13329 .tvar &$reply_address$&
13330 When a message is being processed, this variable contains the contents of the
13331 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13332 contents of the &'From:'& header line. Apart from the removal of leading
13333 white space, the value is not processed in any way. In particular, no RFC 2047
13334 decoding or character code translation takes place.
13335
13336 .vitem &$return_path$&
13337 .vindex "&$return_path$&"
13338 When a message is being delivered, this variable contains the return path &--
13339 the sender field that will be sent as part of the envelope. It is not enclosed
13340 in <> characters. At the start of routing an address, &$return_path$& has the
13341 same value as &$sender_address$&, but if, for example, an incoming message to a
13342 mailing list has been expanded by a router which specifies a different address
13343 for bounce messages, &$return_path$& subsequently contains the new bounce
13344 address, whereas &$sender_address$& always contains the original sender address
13345 that was received with the message. In other words, &$sender_address$& contains
13346 the incoming envelope sender, and &$return_path$& contains the outgoing
13347 envelope sender.
13348
13349 .vitem &$return_size_limit$&
13350 .vindex "&$return_size_limit$&"
13351 This is an obsolete name for &$bounce_return_size_limit$&.
13352
13353 .vitem &$router_name$&
13354 .cindex "router" "name"
13355 .cindex "name" "of router"
13356 .vindex "&$router_name$&"
13357 During the running of a router this variable contains its name.
13358
13359 .vitem &$runrc$&
13360 .cindex "return code" "from &%run%& expansion"
13361 .vindex "&$runrc$&"
13362 This variable contains the return code from a command that is run by the
13363 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13364 assume the order in which option values are expanded, except for those
13365 preconditions whose order of testing is documented. Therefore, you cannot
13366 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13367 another.
13368
13369 .vitem &$self_hostname$&
13370 .oindex "&%self%&" "value of host name"
13371 .vindex "&$self_hostname$&"
13372 When an address is routed to a supposedly remote host that turns out to be the
13373 local host, what happens is controlled by the &%self%& generic router option.
13374 One of its values causes the address to be passed to another router. When this
13375 happens, &$self_hostname$& is set to the name of the local host that the
13376 original router encountered. In other circumstances its contents are null.
13377
13378 .tvar &$sender_address$&
13379 When a message is being processed, this variable contains the sender's address
13380 that was received in the message's envelope. The case of letters in the address
13381 is retained, in both the local part and the domain. For bounce messages, the
13382 value of this variable is the empty string. See also &$return_path$&.
13383
13384 .vitem &$sender_address_data$&
13385 .vindex "&$address_data$&"
13386 .vindex "&$sender_address_data$&"
13387 If &$address_data$& is set when the routers are called from an ACL to verify a
13388 sender address, the final value is preserved in &$sender_address_data$&, to
13389 distinguish it from data from a recipient address. The value does not persist
13390 after the end of the current ACL statement. If you want to preserve it for
13391 longer, you can save it in an ACL variable.
13392
13393 .tvar &$sender_address_domain$&
13394 The domain portion of &$sender_address$&.
13395
13396 .tvar &$sender_address_local_part$&
13397 The local part portion of &$sender_address$&.
13398
13399 .vitem &$sender_data$&
13400 .vindex "&$sender_data$&"
13401 This variable is set after a lookup success in an ACL &%senders%& condition or
13402 in a router &%senders%& option. It contains the data from the lookup, and the
13403 value remains set until the next &%senders%& test. Thus, you can do things like
13404 this:
13405 .display
13406 &`require senders      = cdb*@;/some/file`&
13407 &`deny    `&&'some further test involving'& &`$sender_data`&
13408 .endd
13409 &*Warning*&: This variable is set only when a lookup is used as an indexing
13410 method in the address list, using the semicolon syntax as in the example above.
13411 The variable is not set for a lookup that is used as part of the string
13412 expansion that all such lists undergo before being interpreted.
13413
13414 .vitem &$sender_fullhost$&
13415 .vindex "&$sender_fullhost$&"
13416 When a message is received from a remote host, this variable contains the host
13417 name and IP address in a single string. It ends with the IP address in square
13418 brackets, followed by a colon and a port number if the logging of ports is
13419 enabled. The format of the rest of the string depends on whether the host
13420 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13421 looking up its IP address. (Looking up the IP address can be forced by the
13422 &%host_lookup%& option, independent of verification.) A plain host name at the
13423 start of the string is a verified host name; if this is not present,
13424 verification either failed or was not requested. A host name in parentheses is
13425 the argument of a HELO or EHLO command. This is omitted if it is identical to
13426 the verified host name or to the host's IP address in square brackets.
13427
13428 .vitem &$sender_helo_dnssec$&
13429 .vindex "&$sender_helo_dnssec$&"
13430 This boolean variable is true if a successful HELO verification was
13431 .cindex "DNS" "DNSSEC"
13432 done using DNS information the resolver library stated was authenticated data.
13433
13434 .tvar &$sender_helo_name$&
13435 When a message is received from a remote host that has issued a HELO or EHLO
13436 command, the argument of that command is placed in this variable. It is also
13437 set if HELO or EHLO is used when a message is received using SMTP locally via
13438 the &%-bs%& or &%-bS%& options.
13439
13440 .vitem &$sender_host_address$&
13441 .vindex "&$sender_host_address$&"
13442 When a message is received from a remote host using SMTP,
13443 this variable contains that
13444 host's IP address. For locally non-SMTP submitted messages, it is empty.
13445
13446 .vitem &$sender_host_authenticated$&
13447 .vindex "&$sender_host_authenticated$&"
13448 This variable contains the name (not the public name) of the authenticator
13449 driver that successfully authenticated the client from which the message was
13450 received. It is empty if there was no successful authentication. See also
13451 &$authenticated_id$&.
13452
13453 .vitem &$sender_host_dnssec$&
13454 .vindex "&$sender_host_dnssec$&"
13455 If an attempt to populate &$sender_host_name$& has been made
13456 (by reference, &%hosts_lookup%& or
13457 otherwise) then this boolean will have been set true if, and only if, the
13458 resolver library states that both
13459 the reverse and forward DNS were authenticated data.  At all
13460 other times, this variable is false.
13461
13462 .cindex "DNS" "DNSSEC"
13463 It is likely that you will need to coerce DNSSEC support on in the resolver
13464 library, by setting:
13465 .code
13466 dns_dnssec_ok = 1
13467 .endd
13468
13469 In addition, on Linux with glibc 2.31 or newer the resolver library will
13470 default to stripping out a successful validation status.
13471 This will break a previously working Exim installation.
13472 Provided that you do trust the resolver (ie, is on localhost) you can tell
13473 glibc to pass through any successful validation with a new option in
13474 &_/etc/resolv.conf_&:
13475 .code
13476 options trust-ad
13477 .endd
13478
13479 Exim does not perform DNSSEC validation itself, instead leaving that to a
13480 validating resolver (e.g. unbound, or bind with suitable configuration).
13481
13482 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13483 mechanism in the list, then this variable will be false.
13484
13485 This requires that your system resolver library support EDNS0 (and that
13486 DNSSEC flags exist in the system headers).  If the resolver silently drops
13487 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13488 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13489
13490
13491 .tvar &$sender_host_name$&
13492 When a message is received from a remote host, this variable contains the
13493 host's name as obtained by looking up its IP address. For messages received by
13494 other means, this variable is empty.
13495
13496 .vindex "&$host_lookup_failed$&"
13497 If the host name has not previously been looked up, a reference to
13498 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13499 A looked up name is accepted only if it leads back to the original IP address
13500 via a forward lookup. If either the reverse or the forward lookup fails to find
13501 any data, or if the forward lookup does not yield the original IP address,
13502 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13503
13504 .vindex "&$host_lookup_deferred$&"
13505 However, if either of the lookups cannot be completed (for example, there is a
13506 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13507 &$host_lookup_failed$& remains set to &"0"&.
13508
13509 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13510 host name again if there is a subsequent reference to &$sender_host_name$&
13511 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13512 is set to &"1"&.
13513
13514 Exim does not automatically look up every calling host's name. If you want
13515 maximum efficiency, you should arrange your configuration so that it avoids
13516 these lookups altogether. The lookup happens only if one or more of the
13517 following are true:
13518
13519 .ilist
13520 A string containing &$sender_host_name$& is expanded.
13521 .next
13522 The calling host matches the list in &%host_lookup%&. In the default
13523 configuration, this option is set to *, so it must be changed if lookups are
13524 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13525 .next
13526 Exim needs the host name in order to test an item in a host list. The items
13527 that require this are described in sections &<<SECThoslispatnam>>& and
13528 &<<SECThoslispatnamsk>>&.
13529 .next
13530 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13531 In this case, the host name is required to compare with the name quoted in any
13532 EHLO or HELO commands that the client issues.
13533 .next
13534 The remote host issues a EHLO or HELO command that quotes one of the
13535 domains in &%helo_lookup_domains%&. The default value of this option is
13536 . ==== As this is a nested list, any displays it contains must be indented
13537 . ==== as otherwise they are too far to the left.
13538 .code
13539   helo_lookup_domains = @ : @[]
13540 .endd
13541 which causes a lookup if a remote host (incorrectly) gives the server's name or
13542 IP address in an EHLO or HELO command.
13543 .endlist
13544
13545
13546 .vitem &$sender_host_port$&
13547 .vindex "&$sender_host_port$&"
13548 When a message is received from a remote host, this variable contains the port
13549 number that was used on the remote host.
13550
13551 .vitem &$sender_ident$&
13552 .vindex "&$sender_ident$&"
13553 When a message is received from a remote host, this variable contains the
13554 identification received in response to an RFC 1413 request. When a message has
13555 been received locally, this variable contains the login name of the user that
13556 called Exim.
13557
13558 .vitem &$sender_rate_$&&'xxx'&
13559 A number of variables whose names begin &$sender_rate_$& are set as part of the
13560 &%ratelimit%& ACL condition. Details are given in section
13561 &<<SECTratelimiting>>&.
13562
13563 .vitem &$sender_rcvhost$&
13564 .cindex "DNS" "reverse lookup"
13565 .cindex "reverse DNS lookup"
13566 .vindex "&$sender_rcvhost$&"
13567 This is provided specifically for use in &'Received:'& headers. It starts with
13568 either the verified host name (as obtained from a reverse DNS lookup) or, if
13569 there is no verified host name, the IP address in square brackets. After that
13570 there may be text in parentheses. When the first item is a verified host name,
13571 the first thing in the parentheses is the IP address in square brackets,
13572 followed by a colon and a port number if port logging is enabled. When the
13573 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13574 the parentheses.
13575
13576 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13577 was used and its argument was not identical to the real host name or IP
13578 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13579 all three items are present in the parentheses, a newline and tab are inserted
13580 into the string, to improve the formatting of the &'Received:'& header.
13581
13582 .vitem &$sender_verify_failure$&
13583 .vindex "&$sender_verify_failure$&"
13584 In an ACL, when a sender verification fails, this variable contains information
13585 about the failure. The details are the same as for
13586 &$recipient_verify_failure$&.
13587
13588 .vitem &$sending_ip_address$&
13589 .vindex "&$sending_ip_address$&"
13590 This variable is set whenever an outgoing SMTP connection to another host has
13591 been set up. It contains the IP address of the local interface that is being
13592 used. This is useful if a host that has more than one IP address wants to take
13593 on different personalities depending on which one is being used. For incoming
13594 connections, see &$received_ip_address$&.
13595
13596 .vitem &$sending_port$&
13597 .vindex "&$sending_port$&"
13598 This variable is set whenever an outgoing SMTP connection to another host has
13599 been set up. It contains the local port that is being used. For incoming
13600 connections, see &$received_port$&.
13601
13602 .vitem &$smtp_active_hostname$&
13603 .vindex "&$smtp_active_hostname$&"
13604 During an incoming SMTP session, this variable contains the value of the active
13605 host name, as specified by the &%smtp_active_hostname%& option. The value of
13606 &$smtp_active_hostname$& is saved with any message that is received, so its
13607 value can be consulted during routing and delivery.
13608
13609 .tvar &$smtp_command$&
13610 During the processing of an incoming SMTP command, this variable contains the
13611 entire command. This makes it possible to distinguish between HELO and EHLO in
13612 the HELO ACL, and also to distinguish between commands such as these:
13613 .code
13614 MAIL FROM:<>
13615 MAIL FROM: <>
13616 .endd
13617 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13618 command, the address in &$smtp_command$& is the original address before any
13619 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13620 the address after SMTP-time rewriting.
13621
13622 .tvar &$smtp_command_argument$&
13623 .cindex "SMTP" "command, argument for"
13624 While an ACL is running to check an SMTP command, this variable contains the
13625 argument, that is, the text that follows the command name, with leading white
13626 space removed. Following the introduction of &$smtp_command$&, this variable is
13627 somewhat redundant, but is retained for backwards compatibility.
13628
13629 .vitem &$smtp_command_history$&
13630 .cindex SMTP "command history"
13631 .vindex "&$smtp_command_history$&"
13632 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13633 received, in time-order left to right.  Only a limited number of commands
13634 are remembered.
13635
13636 .vitem &$smtp_count_at_connection_start$&
13637 .vindex "&$smtp_count_at_connection_start$&"
13638 This variable is set greater than zero only in processes spawned by the Exim
13639 daemon for handling incoming SMTP connections. The name is deliberately long,
13640 in order to emphasize what the contents are. When the daemon accepts a new
13641 connection, it increments this variable. A copy of the variable is passed to
13642 the child process that handles the connection, but its value is fixed, and
13643 never changes. It is only an approximation of how many incoming connections
13644 there actually are, because many other connections may come and go while a
13645 single connection is being processed. When a child process terminates, the
13646 daemon decrements its copy of the variable.
13647
13648 .vitem "&$sn0$& &-- &$sn9$&"
13649 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13650 that were current at the end of the system filter file. This allows a system
13651 filter file to set values that can be tested in users' filter files. For
13652 example, a system filter could set a value indicating how likely it is that a
13653 message is junk mail.
13654
13655 .vitem &$spam_score$& &&&
13656        &$spam_score_int$& &&&
13657        &$spam_bar$& &&&
13658        &$spam_report$& &&&
13659        &$spam_action$&
13660 A number of variables whose names start with &$spam$& are available when Exim
13661 is compiled with the content-scanning extension. For details, see section
13662 &<<SECTscanspamass>>&.
13663
13664 .vitem &$spf_header_comment$& &&&
13665        &$spf_received$& &&&
13666        &$spf_result$& &&&
13667        &$spf_result_guessed$& &&&
13668        &$spf_smtp_comment$&
13669 These variables are only available if Exim is built with SPF support.
13670 For details see section &<<SECSPF>>&.
13671
13672 .vitem &$spool_directory$&
13673 .vindex "&$spool_directory$&"
13674 The name of Exim's spool directory.
13675
13676 .vitem &$spool_inodes$&
13677 .vindex "&$spool_inodes$&"
13678 The number of free inodes in the disk partition where Exim's spool files are
13679 being written. The value is recalculated whenever the variable is referenced.
13680 If the relevant file system does not have the concept of inodes, the value of
13681 is -1. See also the &%check_spool_inodes%& option.
13682
13683 .vitem &$spool_space$&
13684 .vindex "&$spool_space$&"
13685 The amount of free space (as a number of kilobytes) in the disk partition where
13686 Exim's spool files are being written. The value is recalculated whenever the
13687 variable is referenced. If the operating system does not have the ability to
13688 find the amount of free space (only true for experimental systems), the space
13689 value is -1. For example, to check in an ACL that there is at least 50
13690 megabytes free on the spool, you could write:
13691 .code
13692 condition = ${if > {$spool_space}{50000}}
13693 .endd
13694 See also the &%check_spool_space%& option.
13695
13696
13697 .vitem &$thisaddress$&
13698 .vindex "&$thisaddress$&"
13699 This variable is set only during the processing of the &%foranyaddress%&
13700 command in a filter file. Its use is explained in the description of that
13701 command, which can be found in the separate document entitled &'Exim's
13702 interfaces to mail filtering'&.
13703
13704 .vitem &$tls_in_bits$&
13705 .vindex "&$tls_in_bits$&"
13706 Contains an approximation of the TLS cipher's bit-strength
13707 on the inbound connection; the meaning of
13708 this depends upon the TLS implementation used.
13709 If TLS has not been negotiated, the value will be 0.
13710 The value of this is automatically fed into the Cyrus SASL authenticator
13711 when acting as a server, to specify the "external SSF" (a SASL term).
13712
13713 The deprecated &$tls_bits$& variable refers to the inbound side
13714 except when used in the context of an outbound SMTP delivery, when it refers to
13715 the outbound.
13716
13717 .vitem &$tls_out_bits$&
13718 .vindex "&$tls_out_bits$&"
13719 Contains an approximation of the TLS cipher's bit-strength
13720 on an outbound SMTP connection; the meaning of
13721 this depends upon the TLS implementation used.
13722 If TLS has not been negotiated, the value will be 0.
13723
13724 .vitem &$tls_in_ourcert$&
13725 .vindex "&$tls_in_ourcert$&"
13726 .cindex certificate variables
13727 This variable refers to the certificate presented to the peer of an
13728 inbound connection when the message was received.
13729 It is only useful as the argument of a
13730 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13731 or a &%def%& condition.
13732
13733 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13734 when a list of more than one
13735 file is used for &%tls_certificate%&, this variable is not reliable.
13736 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13737
13738 .vitem &$tls_in_peercert$&
13739 .vindex "&$tls_in_peercert$&"
13740 This variable refers to the certificate presented by the peer of an
13741 inbound connection when the message was received.
13742 It is only useful as the argument of a
13743 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13744 or a &%def%& condition.
13745 If certificate verification fails it may refer to a failing chain element
13746 which is not the leaf.
13747
13748 .vitem &$tls_out_ourcert$&
13749 .vindex "&$tls_out_ourcert$&"
13750 This variable refers to the certificate presented to the peer of an
13751 outbound connection.  It is only useful as the argument of a
13752 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13753 or a &%def%& condition.
13754
13755 .vitem &$tls_out_peercert$&
13756 .vindex "&$tls_out_peercert$&"
13757 This variable refers to the certificate presented by the peer of an
13758 outbound connection.  It is only useful as the argument of a
13759 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13760 or a &%def%& condition.
13761 If certificate verification fails it may refer to a failing chain element
13762 which is not the leaf.
13763
13764 .vitem &$tls_in_certificate_verified$&
13765 .vindex "&$tls_in_certificate_verified$&"
13766 This variable is set to &"1"& if a TLS certificate was verified when the
13767 message was received, and &"0"& otherwise.
13768
13769 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13770 except when used in the context of an outbound SMTP delivery, when it refers to
13771 the outbound.
13772
13773 .vitem &$tls_out_certificate_verified$&
13774 .vindex "&$tls_out_certificate_verified$&"
13775 This variable is set to &"1"& if a TLS certificate was verified when an
13776 outbound SMTP connection was made,
13777 and &"0"& otherwise.
13778
13779 .vitem &$tls_in_cipher$&
13780 .vindex "&$tls_in_cipher$&"
13781 .vindex "&$tls_cipher$&"
13782 When a message is received from a remote host over an encrypted SMTP
13783 connection, this variable is set to the cipher suite that was negotiated, for
13784 example DES-CBC3-SHA. In other circumstances, in particular, for message
13785 received over unencrypted connections, the variable is empty. Testing
13786 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13787 non-encrypted connections during ACL processing.
13788
13789 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13790 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13791 becomes the same as &$tls_out_cipher$&.
13792
13793 .vitem &$tls_in_cipher_std$&
13794 .vindex "&$tls_in_cipher_std$&"
13795 As above, but returning the RFC standard name for the cipher suite.
13796
13797 .vitem &$tls_out_cipher$&
13798 .vindex "&$tls_out_cipher$&"
13799 This variable is
13800 cleared before any outgoing SMTP connection is made,
13801 and then set to the outgoing cipher suite if one is negotiated. See chapter
13802 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13803 details of the &(smtp)& transport.
13804
13805 .vitem &$tls_out_cipher_std$&
13806 .vindex "&$tls_out_cipher_std$&"
13807 As above, but returning the RFC standard name for the cipher suite.
13808
13809 .vitem &$tls_out_dane$&
13810 .vindex &$tls_out_dane$&
13811 DANE active status.  See section &<<SECDANE>>&.
13812
13813 .vitem &$tls_in_ocsp$&
13814 .vindex "&$tls_in_ocsp$&"
13815 When a message is received from a remote client connection
13816 the result of any OCSP request from the client is encoded in this variable:
13817 .code
13818 0 OCSP proof was not requested (default value)
13819 1 No response to request
13820 2 Response not verified
13821 3 Verification failed
13822 4 Verification succeeded
13823 .endd
13824
13825 .vitem &$tls_out_ocsp$&
13826 .vindex "&$tls_out_ocsp$&"
13827 When a message is sent to a remote host connection
13828 the result of any OCSP request made is encoded in this variable.
13829 See &$tls_in_ocsp$& for values.
13830
13831 .vitem &$tls_in_peerdn$&
13832 .vindex "&$tls_in_peerdn$&"
13833 .vindex "&$tls_peerdn$&"
13834 .cindex certificate "extracting fields"
13835 When a message is received from a remote host over an encrypted SMTP
13836 connection, and Exim is configured to request a certificate from the client,
13837 the value of the Distinguished Name of the certificate is made available in the
13838 &$tls_in_peerdn$& during subsequent processing.
13839 If certificate verification fails it may refer to a failing chain element
13840 which is not the leaf.
13841
13842 The deprecated &$tls_peerdn$& variable refers to the inbound side
13843 except when used in the context of an outbound SMTP delivery, when it refers to
13844 the outbound.
13845
13846 .vitem &$tls_out_peerdn$&
13847 .vindex "&$tls_out_peerdn$&"
13848 When a message is being delivered to a remote host over an encrypted SMTP
13849 connection, and Exim is configured to request a certificate from the server,
13850 the value of the Distinguished Name of the certificate is made available in the
13851 &$tls_out_peerdn$& during subsequent processing.
13852 If certificate verification fails it may refer to a failing chain element
13853 which is not the leaf.
13854
13855
13856 .vitem &$tls_in_resumption$& &&&
13857        &$tls_out_resumption$&
13858 .vindex &$tls_in_resumption$&
13859 .vindex &$tls_out_resumption$&
13860 .cindex TLS resumption
13861 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
13862
13863
13864 .tvar &$tls_in_sni$&
13865 .vindex "&$tls_sni$&"
13866 .cindex "TLS" "Server Name Indication"
13867 .cindex "TLS" SNI
13868 .cindex SNI "observability on server"
13869 When a TLS session is being established, if the client sends the Server
13870 Name Indication extension, the value will be placed in this variable.
13871 If the variable appears in &%tls_certificate%& then this option and
13872 some others, described in &<<SECTtlssni>>&,
13873 will be re-expanded early in the TLS session, to permit
13874 a different certificate to be presented (and optionally a different key to be
13875 used) to the client, based upon the value of the SNI extension.
13876
13877 The deprecated &$tls_sni$& variable refers to the inbound side
13878 except when used in the context of an outbound SMTP delivery, when it refers to
13879 the outbound.
13880
13881 .vitem &$tls_out_sni$&
13882 .vindex "&$tls_out_sni$&"
13883 .cindex "TLS" "Server Name Indication"
13884 .cindex "TLS" SNI
13885 .cindex SNI "observability in client"
13886 During outbound
13887 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13888 the transport.
13889
13890 .vitem &$tls_out_tlsa_usage$&
13891 .vindex &$tls_out_tlsa_usage$&
13892 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13893
13894 .vitem &$tls_in_ver$&
13895 .vindex "&$tls_in_ver$&"
13896 When a message is received from a remote host over an encrypted SMTP connection
13897 this variable is set to the protocol version, eg &'TLS1.2'&.
13898
13899 .vitem &$tls_out_ver$&
13900 .vindex "&$tls_out_ver$&"
13901 When a message is being delivered to a remote host over an encrypted SMTP connection
13902 this variable is set to the protocol version.
13903
13904
13905 .vitem &$tod_bsdinbox$&
13906 .vindex "&$tod_bsdinbox$&"
13907 The time of day and the date, in the format required for BSD-style mailbox
13908 files, for example: Thu Oct 17 17:14:09 1995.
13909
13910 .vitem &$tod_epoch$&
13911 .vindex "&$tod_epoch$&"
13912 The time and date as a number of seconds since the start of the Unix epoch.
13913
13914 .vitem &$tod_epoch_l$&
13915 .vindex "&$tod_epoch_l$&"
13916 The time and date as a number of microseconds since the start of the Unix epoch.
13917
13918 .vitem &$tod_full$&
13919 .vindex "&$tod_full$&"
13920 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13921 +0100. The timezone is always given as a numerical offset from UTC, with
13922 positive values used for timezones that are ahead (east) of UTC, and negative
13923 values for those that are behind (west).
13924
13925 .vitem &$tod_log$&
13926 .vindex "&$tod_log$&"
13927 The time and date in the format used for writing Exim's log files, for example:
13928 1995-10-12 15:32:29, but without a timezone.
13929
13930 .vitem &$tod_logfile$&
13931 .vindex "&$tod_logfile$&"
13932 This variable contains the date in the format yyyymmdd. This is the format that
13933 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13934 flag.
13935
13936 .vitem &$tod_zone$&
13937 .vindex "&$tod_zone$&"
13938 This variable contains the numerical value of the local timezone, for example:
13939 -0500.
13940
13941 .vitem &$tod_zulu$&
13942 .vindex "&$tod_zulu$&"
13943 This variable contains the UTC date and time in &"Zulu"& format, as specified
13944 by ISO 8601, for example: 20030221154023Z.
13945
13946 .vitem &$transport_name$&
13947 .cindex "transport" "name"
13948 .cindex "name" "of transport"
13949 .vindex "&$transport_name$&"
13950 During the running of a transport, this variable contains its name.
13951
13952 .vitem &$value$&
13953 .vindex "&$value$&"
13954 This variable contains the result of an expansion lookup, extraction operation,
13955 or external command, as described above. It is also used during a
13956 &*reduce*& expansion.
13957
13958 .vitem &$verify_mode$&
13959 .vindex "&$verify_mode$&"
13960 While a router or transport is being run in verify mode or for cutthrough delivery,
13961 contains "S" for sender-verification or "R" for recipient-verification.
13962 Otherwise, empty.
13963
13964 .vitem &$version_number$&
13965 .vindex "&$version_number$&"
13966 The version number of Exim. Same as &$exim_version$&, may be overridden
13967 by the &%exim_version%& main config option.
13968
13969 .vitem &$warn_message_delay$&
13970 .vindex "&$warn_message_delay$&"
13971 This variable is set only during the creation of a message warning about a
13972 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13973
13974 .vitem &$warn_message_recipients$&
13975 .vindex "&$warn_message_recipients$&"
13976 This variable is set only during the creation of a message warning about a
13977 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13978 .endlist
13979 .ecindex IIDstrexp
13980
13981
13982
13983 . ////////////////////////////////////////////////////////////////////////////
13984 . ////////////////////////////////////////////////////////////////////////////
13985
13986 .chapter "Embedded Perl" "CHAPperl"
13987 .scindex IIDperl "Perl" "calling from Exim"
13988 Exim can be built to include an embedded Perl interpreter. When this is done,
13989 Perl subroutines can be called as part of the string expansion process. To make
13990 use of the Perl support, you need version 5.004 or later of Perl installed on
13991 your system. To include the embedded interpreter in the Exim binary, include
13992 the line
13993 .code
13994 EXIM_PERL = perl.o
13995 .endd
13996 in your &_Local/Makefile_& and then build Exim in the normal way.
13997
13998
13999 .section "Setting up so Perl can be used" "SECID85"
14000 .oindex "&%perl_startup%&"
14001 Access to Perl subroutines is via a global configuration option called
14002 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14003 no &%perl_startup%& option in the Exim configuration file then no Perl
14004 interpreter is started and there is almost no overhead for Exim (since none of
14005 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14006 option then the associated value is taken to be Perl code which is executed in
14007 a newly created Perl interpreter.
14008
14009 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14010 need backslashes before any characters to escape special meanings. The option
14011 should usually be something like
14012 .code
14013 perl_startup = do '/etc/exim.pl'
14014 .endd
14015 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14016 use from Exim. Exim can be configured either to start up a Perl interpreter as
14017 soon as it is entered, or to wait until the first time it is needed. Starting
14018 the interpreter at the beginning ensures that it is done while Exim still has
14019 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14020 fact used in a particular run. Also, note that this does not mean that Exim is
14021 necessarily running as root when Perl is called at a later time. By default,
14022 the interpreter is started only when it is needed, but this can be changed in
14023 two ways:
14024
14025 .ilist
14026 .oindex "&%perl_at_start%&"
14027 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14028 a startup when Exim is entered.
14029 .next
14030 The command line option &%-ps%& also requests a startup when Exim is entered,
14031 overriding the setting of &%perl_at_start%&.
14032 .endlist
14033
14034 There is also a command line option &%-pd%& (for delay) which suppresses the
14035 initial startup, even if &%perl_at_start%& is set.
14036
14037 .ilist
14038 .oindex "&%perl_taintmode%&"
14039 .cindex "Perl" "taintmode"
14040 To provide more security executing Perl code via the embedded Perl
14041 interpreter, the &%perl_taintmode%& option can be set. This enables the
14042 taint mode of the Perl interpreter. You are encouraged to set this
14043 option to a true value. To avoid breaking existing installations, it
14044 defaults to false.
14045
14046 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14047
14048
14049 .section "Calling Perl subroutines" "SECID86"
14050 When the configuration file includes a &%perl_startup%& option you can make use
14051 of the string expansion item to call the Perl subroutines that are defined
14052 by the &%perl_startup%& code. The operator is used in any of the following
14053 forms:
14054 .code
14055 ${perl{foo}}
14056 ${perl{foo}{argument}}
14057 ${perl{foo}{argument1}{argument2} ... }
14058 .endd
14059 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14060 arguments may be passed. Passing more than this results in an expansion failure
14061 with an error message of the form
14062 .code
14063 Too many arguments passed to Perl subroutine "foo" (max is 8)
14064 .endd
14065 The return value of the Perl subroutine is evaluated in a scalar context before
14066 it is passed back to Exim to be inserted into the expanded string. If the
14067 return value is &'undef'&, the expansion is forced to fail in the same way as
14068 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14069 by obeying Perl's &%die%& function, the expansion fails with the error message
14070 that was passed to &%die%&.
14071
14072
14073 .section "Calling Exim functions from Perl" "SECID87"
14074 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14075 is available to call back into Exim's string expansion function. For example,
14076 the Perl code
14077 .code
14078 my $lp = Exim::expand_string('$local_part');
14079 .endd
14080 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14081 Note those are single quotes and not double quotes to protect against
14082 &$local_part$& being interpolated as a Perl variable.
14083
14084 If the string expansion is forced to fail by a &"fail"& item, the result of
14085 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14086 expansion string, the Perl call from the original expansion string fails with
14087 an appropriate error message, in the same way as if &%die%& were used.
14088
14089 .cindex "debugging" "from embedded Perl"
14090 .cindex "log" "writing from embedded Perl"
14091 Two other Exim functions are available for use from within Perl code.
14092 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14093 debugging is enabled. If you want a newline at the end, you must supply it.
14094 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14095 timestamp. In this case, you should not supply a terminating newline.
14096
14097
14098 .section "Use of standard output and error by Perl" "SECID88"
14099 .cindex "Perl" "standard output and error"
14100 You should not write to the standard error or output streams from within your
14101 Perl code, as it is not defined how these are set up. In versions of Exim
14102 before 4.50, it is possible for the standard output or error to refer to the
14103 SMTP connection during message reception via the daemon. Writing to this stream
14104 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14105 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14106 avoided, but the output is lost.
14107
14108 .cindex "Perl" "use of &%warn%&"
14109 The Perl &%warn%& statement writes to the standard error stream by default.
14110 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14111 you have no control. When Exim starts up the Perl interpreter, it arranges for
14112 output from the &%warn%& statement to be written to the Exim main log. You can
14113 change this by including appropriate Perl magic somewhere in your Perl code.
14114 For example, to discard &%warn%& output completely, you need this:
14115 .code
14116 $SIG{__WARN__} = sub { };
14117 .endd
14118 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14119 example, the code for the subroutine is empty, so it does nothing, but you can
14120 include any Perl code that you like. The text of the &%warn%& message is passed
14121 as the first subroutine argument.
14122 .ecindex IIDperl
14123
14124
14125 . ////////////////////////////////////////////////////////////////////////////
14126 . ////////////////////////////////////////////////////////////////////////////
14127
14128 .chapter "Starting the daemon and the use of network interfaces" &&&
14129          "CHAPinterfaces" &&&
14130          "Starting the daemon"
14131 .cindex "daemon" "starting"
14132 .cindex "interface" "listening"
14133 .cindex "network interface"
14134 .cindex "interface" "network"
14135 .cindex "IP address" "for listening"
14136 .cindex "daemon" "listening IP addresses"
14137 .cindex "TCP/IP" "setting listening interfaces"
14138 .cindex "TCP/IP" "setting listening ports"
14139 A host that is connected to a TCP/IP network may have one or more physical
14140 hardware network interfaces. Each of these interfaces may be configured as one
14141 or more &"logical"& interfaces, which are the entities that a program actually
14142 works with. Each of these logical interfaces is associated with an IP address.
14143 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14144 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14145 knowledge about the host's interfaces for use in three different circumstances:
14146
14147 .olist
14148 When a listening daemon is started, Exim needs to know which interfaces
14149 and ports to listen on.
14150 .next
14151 When Exim is routing an address, it needs to know which IP addresses
14152 are associated with local interfaces. This is required for the correct
14153 processing of MX lists by removing the local host and others with the
14154 same or higher priority values. Also, Exim needs to detect cases
14155 when an address is routed to an IP address that in fact belongs to the
14156 local host. Unless the &%self%& router option or the &%allow_localhost%&
14157 option of the smtp transport is set (as appropriate), this is treated
14158 as an error situation.
14159 .next
14160 When Exim connects to a remote host, it may need to know which interface to use
14161 for the outgoing connection.
14162 .endlist
14163
14164
14165 Exim's default behaviour is likely to be appropriate in the vast majority
14166 of cases. If your host has only one interface, and you want all its IP
14167 addresses to be treated in the same way, and you are using only the
14168 standard SMTP port, you should not need to take any special action. The
14169 rest of this chapter does not apply to you.
14170
14171 In a more complicated situation you may want to listen only on certain
14172 interfaces, or on different ports, and for this reason there are a number of
14173 options that can be used to influence Exim's behaviour. The rest of this
14174 chapter describes how they operate.
14175
14176 When a message is received over TCP/IP, the interface and port that were
14177 actually used are set in &$received_ip_address$& and &$received_port$&.
14178
14179
14180
14181 .section "Starting a listening daemon" "SECID89"
14182 When a listening daemon is started (by means of the &%-bd%& command line
14183 option), the interfaces and ports on which it listens are controlled by the
14184 following options:
14185
14186 .ilist
14187 &%daemon_smtp_ports%& contains a list of default ports
14188 or service names.
14189 (For backward compatibility, this option can also be specified in the singular.)
14190 .next
14191 &%local_interfaces%& contains list of interface IP addresses on which to
14192 listen. Each item may optionally also specify a port.
14193 .endlist
14194
14195 The default list separator in both cases is a colon, but this can be changed as
14196 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14197 it is usually best to change the separator to avoid having to double all the
14198 colons. For example:
14199 .code
14200 local_interfaces = <; 127.0.0.1 ; \
14201                       192.168.23.65 ; \
14202                       ::1 ; \
14203                       3ffe:ffff:836f::fe86:a061
14204 .endd
14205 There are two different formats for specifying a port along with an IP address
14206 in &%local_interfaces%&:
14207
14208 .olist
14209 The port is added onto the address with a dot separator. For example, to listen
14210 on port 1234 on two different IP addresses:
14211 .code
14212 local_interfaces = <; 192.168.23.65.1234 ; \
14213                       3ffe:ffff:836f::fe86:a061.1234
14214 .endd
14215 .next
14216 The IP address is enclosed in square brackets, and the port is added
14217 with a colon separator, for example:
14218 .code
14219 local_interfaces = <; [192.168.23.65]:1234 ; \
14220                       [3ffe:ffff:836f::fe86:a061]:1234
14221 .endd
14222 .endlist
14223
14224 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14225 default setting contains just one port:
14226 .code
14227 daemon_smtp_ports = smtp
14228 .endd
14229 If more than one port is listed, each interface that does not have its own port
14230 specified listens on all of them. Ports that are listed in
14231 &%daemon_smtp_ports%& can be identified either by name (defined in
14232 &_/etc/services_&) or by number. However, when ports are given with individual
14233 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14234
14235
14236
14237 .section "Special IP listening addresses" "SECID90"
14238 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14239 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14240 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14241 instead of setting up separate listening sockets for each interface. The
14242 default value of &%local_interfaces%& is
14243 .code
14244 local_interfaces = 0.0.0.0
14245 .endd
14246 when Exim is built without IPv6 support; otherwise it is:
14247 .code
14248 local_interfaces = <; ::0 ; 0.0.0.0
14249 .endd
14250 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14251
14252
14253
14254 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14255 The &%-oX%& command line option can be used to override the values of
14256 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14257 instance. Another way of doing this would be to use macros and the &%-D%&
14258 option. However, &%-oX%& can be used by any admin user, whereas modification of
14259 the runtime configuration by &%-D%& is allowed only when the caller is root or
14260 exim.
14261
14262 The value of &%-oX%& is a list of items. The default colon separator can be
14263 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14264 If there are any items that do not
14265 contain dots or colons (that is, are not IP addresses), the value of
14266 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14267 items that do contain dots or colons, the value of &%local_interfaces%& is
14268 replaced by those items. Thus, for example,
14269 .code
14270 -oX 1225
14271 .endd
14272 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14273 whereas
14274 .code
14275 -oX 192.168.34.5.1125
14276 .endd
14277 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14278 (However, since &%local_interfaces%& now contains no items without ports, the
14279 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14280
14281
14282
14283 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14284 .cindex "submissions protocol"
14285 .cindex "ssmtp protocol"
14286 .cindex "smtps protocol"
14287 .cindex "SMTP" "ssmtp protocol"
14288 .cindex "SMTP" "smtps protocol"
14289 Exim supports the use of TLS-on-connect, used by mail clients in the
14290 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14291 For some years, IETF Standards Track documents only blessed the
14292 STARTTLS-based Submission service (port 587) while common practice was to support
14293 the same feature set on port 465, but using TLS-on-connect.
14294 If your installation needs to provide service to mail clients
14295 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14296 the 465 TCP ports.
14297
14298 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14299 service names, connections to those ports must first establish TLS, before
14300 proceeding to the application layer use of the SMTP protocol.
14301
14302 The common use of this option is expected to be
14303 .code
14304 tls_on_connect_ports = 465
14305 .endd
14306 per RFC 8314.
14307 There is also a command line option &%-tls-on-connect%&, which forces all ports
14308 to behave in this way when a daemon is started.
14309
14310 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14311 daemon to listen on those ports. You must still specify them in
14312 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14313 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14314 connections via the daemon.)
14315
14316
14317
14318
14319 .section "IPv6 address scopes" "SECID92"
14320 .cindex "IPv6" "address scopes"
14321 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14322 can, in principle, have the same link-local IPv6 address on different
14323 interfaces. Thus, additional information is needed, over and above the IP
14324 address, to distinguish individual interfaces. A convention of using a
14325 percent sign followed by something (often the interface name) has been
14326 adopted in some cases, leading to addresses like this:
14327 .code
14328 fe80::202:b3ff:fe03:45c1%eth0
14329 .endd
14330 To accommodate this usage, a percent sign followed by an arbitrary string is
14331 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14332 to convert a textual IPv6 address for actual use. This function recognizes the
14333 percent convention in operating systems that support it, and it processes the
14334 address appropriately. Unfortunately, some older libraries have problems with
14335 &[getaddrinfo()]&. If
14336 .code
14337 IPV6_USE_INET_PTON=yes
14338 .endd
14339 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14340 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14341 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14342 function.) Of course, this means that the additional functionality of
14343 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14344
14345 .section "Disabling IPv6" "SECID93"
14346 .cindex "IPv6" "disabling"
14347 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14348 run on a host whose kernel does not support IPv6. The binary will fall back to
14349 using IPv4, but it may waste resources looking up AAAA records, and trying to
14350 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14351 .oindex "&%disable_ipv6%&"
14352 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14353 activities take place. AAAA records are never looked up, and any IPv6 addresses
14354 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14355 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14356 to handle IPv6 literal addresses.
14357
14358 On the other hand, when IPv6 is in use, there may be times when you want to
14359 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14360 option to globally suppress the lookup of AAAA records for specified domains,
14361 and you can use the &%ignore_target_hosts%& generic router option to ignore
14362 IPv6 addresses in an individual router.
14363
14364
14365
14366 .section "Examples of starting a listening daemon" "SECID94"
14367 The default case in an IPv6 environment is
14368 .code
14369 daemon_smtp_ports = smtp
14370 local_interfaces = <; ::0 ; 0.0.0.0
14371 .endd
14372 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14373 Either one or two sockets may be used, depending on the characteristics of
14374 the TCP/IP stack. (This is complicated and messy; for more information,
14375 read the comments in the &_daemon.c_& source file.)
14376
14377 To specify listening on ports 25 and 26 on all interfaces:
14378 .code
14379 daemon_smtp_ports = 25 : 26
14380 .endd
14381 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14382 .code
14383 local_interfaces = <; ::0.25     ; ::0.26 \
14384                       0.0.0.0.25 ; 0.0.0.0.26
14385 .endd
14386 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14387 IPv4 loopback address only:
14388 .code
14389 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14390 .endd
14391 To specify listening on the default port on specific interfaces only:
14392 .code
14393 local_interfaces = 10.0.0.67 : 192.168.34.67
14394 .endd
14395 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14396
14397
14398
14399 .section "Recognizing the local host" "SECTreclocipadd"
14400 The &%local_interfaces%& option is also used when Exim needs to determine
14401 whether or not an IP address refers to the local host. That is, the IP
14402 addresses of all the interfaces on which a daemon is listening are always
14403 treated as local.
14404
14405 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14406 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14407 available interfaces from the operating system, and extracts the relevant
14408 (that is, IPv4 or IPv6) addresses to use for checking.
14409
14410 Some systems set up large numbers of virtual interfaces in order to provide
14411 many virtual web servers. In this situation, you may want to listen for
14412 email on only a few of the available interfaces, but nevertheless treat all
14413 interfaces as local when routing. You can do this by setting
14414 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14415 &"all"& wildcard values. These addresses are recognized as local, but are not
14416 used for listening. Consider this example:
14417 .code
14418 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14419                       192.168.53.235 ; \
14420                       3ffe:2101:12:1:a00:20ff:fe86:a061
14421
14422 extra_local_interfaces = <; ::0 ; 0.0.0.0
14423 .endd
14424 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14425 address, but all available interface addresses are treated as local when
14426 Exim is routing.
14427
14428 In some environments the local host name may be in an MX list, but with an IP
14429 address that is not assigned to any local interface. In other cases it may be
14430 desirable to treat other host names as if they referred to the local host. Both
14431 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14432 This contains host names rather than IP addresses. When a host is referenced
14433 during routing, either via an MX record or directly, it is treated as the local
14434 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14435 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14436
14437
14438
14439 .section "Delivering to a remote host" "SECID95"
14440 Delivery to a remote host is handled by the smtp transport. By default, it
14441 allows the system's TCP/IP functions to choose which interface to use (if
14442 there is more than one) when connecting to a remote host. However, the
14443 &%interface%& option can be set to specify which interface is used. See the
14444 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14445 details.
14446
14447
14448
14449
14450 . ////////////////////////////////////////////////////////////////////////////
14451 . ////////////////////////////////////////////////////////////////////////////
14452
14453 .chapter "Main configuration" "CHAPmainconfig"
14454 .scindex IIDconfima "configuration file" "main section"
14455 .scindex IIDmaiconf "main configuration"
14456 The first part of the runtime configuration file contains three types of item:
14457
14458 .ilist
14459 Macro definitions: These lines start with an upper case letter. See section
14460 &<<SECTmacrodefs>>& for details of macro processing.
14461 .next
14462 Named list definitions: These lines start with one of the words &"domainlist"&,
14463 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14464 section &<<SECTnamedlists>>&.
14465 .next
14466 Main configuration settings: Each setting occupies one line of the file
14467 (with possible continuations). If any setting is preceded by the word
14468 &"hide"&, the &%-bP%& command line option displays its value to admin users
14469 only. See section &<<SECTcos>>& for a description of the syntax of these option
14470 settings.
14471 .endlist
14472
14473 This chapter specifies all the main configuration options, along with their
14474 types and default values. For ease of finding a particular option, they appear
14475 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14476 are now so many options, they are first listed briefly in functional groups, as
14477 an aid to finding the name of the option you are looking for. Some options are
14478 listed in more than one group.
14479
14480 .section "Miscellaneous" "SECID96"
14481 .table2
14482 .row &%add_environment%&             "environment variables"
14483 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14484 .row &%debug_store%&                 "do extra internal checks"
14485 .row &%disable_ipv6%&                "do no IPv6 processing"
14486 .row &%keep_environment%&            "environment variables"
14487 .row &%keep_malformed%&              "for broken files &-- should not happen"
14488 .row &%localhost_number%&            "for unique message ids in clusters"
14489 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14490 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14491 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14492 .row &%print_topbitchars%&           "top-bit characters are printing"
14493 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14494 .row &%timezone%&                    "force time zone"
14495 .endtable
14496
14497
14498 .section "Exim parameters" "SECID97"
14499 .table2
14500 .row &%exim_group%&                  "override compiled-in value"
14501 .row &%exim_path%&                   "override compiled-in value"
14502 .row &%exim_user%&                   "override compiled-in value"
14503 .row &%primary_hostname%&            "default from &[uname()]&"
14504 .row &%split_spool_directory%&       "use multiple directories"
14505 .row &%spool_directory%&             "override compiled-in value"
14506 .endtable
14507
14508
14509
14510 .section "Privilege controls" "SECID98"
14511 .table2
14512 .row &%admin_groups%&                "groups that are Exim admin users"
14513 .row &%commandline_checks_require_admin%& "require admin for various checks"
14514 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14515 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14516 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14517 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14518 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14519 .row &%never_users%&                 "do not run deliveries as these"
14520 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14521 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14522 .row &%trusted_groups%&              "groups that are trusted"
14523 .row &%trusted_users%&               "users that are trusted"
14524 .endtable
14525
14526
14527
14528 .section "Logging" "SECID99"
14529 .table2
14530 .row &%event_action%&                "custom logging"
14531 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14532 .row &%log_file_path%&               "override compiled-in value"
14533 .row &%log_selector%&                "set/unset optional logging"
14534 .row &%log_timezone%&                "add timezone to log lines"
14535 .row &%message_logs%&                "create per-message logs"
14536 .row &%preserve_message_logs%&       "after message completion"
14537 .row &%panic_coredump%&              "request coredump on fatal errors"
14538 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14539 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14540 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14541 .row &%syslog_facility%&             "set syslog &""facility""& field"
14542 .row &%syslog_pid%&                  "pid in syslog lines"
14543 .row &%syslog_processname%&          "set syslog &""ident""& field"
14544 .row &%syslog_timestamp%&            "timestamp syslog lines"
14545 .row &%write_rejectlog%&             "control use of message log"
14546 .endtable
14547
14548
14549
14550 .section "Frozen messages" "SECID100"
14551 .table2
14552 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14553 .row &%freeze_tell%&                 "send message when freezing"
14554 .row &%move_frozen_messages%&        "to another directory"
14555 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14556 .endtable
14557
14558
14559
14560 .section "Data lookups" "SECID101"
14561 .table2
14562 .row &%ibase_servers%&               "InterBase servers"
14563 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14564 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14565 .row &%ldap_cert_file%&              "client cert file for LDAP"
14566 .row &%ldap_cert_key%&               "client key file for LDAP"
14567 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14568 .row &%ldap_default_servers%&        "used if no server in query"
14569 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14570 .row &%ldap_start_tls%&              "require TLS within LDAP"
14571 .row &%ldap_version%&                "set protocol version"
14572 .row &%lookup_open_max%&             "lookup files held open"
14573 .row &%mysql_servers%&               "default MySQL servers"
14574 .row &%oracle_servers%&              "Oracle servers"
14575 .row &%pgsql_servers%&               "default PostgreSQL servers"
14576 .row &%sqlite_lock_timeout%&         "as it says"
14577 .endtable
14578
14579
14580
14581 .section "Message ids" "SECID102"
14582 .table2
14583 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14584 .row &%message_id_header_text%&      "ditto"
14585 .endtable
14586
14587
14588
14589 .section "Embedded Perl Startup" "SECID103"
14590 .table2
14591 .row &%perl_at_start%&               "always start the interpreter"
14592 .row &%perl_startup%&                "code to obey when starting Perl"
14593 .row &%perl_taintmode%&              "enable taint mode in Perl"
14594 .endtable
14595
14596
14597
14598 .section "Daemon" "SECID104"
14599 .table2
14600 .row &%daemon_smtp_ports%&           "default ports"
14601 .row &%daemon_startup_retries%&      "number of times to retry"
14602 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14603 .row &%extra_local_interfaces%&      "not necessarily listened on"
14604 .row &%local_interfaces%&            "on which to listen, with optional ports"
14605 .row &%notifier_socket%&             "override compiled-in value"
14606 .row &%pid_file_path%&               "override compiled-in value"
14607 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14608 .row &%smtp_backlog_monitor%&        "level to log listen backlog"
14609 .endtable
14610
14611
14612
14613 .section "Resource control" "SECID105"
14614 .table2
14615 .row &%check_log_inodes%&            "before accepting a message"
14616 .row &%check_log_space%&             "before accepting a message"
14617 .row &%check_spool_inodes%&          "before accepting a message"
14618 .row &%check_spool_space%&           "before accepting a message"
14619 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14620 .row &%queue_only_load%&             "queue incoming if load high"
14621 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14622 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14623 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14624 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14625 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14626 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14627 .row &%smtp_accept_max_per_connection%& "messages per connection"
14628 .row &%smtp_accept_max_per_host%&    "connections from one host"
14629 .row &%smtp_accept_queue%&           "queue mail if more connections"
14630 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14631                                            connection"
14632 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14633 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14634 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14635 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14636 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14637 .endtable
14638
14639
14640
14641 .section "Policy controls" "SECID106"
14642 .table2
14643 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14644 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14645 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14646 .row &%acl_smtp_auth%&               "ACL for AUTH"
14647 .row &%acl_smtp_connect%&            "ACL for connection"
14648 .row &%acl_smtp_data%&               "ACL for DATA"
14649 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14650 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14651 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14652 .row &%acl_smtp_expn%&               "ACL for EXPN"
14653 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14654 .row &%acl_smtp_mail%&               "ACL for MAIL"
14655 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14656 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14657 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14658 .row &%acl_smtp_predata%&            "ACL for start of data"
14659 .row &%acl_smtp_quit%&               "ACL for QUIT"
14660 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14661 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14662 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14663 .row &%av_scanner%&                  "specify virus scanner"
14664 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14665                                       words""&"
14666 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14667 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14668 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14669 .row &%header_maxsize%&              "total size of message header"
14670 .row &%header_line_maxsize%&         "individual header line limit"
14671 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14672 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14673 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14674 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14675 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14676 .row &%host_lookup%&                 "host name looked up for these hosts"
14677 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14678 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14679 .row &%host_reject_connection%&      "reject connection from these hosts"
14680 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14681 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14682 .row &%message_size_limit%&          "for all messages"
14683 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14684 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14685 .row &%spamd_address%&               "set interface to SpamAssassin"
14686 .row &%strict_acl_vars%&             "object to unset ACL variables"
14687 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14688 .endtable
14689
14690
14691
14692 .section "Callout cache" "SECID107"
14693 .table2
14694 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14695                                          item"
14696 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14697                                          item"
14698 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14699 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14700 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14701 .endtable
14702
14703
14704
14705 .section "TLS" "SECID108"
14706 .table2
14707 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14708 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14709 .row &%hosts_require_alpn%&          "mandatory ALPN"
14710 .row &%hosts_require_helo%&          "mandatory HELO/EHLO"
14711 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14712 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14713 .row &%tls_alpn%&                    "acceptable protocol names"
14714 .row &%tls_certificate%&             "location of server certificate"
14715 .row &%tls_crl%&                     "certificate revocation list"
14716 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14717 .row &%tls_dhparam%&                 "DH parameters for server"
14718 .row &%tls_eccurve%&                 "EC curve selection for server"
14719 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14720 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14721 .row &%tls_privatekey%&              "location of server private key"
14722 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14723 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14724 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14725 .row &%tls_verify_certificates%&     "expected client certificates"
14726 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14727 .endtable
14728
14729
14730
14731 .section "Local user handling" "SECID109"
14732 .table2
14733 .row &%finduser_retries%&            "useful in NIS environments"
14734 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14735 .row &%gecos_pattern%&               "ditto"
14736 .row &%max_username_length%&         "for systems that truncate"
14737 .row &%unknown_login%&               "used when no login name found"
14738 .row &%unknown_username%&            "ditto"
14739 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14740 .row &%uucp_from_sender%&            "ditto"
14741 .endtable
14742
14743
14744
14745 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14746 .table2
14747 .row &%header_maxsize%&              "total size of message header"
14748 .row &%header_line_maxsize%&         "individual header line limit"
14749 .row &%message_size_limit%&          "applies to all messages"
14750 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14751 .row &%received_header_text%&        "expanded to make &'Received:'&"
14752 .row &%received_headers_max%&        "for mail loop detection"
14753 .row &%recipients_max%&              "limit per message"
14754 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14755 .endtable
14756
14757
14758
14759
14760 .section "Non-SMTP incoming messages" "SECID111"
14761 .table2
14762 .row &%receive_timeout%&             "for non-SMTP messages"
14763 .endtable
14764
14765
14766
14767
14768
14769 .section "Incoming SMTP messages" "SECID112"
14770 See also the &'Policy controls'& section above.
14771
14772 .table2
14773 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14774 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14775 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14776 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14777 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14778 .row &%dmarc_history_file%&          "DMARC results log"
14779 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14780 .row &%host_lookup%&                 "host name looked up for these hosts"
14781 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14782 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14783 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14784 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14785 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14786 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14787 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14788 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14789 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14790 .row &%smtp_accept_max_per_connection%& "messages per connection"
14791 .row &%smtp_accept_max_per_host%&    "connections from one host"
14792 .row &%smtp_accept_queue%&           "queue mail if more connections"
14793 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14794                                            connection"
14795 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14796 .row &%smtp_active_hostname%&        "host name to use in messages"
14797 .row &%smtp_banner%&                 "text for welcome banner"
14798 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14799 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14800 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14801 .row &%smtp_etrn_command%&           "what to run for ETRN"
14802 .row &%smtp_etrn_serialize%&         "only one at once"
14803 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14804 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14805 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14806 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14807 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14808 .row &%smtp_receive_timeout%&        "per command or data line"
14809 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14810 .row &%smtp_return_error_details%&   "give detail on rejections"
14811 .endtable
14812
14813
14814
14815 .section "SMTP extensions" "SECID113"
14816 .table2
14817 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14818 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14819 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14820 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14821 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14822 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14823 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14824 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14825 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14826 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14827 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14828 .endtable
14829
14830
14831
14832 .section "Processing messages" "SECID114"
14833 .table2
14834 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14835 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14836 .row &%allow_utf8_domains%&          "in addresses"
14837 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14838                                       words""&"
14839 .row &%delivery_date_remove%&        "from incoming messages"
14840 .row &%envelope_to_remove%&          "from incoming messages"
14841 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14842 .row &%headers_charset%&             "default for translations"
14843 .row &%qualify_domain%&              "default for senders"
14844 .row &%qualify_recipient%&           "default for recipients"
14845 .row &%return_path_remove%&          "from incoming messages"
14846 .row &%strip_excess_angle_brackets%& "in addresses"
14847 .row &%strip_trailing_dot%&          "at end of addresses"
14848 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14849 .endtable
14850
14851
14852
14853 .section "System filter" "SECID115"
14854 .table2
14855 .row &%system_filter%&               "locate system filter"
14856 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14857                                             directory"
14858 .row &%system_filter_file_transport%& "transport for delivery to a file"
14859 .row &%system_filter_group%&         "group for filter running"
14860 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14861 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14862 .row &%system_filter_user%&          "user for filter running"
14863 .endtable
14864
14865
14866
14867 .section "Routing and delivery" "SECID116"
14868 .table2
14869 .row &%disable_ipv6%&                "do no IPv6 processing"
14870 .row &%dns_again_means_nonexist%&    "for broken domains"
14871 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14872 .row &%dns_dnssec_ok%&               "parameter for resolver"
14873 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14874 .row &%dns_retrans%&                 "parameter for resolver"
14875 .row &%dns_retry%&                   "parameter for resolver"
14876 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14877 .row &%dns_use_edns0%&               "parameter for resolver"
14878 .row &%hold_domains%&                "hold delivery for these domains"
14879 .row &%local_interfaces%&            "for routing checks"
14880 .row &%queue_domains%&               "no immediate delivery for these"
14881 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
14882 .row &%queue_only%&                  "no immediate delivery at all"
14883 .row &%queue_only_file%&             "no immediate delivery if file exists"
14884 .row &%queue_only_load%&             "no immediate delivery if load is high"
14885 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14886 .row &%queue_only_override%&         "allow command line to override"
14887 .row &%queue_run_in_order%&          "order of arrival"
14888 .row &%queue_run_max%&               "of simultaneous queue runners"
14889 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14890 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14891 .row &%remote_sort_domains%&         "order of remote deliveries"
14892 .row &%retry_data_expire%&           "timeout for retry data"
14893 .row &%retry_interval_max%&          "safety net for retry rules"
14894 .endtable
14895
14896
14897
14898 .section "Bounce and warning messages" "SECID117"
14899 .table2
14900 .row &%bounce_message_file%&         "content of bounce"
14901 .row &%bounce_message_text%&         "content of bounce"
14902 .row &%bounce_return_body%&          "include body if returning message"
14903 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14904 .row &%bounce_return_message%&       "include original message in bounce"
14905 .row &%bounce_return_size_limit%&    "limit on returned message"
14906 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14907 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14908 .row &%errors_copy%&                 "copy bounce messages"
14909 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14910 .row &%delay_warning%&               "time schedule"
14911 .row &%delay_warning_condition%&     "condition for warning messages"
14912 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14913 .row &%smtp_return_error_details%&   "give detail on rejections"
14914 .row &%warn_message_file%&           "content of warning message"
14915 .endtable
14916
14917
14918
14919 .section "Alphabetical list of main options" "SECTalomo"
14920 Those options that undergo string expansion before use are marked with
14921 &dagger;.
14922
14923 .option accept_8bitmime main boolean true
14924 .cindex "8BITMIME"
14925 .cindex "8-bit characters"
14926 .cindex "log" "selectors"
14927 .cindex "log" "8BITMIME"
14928 .cindex "ESMTP extensions" 8BITMIME
14929 This option causes Exim to send 8BITMIME in its response to an SMTP
14930 EHLO command, and to accept the BODY= parameter on MAIL commands.
14931 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14932 takes no steps to do anything special with messages received by this route.
14933
14934 Historically Exim kept this option off by default, but the maintainers
14935 feel that in today's Internet, this causes more problems than it solves.
14936 It now defaults to true.
14937 A more detailed analysis of the issues is provided by Dan Bernstein:
14938 .display
14939 &url(https://cr.yp.to/smtp/8bitmime.html)
14940 .endd
14941
14942 To log received 8BITMIME status use
14943 .code
14944 log_selector = +8bitmime
14945 .endd
14946
14947 .option acl_not_smtp main string&!! unset
14948 .cindex "&ACL;" "for non-SMTP messages"
14949 .cindex "non-SMTP messages" "ACLs for"
14950 This option defines the ACL that is run when a non-SMTP message has been
14951 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14952 further details.
14953
14954 .option acl_not_smtp_mime main string&!! unset
14955 This option defines the ACL that is run for individual MIME parts of non-SMTP
14956 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14957 SMTP messages.
14958
14959 .option acl_not_smtp_start main string&!! unset
14960 .cindex "&ACL;" "at start of non-SMTP message"
14961 .cindex "non-SMTP messages" "ACLs for"
14962 This option defines the ACL that is run before Exim starts reading a
14963 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14964
14965 .option acl_smtp_auth main string&!! unset
14966 .cindex "&ACL;" "setting up for SMTP commands"
14967 .cindex "AUTH" "ACL for"
14968 This option defines the ACL that is run when an SMTP AUTH command is
14969 received. See chapter &<<CHAPACL>>& for further details.
14970
14971 .option acl_smtp_connect main string&!! unset
14972 .cindex "&ACL;" "on SMTP connection"
14973 This option defines the ACL that is run when an SMTP connection is received.
14974 See chapter &<<CHAPACL>>& for further details.
14975
14976 .option acl_smtp_data main string&!! unset
14977 .cindex "DATA" "ACL for"
14978 This option defines the ACL that is run after an SMTP DATA command has been
14979 processed and the message itself has been received, but before the final
14980 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14981
14982 .option acl_smtp_data_prdr main string&!! accept
14983 .cindex "PRDR" "ACL for"
14984 .cindex "DATA" "PRDR ACL for"
14985 .cindex "&ACL;" "PRDR-related"
14986 .cindex "&ACL;" "per-user data processing"
14987 This option defines the ACL that,
14988 if the PRDR feature has been negotiated,
14989 is run for each recipient after an SMTP DATA command has been
14990 processed and the message itself has been received, but before the
14991 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14992
14993 .option acl_smtp_dkim main string&!! unset
14994 .cindex DKIM "ACL for"
14995 This option defines the ACL that is run for each DKIM signature
14996 (by default, or as specified in the dkim_verify_signers option)
14997 of a received message.
14998 See section &<<SECDKIMVFY>>& for further details.
14999
15000 .option acl_smtp_etrn main string&!! unset
15001 .cindex "ETRN" "ACL for"
15002 This option defines the ACL that is run when an SMTP ETRN command is
15003 received. See chapter &<<CHAPACL>>& for further details.
15004
15005 .option acl_smtp_expn main string&!! unset
15006 .cindex "EXPN" "ACL for"
15007 This option defines the ACL that is run when an SMTP EXPN command is
15008 received. See chapter &<<CHAPACL>>& for further details.
15009
15010 .option acl_smtp_helo main string&!! unset
15011 .cindex "EHLO" "ACL for"
15012 .cindex "HELO" "ACL for"
15013 This option defines the ACL that is run when an SMTP EHLO or HELO
15014 command is received. See chapter &<<CHAPACL>>& for further details.
15015
15016
15017 .option acl_smtp_mail main string&!! unset
15018 .cindex "MAIL" "ACL for"
15019 This option defines the ACL that is run when an SMTP MAIL command is
15020 received. See chapter &<<CHAPACL>>& for further details.
15021
15022 .option acl_smtp_mailauth main string&!! unset
15023 .cindex "AUTH" "on MAIL command"
15024 This option defines the ACL that is run when there is an AUTH parameter on
15025 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
15026 &<<CHAPSMTPAUTH>>& for details of authentication.
15027
15028 .option acl_smtp_mime main string&!! unset
15029 .cindex "MIME content scanning" "ACL for"
15030 This option is available when Exim is built with the content-scanning
15031 extension. It defines the ACL that is run for each MIME part in a message. See
15032 section &<<SECTscanmimepart>>& for details.
15033
15034 .option acl_smtp_notquit main string&!! unset
15035 .cindex "not-QUIT, ACL for"
15036 This option defines the ACL that is run when an SMTP session
15037 ends without a QUIT command being received.
15038 See chapter &<<CHAPACL>>& for further details.
15039
15040 .option acl_smtp_predata main string&!! unset
15041 This option defines the ACL that is run when an SMTP DATA command is
15042 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15043 further details.
15044
15045 .option acl_smtp_quit main string&!! unset
15046 .cindex "QUIT, ACL for"
15047 This option defines the ACL that is run when an SMTP QUIT command is
15048 received. See chapter &<<CHAPACL>>& for further details.
15049
15050 .option acl_smtp_rcpt main string&!! unset
15051 .cindex "RCPT" "ACL for"
15052 This option defines the ACL that is run when an SMTP RCPT command is
15053 received. See chapter &<<CHAPACL>>& for further details.
15054
15055 .option acl_smtp_starttls main string&!! unset
15056 .cindex "STARTTLS, ACL for"
15057 This option defines the ACL that is run when an SMTP STARTTLS command is
15058 received. See chapter &<<CHAPACL>>& for further details.
15059
15060 .option acl_smtp_vrfy main string&!! unset
15061 .cindex "VRFY" "ACL for"
15062 This option defines the ACL that is run when an SMTP VRFY command is
15063 received. See chapter &<<CHAPACL>>& for further details.
15064
15065 .option add_environment main "string list" empty
15066 .cindex "environment" "set values"
15067 This option adds individual environment variables that the
15068 currently linked libraries and programs in child processes may use.
15069 Each list element should be of the form &"name=value"&.
15070
15071 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15072
15073 .option admin_groups main "string list&!!" unset
15074 .cindex "admin user"
15075 This option is expanded just once, at the start of Exim's processing. If the
15076 current group or any of the supplementary groups of an Exim caller is in this
15077 colon-separated list, the caller has admin privileges. If all your system
15078 programmers are in a specific group, for example, you can give them all Exim
15079 admin privileges by putting that group in &%admin_groups%&. However, this does
15080 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15081 To permit this, you have to add individuals to the Exim group.
15082
15083 .option allow_domain_literals main boolean false
15084 .cindex "domain literal"
15085 If this option is set, the RFC 2822 domain literal format is permitted in
15086 email addresses. The option is not set by default, because the domain literal
15087 format is not normally required these days, and few people know about it. It
15088 has, however, been exploited by mail abusers.
15089
15090 Unfortunately, it seems that some DNS black list maintainers are using this
15091 format to report black listing to postmasters. If you want to accept messages
15092 addressed to your hosts by IP address, you need to set
15093 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15094 domains (defined in the named domain list &%local_domains%& in the default
15095 configuration). This &"magic string"& matches the domain literal form of all
15096 the local host's IP addresses.
15097
15098 .option allow_mx_to_ip main boolean false
15099 .cindex "MX record" "pointing to IP address"
15100 It appears that more and more DNS zone administrators are breaking the rules
15101 and putting domain names that look like IP addresses on the right hand side of
15102 MX records. Exim follows the rules and rejects this, giving an error message
15103 that explains the misconfiguration. However, some other MTAs support this
15104 practice, so to avoid &"Why can't Exim do this?"& complaints,
15105 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15106 recommended, except when you have no other choice.
15107
15108 .option allow_utf8_domains main boolean false
15109 .cindex "domain" "UTF-8 characters in"
15110 .cindex "UTF-8" "in domain name"
15111 Lots of discussion is going on about internationalized domain names. One
15112 camp is strongly in favour of just using UTF-8 characters, and it seems
15113 that at least two other MTAs permit this.
15114 This option allows Exim users to experiment if they wish.
15115
15116 If it is set true, Exim's domain parsing function allows valid
15117 UTF-8 multicharacters to appear in domain name components, in addition to
15118 letters, digits, and hyphens.
15119
15120 If Exim is built with internationalization support
15121 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15122 this option can be left as default.
15123 Without that,
15124 if you want to look up such domain names in the DNS, you must also
15125 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15126 suitable setting is:
15127 .code
15128 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15129   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15130 .endd
15131 Alternatively, you can just disable this feature by setting
15132 .code
15133 dns_check_names_pattern =
15134 .endd
15135 That is, set the option to an empty string so that no check is done.
15136
15137
15138 .option auth_advertise_hosts main "host list&!!" *
15139 .cindex "authentication" "advertising"
15140 .cindex "AUTH" "advertising"
15141 .cindex "ESMTP extensions" AUTH
15142 If any server authentication mechanisms are configured, Exim advertises them in
15143 response to an EHLO command only if the calling host matches this list.
15144 Otherwise, Exim does not advertise AUTH.
15145 Exim does not accept AUTH commands from clients to which it has not
15146 advertised the availability of AUTH. The advertising of individual
15147 authentication mechanisms can be controlled by the use of the
15148 &%server_advertise_condition%& generic authenticator option on the individual
15149 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15150
15151 Certain mail clients (for example, Netscape) require the user to provide a name
15152 and password for authentication if AUTH is advertised, even though it may
15153 not be needed (the host may accept messages from hosts on its local LAN without
15154 authentication, for example). The &%auth_advertise_hosts%& option can be used
15155 to make these clients more friendly by excluding them from the set of hosts to
15156 which Exim advertises AUTH.
15157
15158 .cindex "AUTH" "advertising when encrypted"
15159 If you want to advertise the availability of AUTH only when the connection
15160 is encrypted using TLS, you can make use of the fact that the value of this
15161 option is expanded, with a setting like this:
15162 .code
15163 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15164 .endd
15165 .vindex "&$tls_in_cipher$&"
15166 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15167 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15168 expansion is *, which matches all hosts.
15169
15170
15171 .option auto_thaw main time 0s
15172 .cindex "thawing messages"
15173 .cindex "unfreezing messages"
15174 If this option is set to a time greater than zero, a queue runner will try a
15175 new delivery attempt on any frozen message, other than a bounce message, if
15176 this much time has passed since it was frozen. This may result in the message
15177 being re-frozen if nothing has changed since the last attempt. It is a way of
15178 saying &"keep on trying, even though there are big problems"&.
15179
15180 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15181 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15182 thought to be very useful any more, and its use should probably be avoided.
15183
15184
15185 .option av_scanner main string "see below"
15186 This option is available if Exim is built with the content-scanning extension.
15187 It specifies which anti-virus scanner to use. The default value is:
15188 .code
15189 sophie:/var/run/sophie
15190 .endd
15191 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15192 before use. See section &<<SECTscanvirus>>& for further details.
15193
15194
15195 .option bi_command main string unset
15196 .oindex "&%-bi%&"
15197 This option supplies the name of a command that is run when Exim is called with
15198 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15199 just the command name, it is not a complete command line. If an argument is
15200 required, it must come from the &%-oA%& command line option.
15201
15202
15203 .option bounce_message_file main string&!! unset
15204 .cindex "bounce message" "customizing"
15205 .cindex "customizing" "bounce message"
15206 This option defines a template file containing paragraphs of text to be used
15207 for constructing bounce messages.  Details of the file's contents are given in
15208 chapter &<<CHAPemsgcust>>&.
15209 .cindex bounce_message_file "tainted data"
15210 The option is expanded to give the file path, which must be
15211 absolute and untainted.
15212 See also &%warn_message_file%&.
15213
15214
15215 .option bounce_message_text main string unset
15216 When this option is set, its contents are included in the default bounce
15217 message immediately after &"This message was created automatically by mail
15218 delivery software."& It is not used if &%bounce_message_file%& is set.
15219
15220 .option bounce_return_body main boolean true
15221 .cindex "bounce message" "including body"
15222 This option controls whether the body of an incoming message is included in a
15223 bounce message when &%bounce_return_message%& is true. The default setting
15224 causes the entire message, both header and body, to be returned (subject to the
15225 value of &%bounce_return_size_limit%&). If this option is false, only the
15226 message header is included. In the case of a non-SMTP message containing an
15227 error that is detected during reception, only those header lines preceding the
15228 point at which the error was detected are returned.
15229 .cindex "bounce message" "including original"
15230
15231 .option bounce_return_linesize_limit main integer 998
15232 .cindex "size" "of bounce lines, limit"
15233 .cindex "bounce message" "line length limit"
15234 .cindex "limit" "bounce message line length"
15235 This option sets a limit in bytes on the line length of messages
15236 that are returned to senders due to delivery problems,
15237 when &%bounce_return_message%& is true.
15238 The default value corresponds to RFC limits.
15239 If the message being returned has lines longer than this value it is
15240 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15241
15242 The option also applies to bounces returned when an error is detected
15243 during reception of a message.
15244 In this case lines from the original are truncated.
15245
15246 The option does not apply to messages generated by an &(autoreply)& transport.
15247
15248
15249 .option bounce_return_message main boolean true
15250 If this option is set false, none of the original message is included in
15251 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15252 &%bounce_return_body%&.
15253
15254
15255 .option bounce_return_size_limit main integer 100K
15256 .cindex "size" "of bounce, limit"
15257 .cindex "bounce message" "size limit"
15258 .cindex "limit" "bounce message size"
15259 This option sets a limit in bytes on the size of messages that are returned to
15260 senders as part of bounce messages when &%bounce_return_message%& is true. The
15261 limit should be less than the value of the global &%message_size_limit%& and of
15262 any &%message_size_limit%& settings on transports, to allow for the bounce text
15263 that Exim generates. If this option is set to zero there is no limit.
15264
15265 When the body of any message that is to be included in a bounce message is
15266 greater than the limit, it is truncated, and a comment pointing this out is
15267 added at the top. The actual cutoff may be greater than the value given, owing
15268 to the use of buffering for transferring the message in chunks (typically 8K in
15269 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15270 messages.
15271
15272 .option bounce_sender_authentication main string unset
15273 .cindex "bounce message" "sender authentication"
15274 .cindex "authentication" "bounce message"
15275 .cindex "AUTH" "on bounce message"
15276 This option provides an authenticated sender address that is sent with any
15277 bounce messages generated by Exim that are sent over an authenticated SMTP
15278 connection. A typical setting might be:
15279 .code
15280 bounce_sender_authentication = mailer-daemon@my.domain.example
15281 .endd
15282 which would cause bounce messages to be sent using the SMTP command:
15283 .code
15284 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15285 .endd
15286 The value of &%bounce_sender_authentication%& must always be a complete email
15287 address.
15288
15289 .option callout_domain_negative_expire main time 3h
15290 .cindex "caching" "callout timeouts"
15291 .cindex "callout" "caching timeouts"
15292 This option specifies the expiry time for negative callout cache data for a
15293 domain. See section &<<SECTcallver>>& for details of callout verification, and
15294 section &<<SECTcallvercache>>& for details of the caching.
15295
15296
15297 .option callout_domain_positive_expire main time 7d
15298 This option specifies the expiry time for positive callout cache data for a
15299 domain. See section &<<SECTcallver>>& for details of callout verification, and
15300 section &<<SECTcallvercache>>& for details of the caching.
15301
15302
15303 .option callout_negative_expire main time 2h
15304 This option specifies the expiry time for negative callout cache data for an
15305 address. See section &<<SECTcallver>>& for details of callout verification, and
15306 section &<<SECTcallvercache>>& for details of the caching.
15307
15308
15309 .option callout_positive_expire main time 24h
15310 This option specifies the expiry time for positive callout cache data for an
15311 address. See section &<<SECTcallver>>& for details of callout verification, and
15312 section &<<SECTcallvercache>>& for details of the caching.
15313
15314
15315 .option callout_random_local_part main string&!! "see below"
15316 This option defines the &"random"& local part that can be used as part of
15317 callout verification. The default value is
15318 .code
15319 $primary_hostname-$tod_epoch-testing
15320 .endd
15321 See section &<<CALLaddparcall>>& for details of how this value is used.
15322
15323
15324 .option check_log_inodes main integer 100
15325 See &%check_spool_space%& below.
15326
15327
15328 .option check_log_space main integer 10M
15329 See &%check_spool_space%& below.
15330
15331 .oindex "&%check_rfc2047_length%&"
15332 .cindex "RFC 2047" "disabling length check"
15333 .option check_rfc2047_length main boolean true
15334 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15335 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15336 word; strings to be encoded that exceed this length are supposed to use
15337 multiple encoded words. By default, Exim does not recognize encoded words that
15338 exceed the maximum length. However, it seems that some software, in violation
15339 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15340 set false, Exim recognizes encoded words of any length.
15341
15342
15343 .option check_spool_inodes main integer 100
15344 See &%check_spool_space%& below.
15345
15346
15347 .option check_spool_space main integer 10M
15348 .cindex "checking disk space"
15349 .cindex "disk space, checking"
15350 .cindex "spool directory" "checking space"
15351 The four &%check_...%& options allow for checking of disk resources before a
15352 message is accepted.
15353
15354 .vindex "&$log_inodes$&"
15355 .vindex "&$log_space$&"
15356 .vindex "&$spool_inodes$&"
15357 .vindex "&$spool_space$&"
15358 When any of these options are nonzero, they apply to all incoming messages. If you
15359 want to apply different checks to different kinds of message, you can do so by
15360 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15361 &$spool_space$& in an ACL with appropriate additional conditions.
15362
15363
15364 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15365 either value is greater than zero, for example:
15366 .code
15367 check_spool_space = 100M
15368 check_spool_inodes = 100
15369 .endd
15370 The spool partition is the one that contains the directory defined by
15371 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15372 transit.
15373
15374 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15375 files are written if either is greater than zero. These should be set only if
15376 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15377
15378 If there is less space or fewer inodes than requested, Exim refuses to accept
15379 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15380 error response to the MAIL command. If ESMTP is in use and there was a
15381 SIZE parameter on the MAIL command, its value is added to the
15382 &%check_spool_space%& value, and the check is performed even if
15383 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15384
15385 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15386 number of kilobytes (though specified in bytes).
15387 If a non-multiple of 1024 is specified, it is rounded up.
15388
15389 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15390 failure a message is written to stderr and Exim exits with a non-zero code, as
15391 it obviously cannot send an error message of any kind.
15392
15393 There is a slight performance penalty for these checks.
15394 Versions of Exim preceding 4.88 had these disabled by default;
15395 high-rate installations confident they will never run out of resources
15396 may wish to deliberately disable them.
15397
15398 .option chunking_advertise_hosts main "host list&!!" *
15399 .cindex CHUNKING advertisement
15400 .cindex "RFC 3030" "CHUNKING"
15401 .cindex "ESMTP extensions" CHUNKING
15402 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15403 these hosts.
15404 Hosts may use the BDAT command as an alternate to DATA.
15405
15406 .option commandline_checks_require_admin main boolean &`false`&
15407 .cindex "restricting access to features"
15408 This option restricts various basic checking features to require an
15409 administrative user.
15410 This affects most of the &%-b*%& options, such as &%-be%&.
15411
15412 .option debug_store main boolean &`false`&
15413 .cindex debugging "memory corruption"
15414 .cindex memory debugging
15415 This option, when true, enables extra checking in Exim's internal memory
15416 management.  For use when a memory corruption issue is being investigated,
15417 it should normally be left as default.
15418
15419 .option daemon_smtp_ports main string &`smtp`&
15420 .cindex "port" "for daemon"
15421 .cindex "TCP/IP" "setting listening ports"
15422 This option specifies one or more default SMTP ports on which the Exim daemon
15423 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15424 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15425
15426 .option daemon_startup_retries main integer 9
15427 .cindex "daemon startup, retrying"
15428 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15429 the daemon at startup when it cannot immediately bind a listening socket
15430 (typically because the socket is already in use): &%daemon_startup_retries%&
15431 defines the number of retries after the first failure, and
15432 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15433
15434 .option daemon_startup_sleep main time 30s
15435 See &%daemon_startup_retries%&.
15436
15437 .option delay_warning main "time list" 24h
15438 .cindex "warning of delay"
15439 .cindex "delay warning, specifying"
15440 .cindex "queue" "delay warning"
15441 When a message is delayed, Exim sends a warning message to the sender at
15442 intervals specified by this option. The data is a colon-separated list of times
15443 after which to send warning messages. If the value of the option is an empty
15444 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15445 message has been in the queue for longer than the last time, the last interval
15446 between the times is used to compute subsequent warning times. For example,
15447 with
15448 .code
15449 delay_warning = 4h:8h:24h
15450 .endd
15451 the first message is sent after 4 hours, the second after 8 hours, and
15452 the third one after 24 hours. After that, messages are sent every 16 hours,
15453 because that is the interval between the last two times on the list. If you set
15454 just one time, it specifies the repeat interval. For example, with:
15455 .code
15456 delay_warning = 6h
15457 .endd
15458 messages are repeated every six hours. To stop warnings after a given time, set
15459 a very large time at the end of the list. For example:
15460 .code
15461 delay_warning = 2h:12h:99d
15462 .endd
15463 Note that the option is only evaluated at the time a delivery attempt fails,
15464 which depends on retry and queue-runner configuration.
15465 Typically retries will be configured more frequently than warning messages.
15466
15467 .option delay_warning_condition main string&!! "see below"
15468 .vindex "&$domain$&"
15469 The string is expanded at the time a warning message might be sent. If all the
15470 deferred addresses have the same domain, it is set in &$domain$& during the
15471 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15472 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15473 &"false"& (the comparison being done caselessly) then the warning message is
15474 not sent. The default is:
15475 .code
15476 delay_warning_condition = ${if or {\
15477   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15478   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15479   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15480   } {no}{yes}}
15481 .endd
15482 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15483 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15484 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15485 &"auto-replied"& in an &'Auto-Submitted:'& header.
15486
15487 .option deliver_drop_privilege main boolean false
15488 .cindex "unprivileged delivery"
15489 .cindex "delivery" "unprivileged"
15490 If this option is set true, Exim drops its root privilege at the start of a
15491 delivery process, and runs as the Exim user throughout. This severely restricts
15492 the kinds of local delivery that are possible, but is viable in certain types
15493 of configuration. There is a discussion about the use of root privilege in
15494 chapter &<<CHAPsecurity>>&.
15495
15496 .option deliver_queue_load_max main fixed-point unset
15497 .cindex "load average"
15498 .cindex "queue runner" "abandoning"
15499 When this option is set, a queue run is abandoned if the system load average
15500 becomes greater than the value of the option. The option has no effect on
15501 ancient operating systems on which Exim cannot determine the load average.
15502 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15503
15504
15505 .option delivery_date_remove main boolean true
15506 .cindex "&'Delivery-date:'& header line"
15507 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15508 message when it is delivered, in exactly the same way as &'Return-path:'& is
15509 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15510 should not be present in incoming messages, and this option causes them to be
15511 removed at the time the message is received, to avoid any problems that might
15512 occur when a delivered message is subsequently sent on to some other recipient.
15513
15514 .option disable_fsync main boolean false
15515 .cindex "&[fsync()]&, disabling"
15516 This option is available only if Exim was built with the compile-time option
15517 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15518 a runtime configuration generates an &"unknown option"& error. You should not
15519 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15520 really, really, really understand what you are doing. &'No pre-compiled
15521 distributions of Exim should ever make this option available.'&
15522
15523 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15524 updated files' data to be written to disc before continuing. Unexpected events
15525 such as crashes and power outages may cause data to be lost or scrambled.
15526 Here be Dragons. &*Beware.*&
15527
15528
15529 .option disable_ipv6 main boolean false
15530 .cindex "IPv6" "disabling"
15531 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15532 activities take place. AAAA records are never looked up, and any IPv6 addresses
15533 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15534 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15535 to handle IPv6 literal addresses.
15536
15537
15538 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15539 .cindex DKIM "selecting signature algorithms"
15540 This option gives a list of hash types which are acceptable in signatures,
15541 and an order of processing.
15542 Signatures with algorithms not in the list will be ignored.
15543
15544 Acceptable values include:
15545 .code
15546 sha1
15547 sha256
15548 sha512
15549 .endd
15550
15551 Note that the acceptance of sha1 violates RFC 8301.
15552
15553 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15554 This option gives a list of key types which are acceptable in signatures,
15555 and an order of processing.
15556 Signatures with algorithms not in the list will be ignored.
15557
15558
15559 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15560 This option gives a list of key sizes which are acceptable in signatures.
15561 The list is keyed by the algorithm type for the key; the values are in bits.
15562 Signatures with keys smaller than given by this option will fail verification.
15563
15564 The default enforces the RFC 8301 minimum key size for RSA signatures.
15565
15566 .option dkim_verify_minimal main boolean false
15567 If set to true, verification of signatures will terminate after the
15568 first success.
15569
15570 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15571 .cindex DKIM "controlling calls to the ACL"
15572 This option gives a list of DKIM domains for which the DKIM ACL is run.
15573 It is expanded after the message is received; by default it runs
15574 the ACL once for each signature in the message.
15575 See section &<<SECDKIMVFY>>&.
15576
15577
15578 .option dmarc_forensic_sender main string&!! unset
15579 .option dmarc_history_file main string unset
15580 .option dmarc_tld_file main string unset
15581 .cindex DMARC "main section options"
15582 These options control DMARC processing.
15583 See section &<<SECDMARC>>& for details.
15584
15585
15586 .option dns_again_means_nonexist main "domain list&!!" unset
15587 .cindex "DNS" "&""try again""& response; overriding"
15588 DNS lookups give a &"try again"& response for the DNS errors
15589 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15590 keep trying to deliver a message, or to give repeated temporary errors to
15591 incoming mail. Sometimes the effect is caused by a badly set up name server and
15592 may persist for a long time. If a domain which exhibits this problem matches
15593 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15594 This option should be used with care. You can make it apply to reverse lookups
15595 by a setting such as this:
15596 .code
15597 dns_again_means_nonexist = *.in-addr.arpa
15598 .endd
15599 This option applies to all DNS lookups that Exim does. It also applies when the
15600 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15601 since these are most likely to be caused by DNS lookup problems. The
15602 &(dnslookup)& router has some options of its own for controlling what happens
15603 when lookups for MX or SRV records give temporary errors. These more specific
15604 options are applied after this global option.
15605
15606 .option dns_check_names_pattern main string "see below"
15607 .cindex "DNS" "pre-check of name syntax"
15608 When this option is set to a non-empty string, it causes Exim to check domain
15609 names for characters that are not allowed in host names before handing them to
15610 the DNS resolver, because some resolvers give temporary errors for names that
15611 contain unusual characters. If a domain name contains any unwanted characters,
15612 a &"not found"& result is forced, and the resolver is not called. The check is
15613 done by matching the domain name against a regular expression, which is the
15614 value of this option. The default pattern is
15615 .code
15616 dns_check_names_pattern = \
15617   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15618 .endd
15619 which permits only letters, digits, slashes, and hyphens in components, but
15620 they must start and end with a letter or digit. Slashes are not, in fact,
15621 permitted in host names, but they are found in certain NS records (which can be
15622 accessed in Exim by using a &%dnsdb%& lookup). If you set
15623 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15624 empty string.
15625
15626 .option dns_csa_search_limit main integer 5
15627 This option controls the depth of parental searching for CSA SRV records in the
15628 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15629
15630 .option dns_csa_use_reverse main boolean true
15631 This option controls whether or not an IP address, given as a CSA domain, is
15632 reversed and looked up in the reverse DNS, as described in more detail in
15633 section &<<SECTverifyCSA>>&.
15634
15635 .option dns_cname_loops main integer 1
15636 .cindex DNS "CNAME following"
15637 This option controls the following of CNAME chains, needed if the resolver does
15638 not do it internally.
15639 As of 2018 most should, and the default can be left.
15640 If you have an ancient one, a value of 10 is likely needed.
15641
15642 The default value of one CNAME-follow is needed
15643 thanks to the observed return for an MX request,
15644 given no MX presence but a CNAME to an A, of the CNAME.
15645
15646
15647 .option dns_dnssec_ok main integer -1
15648 .cindex "DNS" "resolver options"
15649 .cindex "DNS" "DNSSEC"
15650 If this option is set to a non-negative number then Exim will initialise the
15651 DNS resolver library to either use or not use DNSSEC, overriding the system
15652 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15653
15654 If the resolver library does not support DNSSEC then this option has no effect.
15655
15656 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15657 will default to stripping out a successful validation status.
15658 This will break a previously working Exim installation.
15659 Provided that you do trust the resolver (ie, is on localhost) you can tell
15660 glibc to pass through any successful validation with a new option in
15661 &_/etc/resolv.conf_&:
15662 .code
15663 options trust-ad
15664 .endd
15665
15666
15667 .option dns_ipv4_lookup main "domain list&!!" unset
15668 .cindex "IPv6" "DNS lookup for AAAA records"
15669 .cindex "DNS" "IPv6 lookup for AAAA records"
15670 .cindex DNS "IPv6 disabling"
15671 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15672 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15673 (A records) when trying to find IP addresses for hosts, unless the host's
15674 domain matches this list.
15675
15676 This is a fudge to help with name servers that give big delays or otherwise do
15677 not work for the AAAA record type. In due course, when the world's name
15678 servers have all been upgraded, there should be no need for this option.
15679 Note that all lookups, including those done for verification, are affected;
15680 this will result in verify failure for IPv6 connections or ones using names
15681 only valid for IPv6 addresses.
15682
15683
15684 .option dns_retrans main time 0s
15685 .cindex "DNS" "resolver options"
15686 .cindex timeout "dns lookup"
15687 .cindex "DNS" timeout
15688 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15689 retransmission and retry parameters for DNS lookups. Values of zero (the
15690 defaults) leave the system default settings unchanged. The first value is the
15691 time between retries, and the second is the number of retries. It isn't
15692 totally clear exactly how these settings affect the total time a DNS lookup may
15693 take. I haven't found any documentation about timeouts on DNS lookups; these
15694 parameter values are available in the external resolver interface structure,
15695 but nowhere does it seem to describe how they are used or what you might want
15696 to set in them.
15697 See also the &%slow_lookup_log%& option.
15698
15699
15700 .option dns_retry main integer 0
15701 See &%dns_retrans%& above.
15702
15703
15704 .option dns_trust_aa main "domain list&!!" unset
15705 .cindex "DNS" "resolver options"
15706 .cindex "DNS" "DNSSEC"
15707 If this option is set then lookup results marked with the AA bit
15708 (Authoritative Answer) are trusted the same way as if they were
15709 DNSSEC-verified. The authority section's name of the answer must
15710 match with this expanded domain list.
15711
15712 Use this option only if you talk directly to a resolver that is
15713 authoritative for some zones and does not set the AD (Authentic Data)
15714 bit in the answer. Some DNS servers may have an configuration option to
15715 mark the answers from their own zones as verified (they set the AD bit).
15716 Others do not have this option. It is considered as poor practice using
15717 a resolver that is an authoritative server for some zones.
15718
15719 Use this option only if you really have to (e.g. if you want
15720 to use DANE for remote delivery to a server that is listed in the DNS
15721 zones that your resolver is authoritative for).
15722
15723 If the DNS answer packet has the AA bit set and contains resource record
15724 in the answer section, the name of the first NS record appearing in the
15725 authority section is compared against the list. If the answer packet is
15726 authoritative but the answer section is empty, the name of the first SOA
15727 record in the authoritative section is used instead.
15728
15729 .cindex "DNS" "resolver options"
15730 .option dns_use_edns0 main integer -1
15731 .cindex "DNS" "resolver options"
15732 .cindex "DNS" "EDNS0"
15733 .cindex "DNS" "OpenBSD
15734 If this option is set to a non-negative number then Exim will initialise the
15735 DNS resolver library to either use or not use EDNS0 extensions, overriding
15736 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15737 on.
15738
15739 If the resolver library does not support EDNS0 then this option has no effect.
15740
15741 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15742 means that DNSSEC will not work with Exim on that platform either, unless Exim
15743 is linked against an alternative DNS client library.
15744
15745
15746 .option drop_cr main boolean false
15747 This is an obsolete option that is now a no-op. It used to affect the way Exim
15748 handled CR and LF characters in incoming messages. What happens now is
15749 described in section &<<SECTlineendings>>&.
15750
15751 .option dsn_advertise_hosts main "host list&!!" unset
15752 .cindex "bounce messages" "success"
15753 .cindex "DSN" "success"
15754 .cindex "Delivery Status Notification" "success"
15755 .cindex "ESMTP extensions" DSN
15756 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15757 and accepted from, these hosts.
15758 Hosts may use the NOTIFY and ORCPT options on RCPT TO commands,
15759 and RET and ENVID options on MAIL FROM commands.
15760 A NOTIFY=SUCCESS option requests success-DSN messages.
15761 A NOTIFY= option with no argument requests that no delay or failure DSNs
15762 are sent.
15763 &*Note*&: Supplying success-DSN messages has been criticised
15764 on privacy grounds; it can leak details of internal forwarding.
15765
15766 .option dsn_from main "string&!!" "see below"
15767 .cindex "&'From:'& header line" "in bounces"
15768 .cindex "bounce messages" "&'From:'& line, specifying"
15769 This option can be used to vary the contents of &'From:'& header lines in
15770 bounces and other automatically generated messages (&"Delivery Status
15771 Notifications"& &-- hence the name of the option). The default setting is:
15772 .code
15773 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15774 .endd
15775 The value is expanded every time it is needed. If the expansion fails, a
15776 panic is logged, and the default value is used.
15777
15778 .option envelope_to_remove main boolean true
15779 .cindex "&'Envelope-to:'& header line"
15780 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15781 message when it is delivered, in exactly the same way as &'Return-path:'& is
15782 handled. &'Envelope-to:'& records the original recipient address from the
15783 message's envelope that caused the delivery to happen. Such headers should not
15784 be present in incoming messages, and this option causes them to be removed at
15785 the time the message is received, to avoid any problems that might occur when a
15786 delivered message is subsequently sent on to some other recipient.
15787
15788
15789 .option errors_copy main "string list&!!" unset
15790 .cindex "bounce message" "copy to other address"
15791 .cindex "copy of bounce message"
15792 Setting this option causes Exim to send bcc copies of bounce messages that it
15793 generates to other addresses. &*Note*&: This does not apply to bounce messages
15794 coming from elsewhere. The value of the option is a colon-separated list of
15795 items. Each item consists of a pattern, terminated by white space, followed by
15796 a comma-separated list of email addresses. If a pattern contains spaces, it
15797 must be enclosed in double quotes.
15798
15799 Each pattern is processed in the same way as a single item in an address list
15800 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15801 the bounce message, the message is copied to the addresses on the list. The
15802 items are scanned in order, and once a matching one is found, no further items
15803 are examined. For example:
15804 .code
15805 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15806               rqps@mydomain   hostmaster@mydomain.example,\
15807                               postmaster@mydomain.example
15808 .endd
15809 .vindex "&$domain$&"
15810 .vindex "&$local_part$&"
15811 The address list is expanded before use. The expansion variables &$local_part$&
15812 and &$domain$& are set from the original recipient of the error message, and if
15813 there was any wildcard matching in the pattern, the expansion
15814 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15815 variables &$0$&, &$1$&, etc. are set in the normal way.
15816
15817
15818 .option errors_reply_to main string unset
15819 .cindex "bounce message" "&'Reply-to:'& in"
15820 By default, Exim's bounce and delivery warning messages contain the header line
15821 .display
15822 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15823 .endd
15824 .oindex &%quota_warn_message%&
15825 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15826 A warning message that is generated by the &%quota_warn_message%& option in an
15827 &(appendfile)& transport may contain its own &'From:'& header line that
15828 overrides the default.
15829
15830 Experience shows that people reply to bounce messages. If the
15831 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15832 and warning messages. For example:
15833 .code
15834 errors_reply_to = postmaster@my.domain.example
15835 .endd
15836 The value of the option is not expanded. It must specify a valid RFC 2822
15837 address. However, if a warning message that is generated by the
15838 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15839 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15840 not used.
15841
15842
15843 .option event_action main string&!! unset
15844 .cindex events
15845 This option declares a string to be expanded for Exim's events mechanism.
15846 For details see chapter &<<CHAPevents>>&.
15847
15848
15849 .option exim_group main string "compile-time configured"
15850 .cindex "gid (group id)" "Exim's own"
15851 .cindex "Exim group"
15852 This option changes the gid under which Exim runs when it gives up root
15853 privilege. The default value is compiled into the binary. The value of this
15854 option is used only when &%exim_user%& is also set. Unless it consists entirely
15855 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15856 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15857 security issues.
15858
15859
15860 .option exim_path main string "see below"
15861 .cindex "Exim binary, path name"
15862 This option specifies the path name of the Exim binary, which is used when Exim
15863 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15864 the directory configured at compile time by the BIN_DIRECTORY setting. It
15865 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15866 other place.
15867 &*Warning*&: Do not use a macro to define the value of this option, because
15868 you will break those Exim utilities that scan the configuration file to find
15869 where the binary is. (They then use the &%-bP%& option to extract option
15870 settings such as the value of &%spool_directory%&.)
15871
15872
15873 .option exim_user main string "compile-time configured"
15874 .cindex "uid (user id)" "Exim's own"
15875 .cindex "Exim user"
15876 This option changes the uid under which Exim runs when it gives up root
15877 privilege. The default value is compiled into the binary. Ownership of the run
15878 time configuration file and the use of the &%-C%& and &%-D%& command line
15879 options is checked against the values in the binary, not what is set here.
15880
15881 Unless it consists entirely of digits, the string is looked up using
15882 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15883 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15884 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15885
15886
15887 .option exim_version main string "current version"
15888 .cindex "Exim version"
15889 .cindex customizing "version number"
15890 .cindex "version number of Exim" override
15891 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15892 various places.  Use with care; this may fool stupid security scanners.
15893
15894
15895 .option extra_local_interfaces main "string list" unset
15896 This option defines network interfaces that are to be considered local when
15897 routing, but which are not used for listening by the daemon. See section
15898 &<<SECTreclocipadd>>& for details.
15899
15900
15901 . Allow this long option name to split; give it unsplit as a fifth argument
15902 . for the automatic .oindex that is generated by .option.
15903
15904 .option "extract_addresses_remove_arguments" main boolean true &&&
15905          extract_addresses_remove_arguments
15906 .oindex "&%-t%&"
15907 .cindex "command line" "addresses with &%-t%&"
15908 .cindex "Sendmail compatibility" "&%-t%& option"
15909 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15910 are present on the command line when the &%-t%& option is used to build an
15911 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15912 line addresses are removed from the recipients list. This is also how Smail
15913 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15914 command line addresses are added to those obtained from the header lines. When
15915 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15916 argument headers. If it is set false, Exim adds rather than removes argument
15917 addresses.
15918
15919
15920 .option finduser_retries main integer 0
15921 .cindex "NIS, retrying user lookups"
15922 On systems running NIS or other schemes in which user and group information is
15923 distributed from a remote system, there can be times when &[getpwnam()]& and
15924 related functions fail, even when given valid data, because things time out.
15925 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15926 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15927 many extra times to find a user or a group, waiting for one second between
15928 retries.
15929
15930 .cindex "&_/etc/passwd_&" "multiple reading of"
15931 You should not set this option greater than zero if your user information is in
15932 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15933 search the file multiple times for non-existent users, and also cause delay.
15934
15935
15936
15937 .option freeze_tell main "string list, comma separated" unset
15938 .cindex "freezing messages" "sending a message when freezing"
15939 On encountering certain errors, or when configured to do so in a system filter,
15940 ACL, or special router, Exim freezes a message. This means that no further
15941 delivery attempts take place until an administrator thaws the message, or the
15942 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15943 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15944 warning message whenever it freezes something, unless the message it is
15945 freezing is a locally-generated bounce message. (Without this exception there
15946 is the possibility of looping.) The warning message is sent to the addresses
15947 supplied as the comma-separated value of this option. If several of the
15948 message's addresses cause freezing, only a single message is sent. If the
15949 freezing was automatic, the reason(s) for freezing can be found in the message
15950 log. If you configure freezing in a filter or ACL, you must arrange for any
15951 logging that you require.
15952
15953
15954 .option gecos_name main string&!! unset
15955 .cindex "HP-UX"
15956 .cindex "&""gecos""& field, parsing"
15957 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15958 password file to hold other information in addition to users' real names. Exim
15959 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15960 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15961 of the field are used unchanged, except that, if an ampersand is encountered,
15962 it is replaced by the user's login name with the first character forced to
15963 upper case, since this is a convention that is observed on many systems.
15964
15965 When these options are set, &%gecos_pattern%& is treated as a regular
15966 expression that is to be applied to the field (again with && replaced by the
15967 login name), and if it matches, &%gecos_name%& is expanded and used as the
15968 user's name.
15969
15970 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15971 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15972 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15973 name terminates at the first comma, the following can be used:
15974 .code
15975 gecos_pattern = ([^,]*)
15976 gecos_name = $1
15977 .endd
15978
15979 .option gecos_pattern main string unset
15980 See &%gecos_name%& above.
15981
15982
15983 .option gnutls_compat_mode main boolean unset
15984 This option controls whether GnuTLS is used in compatibility mode in an Exim
15985 server. This reduces security slightly, but improves interworking with older
15986 implementations of TLS.
15987
15988
15989 .option gnutls_allow_auto_pkcs11 main boolean unset
15990 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15991 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15992
15993 See
15994 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15995 for documentation.
15996
15997
15998
15999 .option headers_charset main string "see below"
16000 This option sets a default character set for translating from encoded MIME
16001 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16002 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16003 ultimate default is ISO-8859-1. For more details see the description of header
16004 insertions in section &<<SECTexpansionitems>>&.
16005
16006
16007
16008 .option header_maxsize main integer "see below"
16009 .cindex "header section" "maximum size of"
16010 .cindex "limit" "size of message header section"
16011 This option controls the overall maximum size of a message's header
16012 section. The default is the value of HEADER_MAXSIZE in
16013 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16014 sections are rejected.
16015
16016
16017 .option header_line_maxsize main integer 0
16018 .cindex "header lines" "maximum size of"
16019 .cindex "limit" "size of one header line"
16020 This option limits the length of any individual header line in a message, after
16021 all the continuations have been joined together. Messages with individual
16022 header lines that are longer than the limit are rejected. The default value of
16023 zero means &"no limit"&.
16024
16025
16026
16027
16028 .option helo_accept_junk_hosts main "host list&!!" unset
16029 .cindex "HELO" "accepting junk data"
16030 .cindex "EHLO" "accepting junk data"
16031 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16032 mail, and gives an error response for invalid data. Unfortunately, there are
16033 some SMTP clients that send syntactic junk. They can be accommodated by setting
16034 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16035 if you want to do semantic checking.
16036 See also &%helo_allow_chars%& for a way of extending the permitted character
16037 set.
16038
16039
16040 .option helo_allow_chars main string unset
16041 .cindex "HELO" "underscores in"
16042 .cindex "EHLO" "underscores in"
16043 .cindex "underscore in EHLO/HELO"
16044 This option can be set to a string of rogue characters that are permitted in
16045 all EHLO and HELO names in addition to the standard letters, digits,
16046 hyphens, and dots. If you really must allow underscores, you can set
16047 .code
16048 helo_allow_chars = _
16049 .endd
16050 Note that the value is one string, not a list.
16051
16052
16053 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16054 .cindex "HELO" "forcing reverse lookup"
16055 .cindex "EHLO" "forcing reverse lookup"
16056 If the domain given by a client in a HELO or EHLO command matches this
16057 list, a reverse lookup is done in order to establish the host's true name. The
16058 default forces a lookup if the client host gives the server's name or any of
16059 its IP addresses (in brackets), something that broken clients have been seen to
16060 do.
16061
16062
16063 .option helo_try_verify_hosts main "host list&!!" unset
16064 .cindex "HELO verifying" "optional"
16065 .cindex "EHLO" "verifying, optional"
16066 By default, Exim just checks the syntax of HELO and EHLO commands (see
16067 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16068 to do more extensive checking of the data supplied by these commands. The ACL
16069 condition &`verify = helo`& is provided to make this possible.
16070 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16071 to force the check to occur. From release 4.53 onwards, this is no longer
16072 necessary. If the check has not been done before &`verify = helo`& is
16073 encountered, it is done at that time. Consequently, this option is obsolete.
16074 Its specification is retained here for backwards compatibility.
16075
16076 When an EHLO or HELO command is received, if the calling host matches
16077 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16078 EHLO command either:
16079
16080 .ilist
16081 is an IP literal matching the calling address of the host, or
16082 .next
16083 .cindex "DNS" "reverse lookup"
16084 .cindex "reverse DNS lookup"
16085 matches the host name that Exim obtains by doing a reverse lookup of the
16086 calling host address, or
16087 .next
16088 when looked up in DNS yields the calling host address.
16089 .endlist
16090
16091 However, the EHLO or HELO command is not rejected if any of the checks
16092 fail. Processing continues, but the result of the check is remembered, and can
16093 be detected later in an ACL by the &`verify = helo`& condition.
16094
16095 If DNS was used for successful verification, the variable
16096 .cindex "DNS" "DNSSEC"
16097 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16098
16099 .option helo_verify_hosts main "host list&!!" unset
16100 .cindex "HELO verifying" "mandatory"
16101 .cindex "EHLO" "verifying, mandatory"
16102 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16103 backwards compatibility. For hosts that match this option, Exim checks the host
16104 name given in the HELO or EHLO in the same way as for
16105 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16106 rejected with a 550 error, and entries are written to the main and reject logs.
16107 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16108 error.
16109
16110 .option hold_domains main "domain list&!!" unset
16111 .cindex "domain" "delaying delivery"
16112 .cindex "delivery" "delaying certain domains"
16113 This option allows mail for particular domains to be held in the queue
16114 manually. The option is overridden if a message delivery is forced with the
16115 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16116 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16117 item in &%hold_domains%&, no routing or delivery for that address is done, and
16118 it is deferred every time the message is looked at.
16119
16120 This option is intended as a temporary operational measure for delaying the
16121 delivery of mail while some problem is being sorted out, or some new
16122 configuration tested. If you just want to delay the processing of some
16123 domains until a queue run occurs, you should use &%queue_domains%& or
16124 &%queue_smtp_domains%&, not &%hold_domains%&.
16125
16126 A setting of &%hold_domains%& does not override Exim's code for removing
16127 messages from the queue if they have been there longer than the longest retry
16128 time in any retry rule. If you want to hold messages for longer than the normal
16129 retry times, insert a dummy retry rule with a long retry time.
16130
16131
16132 .option host_lookup main "host list&!!" unset
16133 .cindex "host name" "lookup, forcing"
16134 Exim does not look up the name of a calling host from its IP address unless it
16135 is required to compare against some host list, or the host matches
16136 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16137 option (which normally contains IP addresses rather than host names). The
16138 default configuration file contains
16139 .code
16140 host_lookup = *
16141 .endd
16142 which causes a lookup to happen for all hosts. If the expense of these lookups
16143 is felt to be too great, the setting can be changed or removed.
16144
16145 After a successful reverse lookup, Exim does a forward lookup on the name it
16146 has obtained, to verify that it yields the IP address that it started with. If
16147 this check fails, Exim behaves as if the name lookup failed.
16148
16149 .vindex "&$host_lookup_failed$&"
16150 .vindex "&$sender_host_name$&"
16151 After any kind of failure, the host name (in &$sender_host_name$&) remains
16152 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16153 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16154 &`verify = reverse_host_lookup`& in ACLs.
16155
16156
16157 .option host_lookup_order main "string list" &`bydns:byaddr`&
16158 This option specifies the order of different lookup methods when Exim is trying
16159 to find a host name from an IP address. The default is to do a DNS lookup
16160 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16161 if that fails. You can change the order of these lookups, or omit one entirely,
16162 if you want.
16163
16164 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16165 multiple PTR records in the DNS and the IP address is not listed in
16166 &_/etc/hosts_&. Different operating systems give different results in this
16167 case. That is why the default tries a DNS lookup first.
16168
16169
16170
16171 .option host_reject_connection main "host list&!!" unset
16172 .cindex "host" "rejecting connections from"
16173 If this option is set, incoming SMTP calls from the hosts listed are rejected
16174 as soon as the connection is made.
16175 This option is obsolete, and retained only for backward compatibility, because
16176 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16177 connections immediately.
16178
16179 The ability to give an immediate rejection (either by this option or using an
16180 ACL) is provided for use in unusual cases. Many hosts will just try again,
16181 sometimes without much delay. Normally, it is better to use an ACL to reject
16182 incoming messages at a later stage, such as after RCPT commands. See
16183 chapter &<<CHAPACL>>&.
16184
16185
16186 .option hosts_connection_nolog main "host list&!!" unset
16187 .cindex "host" "not logging connections from"
16188 This option defines a list of hosts for which connection logging does not
16189 happen, even though the &%smtp_connection%& log selector is set. For example,
16190 you might want not to log SMTP connections from local processes, or from
16191 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16192 the daemon; you should therefore strive to restrict its value to a short inline
16193 list of IP addresses and networks. To disable logging SMTP connections from
16194 local processes, you must create a host list with an empty item. For example:
16195 .code
16196 hosts_connection_nolog = :
16197 .endd
16198 .new
16199 The hosts affected by this option also do not log "no MAIL in SMTP connection"
16200 lines, as may commonly be produced by a monitoring system.
16201 .wen
16202
16203
16204 .option hosts_require_alpn main "host list&!!" unset
16205 .cindex ALPN "require negotiation in server"
16206 .cindex TLS ALPN
16207 .cindex TLS "Application Layer Protocol Names"
16208 If the TLS library supports ALPN
16209 then a successful negotiation of ALPN will be required for any client
16210 matching the list, for TLS to be used.
16211 See also the &%tls_alpn%& option.
16212
16213 &*Note*&: prevention of fallback to in-clear connection is not
16214 managed by this option, and should be done separately.
16215
16216
16217 .option hosts_require_helo main "host list&!!" *
16218 .cindex "HELO/EHLO" requiring
16219 Exim will require an accepted HELO or EHLO command from a host matching
16220 this list, before accepting a MAIL command.
16221
16222
16223 .option hosts_proxy main "host list&!!" unset
16224 .cindex proxy "proxy protocol"
16225 This option enables use of Proxy Protocol proxies for incoming
16226 connections.  For details see section &<<SECTproxyInbound>>&.
16227
16228
16229 .option hosts_treat_as_local main "domain list&!!" unset
16230 .cindex "local host" "domains treated as"
16231 .cindex "host" "treated as local"
16232 If this option is set, any host names that match the domain list are treated as
16233 if they were the local host when Exim is scanning host lists obtained from MX
16234 records
16235 or other sources. Note that the value of this option is a domain list, not a
16236 host list, because it is always used to check host names, not IP addresses.
16237
16238 This option also applies when Exim is matching the special items
16239 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16240 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16241 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16242 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16243 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16244 interfaces and recognizing the local host.
16245
16246
16247 .option ibase_servers main "string list" unset
16248 .cindex "InterBase" "server list"
16249 This option provides a list of InterBase servers and associated connection data,
16250 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16251 The option is available only if Exim has been built with InterBase support.
16252
16253
16254
16255 .option ignore_bounce_errors_after main time 10w
16256 .cindex "bounce message" "discarding"
16257 .cindex "discarding bounce message"
16258 This option affects the processing of bounce messages that cannot be delivered,
16259 that is, those that suffer a permanent delivery failure. (Bounce messages that
16260 suffer temporary delivery failures are of course retried in the usual way.)
16261
16262 After a permanent delivery failure, bounce messages are frozen,
16263 because there is no sender to whom they can be returned. When a frozen bounce
16264 message has been in the queue for more than the given time, it is unfrozen at
16265 the next queue run, and a further delivery is attempted. If delivery fails
16266 again, the bounce message is discarded. This makes it possible to keep failed
16267 bounce messages around for a shorter time than the normal maximum retry time
16268 for frozen messages. For example,
16269 .code
16270 ignore_bounce_errors_after = 12h
16271 .endd
16272 retries failed bounce message deliveries after 12 hours, discarding any further
16273 failures. If the value of this option is set to a zero time period, bounce
16274 failures are discarded immediately. Setting a very long time (as in the default
16275 value) has the effect of disabling this option. For ways of automatically
16276 dealing with other kinds of frozen message, see &%auto_thaw%& and
16277 &%timeout_frozen_after%&.
16278
16279
16280 .option ignore_fromline_hosts main "host list&!!" unset
16281 .cindex "&""From""& line"
16282 .cindex "UUCP" "&""From""& line"
16283 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16284 the headers of a message. By default this is treated as the start of the
16285 message's body, which means that any following headers are not recognized as
16286 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16287 match those hosts that insist on sending it. If the sender is actually a local
16288 process rather than a remote host, and is using &%-bs%& to inject the messages,
16289 &%ignore_fromline_local%& must be set to achieve this effect.
16290
16291
16292 .option ignore_fromline_local main boolean false
16293 See &%ignore_fromline_hosts%& above.
16294
16295 .option keep_environment main "string list" unset
16296 .cindex "environment" "values from"
16297 This option contains a string list of environment variables to keep.
16298 You have to trust these variables or you have to be sure that
16299 these variables do not impose any security risk. Keep in mind that
16300 during the startup phase Exim is running with an effective UID 0 in most
16301 installations. As the default value is an empty list, the default
16302 environment for using libraries, running embedded Perl code, or running
16303 external binaries is empty, and does not not even contain PATH or HOME.
16304
16305 Actually the list is interpreted as a list of patterns
16306 (&<<SECTlistexpand>>&), except that it is not expanded first.
16307
16308 WARNING: Macro substitution is still done first, so having a macro
16309 FOO and having FOO_HOME in your &%keep_environment%& option may have
16310 unexpected results. You may work around this using a regular expression
16311 that does not match the macro name: ^[F]OO_HOME$.
16312
16313 Current versions of Exim issue a warning during startup if you do not mention
16314 &%keep_environment%& in your runtime configuration file and if your
16315 current environment is not empty. Future versions may not issue that warning
16316 anymore.
16317
16318 See the &%add_environment%& main config option for a way to set
16319 environment variables to a fixed value.  The environment for &(pipe)&
16320 transports is handled separately, see section &<<SECTpipeenv>>& for
16321 details.
16322
16323
16324 .option keep_malformed main time 4d
16325 This option specifies the length of time to keep messages whose spool files
16326 have been corrupted in some way. This should, of course, never happen. At the
16327 next attempt to deliver such a message, it gets removed. The incident is
16328 logged.
16329
16330
16331 .option ldap_ca_cert_dir main string unset
16332 .cindex "LDAP", "TLS CA certificate directory"
16333 .cindex certificate "directory for LDAP"
16334 This option indicates which directory contains CA certificates for verifying
16335 a TLS certificate presented by an LDAP server.
16336 While Exim does not provide a default value, your SSL library may.
16337 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16338 and constrained to be a directory.
16339
16340
16341 .option ldap_ca_cert_file main string unset
16342 .cindex "LDAP", "TLS CA certificate file"
16343 .cindex certificate "file for LDAP"
16344 This option indicates which file contains CA certificates for verifying
16345 a TLS certificate presented by an LDAP server.
16346 While Exim does not provide a default value, your SSL library may.
16347 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16348 and constrained to be a file.
16349
16350
16351 .option ldap_cert_file main string unset
16352 .cindex "LDAP" "TLS client certificate file"
16353 .cindex certificate "file for LDAP"
16354 This option indicates which file contains an TLS client certificate which
16355 Exim should present to the LDAP server during TLS negotiation.
16356 Should be used together with &%ldap_cert_key%&.
16357
16358
16359 .option ldap_cert_key main string unset
16360 .cindex "LDAP" "TLS client key file"
16361 .cindex certificate "key for LDAP"
16362 This option indicates which file contains the secret/private key to use
16363 to prove identity to the LDAP server during TLS negotiation.
16364 Should be used together with &%ldap_cert_file%&, which contains the
16365 identity to be proven.
16366
16367
16368 .option ldap_cipher_suite main string unset
16369 .cindex "LDAP" "TLS cipher suite"
16370 This controls the TLS cipher-suite negotiation during TLS negotiation with
16371 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16372 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16373
16374
16375 .option ldap_default_servers main "string list" unset
16376 .cindex "LDAP" "default servers"
16377 This option provides a list of LDAP servers which are tried in turn when an
16378 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16379 details of LDAP queries. This option is available only when Exim has been built
16380 with LDAP support.
16381
16382
16383 .option ldap_require_cert main string unset.
16384 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16385 This should be one of the values "hard", "demand", "allow", "try" or "never".
16386 A value other than one of these is interpreted as "never".
16387 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16388 Although Exim does not set a default, the LDAP library probably defaults
16389 to hard/demand.
16390
16391
16392 .option ldap_start_tls main boolean false
16393 .cindex "LDAP" "whether or not to negotiate TLS"
16394 If set, Exim will attempt to negotiate TLS with the LDAP server when
16395 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16396 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16397 of SSL-on-connect.
16398 In the event of failure to negotiate TLS, the action taken is controlled
16399 by &%ldap_require_cert%&.
16400 This option is ignored for &`ldapi`& connections.
16401
16402
16403 .option ldap_version main integer unset
16404 .cindex "LDAP" "protocol version, forcing"
16405 This option can be used to force Exim to set a specific protocol version for
16406 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16407 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16408 the LDAP headers; otherwise it is 2. This option is available only when Exim
16409 has been built with LDAP support.
16410
16411
16412
16413 .option local_from_check main boolean true
16414 .cindex "&'Sender:'& header line" "disabling addition of"
16415 .cindex "&'From:'& header line" "disabling checking of"
16416 When a message is submitted locally (that is, not over a TCP/IP connection) by
16417 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16418 checks that the &'From:'& header line matches the login of the calling user and
16419 the domain specified by &%qualify_domain%&.
16420
16421 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16422 locally submitted message is automatically qualified by Exim, unless the
16423 &%-bnq%& command line option is used.
16424
16425 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16426 on the local part. If the &'From:'& header line does not match, Exim adds a
16427 &'Sender:'& header with an address constructed from the calling user's login
16428 and the default qualify domain.
16429
16430 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16431 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16432 &'Sender:'& header lines supplied by untrusted users, you must also set
16433 &%local_sender_retain%& to be true.
16434
16435 .cindex "envelope from"
16436 .cindex "envelope sender"
16437 These options affect only the header lines in the message. The envelope sender
16438 is still forced to be the login id at the qualify domain unless
16439 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16440
16441 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16442 request similar header line checking. See section &<<SECTthesenhea>>&, which
16443 has more details about &'Sender:'& processing.
16444
16445
16446
16447
16448 .option local_from_prefix main string unset
16449 When Exim checks the &'From:'& header line of locally submitted messages for
16450 matching the login id (see &%local_from_check%& above), it can be configured to
16451 ignore certain prefixes and suffixes in the local part of the address. This is
16452 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16453 appropriate lists, in the same form as the &%local_part_prefix%& and
16454 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16455 example, if
16456 .code
16457 local_from_prefix = *-
16458 .endd
16459 is set, a &'From:'& line containing
16460 .code
16461 From: anything-user@your.domain.example
16462 .endd
16463 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16464 matches the actual sender address that is constructed from the login name and
16465 qualify domain.
16466
16467
16468 .option local_from_suffix main string unset
16469 See &%local_from_prefix%& above.
16470
16471
16472 .option local_interfaces main "string list" "see below"
16473 This option controls which network interfaces are used by the daemon for
16474 listening; they are also used to identify the local host when routing. Chapter
16475 &<<CHAPinterfaces>>& contains a full description of this option and the related
16476 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16477 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16478 &%local_interfaces%& is
16479 .code
16480 local_interfaces = 0.0.0.0
16481 .endd
16482 when Exim is built without IPv6 support; otherwise it is
16483 .code
16484 local_interfaces = <; ::0 ; 0.0.0.0
16485 .endd
16486
16487 .option local_scan_timeout main time 5m
16488 .cindex "timeout" "for &[local_scan()]& function"
16489 .cindex "&[local_scan()]& function" "timeout"
16490 This timeout applies to the &[local_scan()]& function (see chapter
16491 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16492 the incoming message is rejected with a temporary error if it is an SMTP
16493 message. For a non-SMTP message, the message is dropped and Exim ends with a
16494 non-zero code. The incident is logged on the main and reject logs.
16495
16496
16497
16498 .option local_sender_retain main boolean false
16499 .cindex "&'Sender:'& header line" "retaining from local submission"
16500 When a message is submitted locally (that is, not over a TCP/IP connection) by
16501 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16502 do not want this to happen, you must set &%local_sender_retain%&, and you must
16503 also set &%local_from_check%& to be false (Exim will complain if you do not).
16504 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16505 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16506
16507
16508
16509
16510 .option localhost_number main string&!! unset
16511 .cindex "host" "locally unique number for"
16512 .cindex "message ids" "with multiple hosts"
16513 .vindex "&$localhost_number$&"
16514 Exim's message ids are normally unique only within the local host. If
16515 uniqueness among a set of hosts is required, each host must set a different
16516 value for the &%localhost_number%& option. The string is expanded immediately
16517 after reading the configuration file (so that a number can be computed from the
16518 host name, for example) and the result of the expansion must be a number in the
16519 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16520 systems). This is available in subsequent string expansions via the variable
16521 &$localhost_number$&. When &%localhost_number is set%&, the final two
16522 characters of the message id, instead of just being a fractional part of the
16523 time, are computed from the time and the local host number as described in
16524 section &<<SECTmessiden>>&.
16525
16526
16527
16528 .option log_file_path main "string list&!!" "set at compile time"
16529 .cindex "log" "file path for"
16530 This option sets the path which is used to determine the names of Exim's log
16531 files, or indicates that logging is to be to syslog, or both. It is expanded
16532 when Exim is entered, so it can, for example, contain a reference to the host
16533 name. If no specific path is set for the log files at compile or runtime,
16534 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16535 they are written in a sub-directory called &_log_& in Exim's spool directory.
16536 A path must start with a slash.
16537 To send to syslog, use the word &"syslog"&.
16538 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16539 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16540 used. If this string is fixed at your installation (contains no expansion
16541 variables) it is recommended that you do not set this option in the
16542 configuration file, but instead supply the path using LOG_FILE_PATH in
16543 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16544 early on &-- in particular, failure to read the configuration file.
16545
16546
16547 .option log_selector main string unset
16548 .cindex "log" "selectors"
16549 This option can be used to reduce or increase the number of things that Exim
16550 writes to its log files. Its argument is made up of names preceded by plus or
16551 minus characters. For example:
16552 .code
16553 log_selector = +arguments -retry_defer
16554 .endd
16555 A list of possible names and what they control is given in the chapter on
16556 logging, in section &<<SECTlogselector>>&.
16557
16558
16559 .option log_timezone main boolean false
16560 .cindex "log" "timezone for entries"
16561 .vindex "&$tod_log$&"
16562 .vindex "&$tod_zone$&"
16563 By default, the timestamps on log lines are in local time without the
16564 timezone. This means that if your timezone changes twice a year, the timestamps
16565 in log lines are ambiguous for an hour when the clocks go back. One way of
16566 avoiding this problem is to set the timezone to UTC. An alternative is to set
16567 &%log_timezone%& true. This turns on the addition of the timezone offset to
16568 timestamps in log lines. Turning on this option can add quite a lot to the size
16569 of log files because each line is extended by 6 characters. Note that the
16570 &$tod_log$& variable contains the log timestamp without the zone, but there is
16571 another variable called &$tod_zone$& that contains just the timezone offset.
16572
16573
16574 .option lookup_open_max main integer 25
16575 .cindex "too many open files"
16576 .cindex "open files, too many"
16577 .cindex "file" "too many open"
16578 .cindex "lookup" "maximum open files"
16579 .cindex "limit" "open files for lookups"
16580 This option limits the number of simultaneously open files for single-key
16581 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16582 Exim normally keeps these files open during routing, because often the same
16583 file is required several times. If the limit is reached, Exim closes the least
16584 recently used file. Note that if you are using the &'ndbm'& library, it
16585 actually opens two files for each logical DBM database, though it still counts
16586 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16587 open files"& errors with NDBM, you need to reduce the value of
16588 &%lookup_open_max%&.
16589
16590
16591 .option max_username_length main integer 0
16592 .cindex "length of login name"
16593 .cindex "user name" "maximum length"
16594 .cindex "limit" "user name length"
16595 Some operating systems are broken in that they truncate long arguments to
16596 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16597 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16598 an argument that is longer behaves as if &[getpwnam()]& failed.
16599
16600
16601 .option message_body_newlines main bool false
16602 .cindex "message body" "newlines in variables"
16603 .cindex "newline" "in message body variables"
16604 .vindex "&$message_body$&"
16605 .vindex "&$message_body_end$&"
16606 By default, newlines in the message body are replaced by spaces when setting
16607 the &$message_body$& and &$message_body_end$& expansion variables. If this
16608 option is set true, this no longer happens.
16609
16610
16611 .option message_body_visible main integer 500
16612 .cindex "body of message" "visible size"
16613 .cindex "message body" "visible size"
16614 .vindex "&$message_body$&"
16615 .vindex "&$message_body_end$&"
16616 This option specifies how much of a message's body is to be included in the
16617 &$message_body$& and &$message_body_end$& expansion variables.
16618
16619
16620 .option message_id_header_domain main string&!! unset
16621 .cindex "&'Message-ID:'& header line"
16622 If this option is set, the string is expanded and used as the right hand side
16623 (domain) of the &'Message-ID:'& header that Exim creates if a
16624 locally-originated incoming message does not have one. &"Locally-originated"&
16625 means &"not received over TCP/IP."&
16626 Otherwise, the primary host name is used.
16627 Only letters, digits, dot and hyphen are accepted; any other characters are
16628 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16629 empty string, the option is ignored.
16630
16631
16632 .option message_id_header_text main string&!! unset
16633 If this variable is set, the string is expanded and used to augment the text of
16634 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16635 message does not have one. The text of this header is required by RFC 2822 to
16636 take the form of an address. By default, Exim uses its internal message id as
16637 the local part, and the primary host name as the domain. If this option is set,
16638 it is expanded, and provided the expansion is not forced to fail, and does not
16639 yield an empty string, the result is inserted into the header immediately
16640 before the @, separated from the internal message id by a dot. Any characters
16641 that are illegal in an address are automatically converted into hyphens. This
16642 means that variables such as &$tod_log$& can be used, because the spaces and
16643 colons will become hyphens.
16644
16645
16646 .option message_logs main boolean true
16647 .cindex "message logs" "disabling"
16648 .cindex "log" "message log; disabling"
16649 If this option is turned off, per-message log files are not created in the
16650 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16651 Exim, by reducing the number of files involved in handling a message from a
16652 minimum of four (header spool file, body spool file, delivery journal, and
16653 per-message log) to three. The other major I/O activity is Exim's main log,
16654 which is not affected by this option.
16655
16656
16657 .option message_size_limit main string&!! 50M
16658 .cindex "message" "size limit"
16659 .cindex "limit" "message size"
16660 .cindex "size" "of message, limit"
16661 This option limits the maximum size of message that Exim will process. The
16662 value is expanded for each incoming connection so, for example, it can be made
16663 to depend on the IP address of the remote host for messages arriving via
16664 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16665 optionally followed by K or M.
16666
16667 .cindex "SIZE" "ESMTP extension, advertising"
16668 .cindex "ESMTP extensions" SIZE
16669 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16670 service extension keyword.
16671
16672 &*Note*&: This limit cannot be made to depend on a message's sender or any
16673 other properties of an individual message, because it has to be advertised in
16674 the server's response to EHLO. String expansion failure causes a temporary
16675 error. A value of zero means no limit, but its use is not recommended. See also
16676 &%bounce_return_size_limit%&.
16677
16678 Incoming SMTP messages are failed with a 552 error if the limit is
16679 exceeded; locally-generated messages either get a stderr message or a delivery
16680 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16681 an oversized message is logged in both the main and the reject logs. See also
16682 the generic transport option &%message_size_limit%&, which limits the size of
16683 message that an individual transport can process.
16684
16685 If you use a virus-scanner and set this option to to a value larger than the
16686 maximum size that your virus-scanner is configured to support, you may get
16687 failures triggered by large mails.  The right size to configure for the
16688 virus-scanner depends upon what data is passed and the options in use but it's
16689 probably safest to just set it to a little larger than this value.  E.g., with a
16690 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16691 some problems may result.
16692
16693 A value of 0 will disable size limit checking; Exim will still advertise the
16694 SIZE extension in an EHLO response, but without a limit, so as to permit
16695 SMTP clients to still indicate the message size along with the MAIL verb.
16696
16697
16698 .option move_frozen_messages main boolean false
16699 .cindex "frozen messages" "moving"
16700 This option, which is available only if Exim has been built with the setting
16701 .code
16702 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16703 .endd
16704 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16705 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16706 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16707 standard utilities for handling such moved messages, and they do not show up in
16708 lists generated by &%-bp%& or by the Exim monitor.
16709
16710
16711 .option mua_wrapper main boolean false
16712 Setting this option true causes Exim to run in a very restrictive mode in which
16713 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16714 contains a full description of this facility.
16715
16716
16717
16718 .option mysql_servers main "string list" unset
16719 .cindex "MySQL" "server list"
16720 This option provides a list of MySQL servers and associated connection data, to
16721 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16722 option is available only if Exim has been built with MySQL support.
16723
16724
16725 .option never_users main "string list&!!" unset
16726 This option is expanded just once, at the start of Exim's processing. Local
16727 message deliveries are normally run in processes that are setuid to the
16728 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16729 It is usually desirable to prevent any deliveries from running as root, as a
16730 safety precaution.
16731
16732 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16733 list of users that must not be used for local deliveries. This list is fixed in
16734 the binary and cannot be overridden by the configuration file. By default, it
16735 contains just the single user name &"root"&. The &%never_users%& runtime option
16736 can be used to add more users to the fixed list.
16737
16738 If a message is to be delivered as one of the users on the fixed list or the
16739 &%never_users%& list, an error occurs, and delivery is deferred. A common
16740 example is
16741 .code
16742 never_users = root:daemon:bin
16743 .endd
16744 Including root is redundant if it is also on the fixed list, but it does no
16745 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16746 transport driver.
16747
16748
16749 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16750 This option gives the name for a unix-domain socket on which the daemon
16751 listens for work and information-requests.
16752 Only installations running multiple daemons sharing a spool directory
16753 should need to modify the default.
16754
16755 The option is expanded before use.
16756 If the platform supports Linux-style abstract socket names, the result
16757 is used with a nul byte prefixed.
16758 Otherwise,
16759 it should be a full path name and use a directory accessible
16760 to Exim.
16761
16762 If this option is set as empty,
16763 or the command line &%-oY%& option is used, or
16764 the command line uses a &%-oX%& option and does not use &%-oP%&,
16765 then a notifier socket is not created.
16766
16767
16768 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16769 .cindex "OpenSSL "compatibility options"
16770 This option allows an administrator to adjust the SSL options applied
16771 by OpenSSL to connections.  It is given as a space-separated list of items,
16772 each one to be +added or -subtracted from the current value.
16773
16774 This option is only available if Exim is built against OpenSSL.  The values
16775 available for this option vary according to the age of your OpenSSL install.
16776 The &"all"& value controls a subset of flags which are available, typically
16777 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16778 list the values known on your system and Exim should support all the
16779 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16780 names lose the leading &"SSL_OP_"& and are lower-cased.
16781
16782 Note that adjusting the options can have severe impact upon the security of
16783 SSL as used by Exim.  It is possible to disable safety checks and shoot
16784 yourself in the foot in various unpleasant ways.  This option should not be
16785 adjusted lightly.  An unrecognised item will be detected at startup, by
16786 invoking Exim with the &%-bV%& flag.
16787
16788 The option affects Exim operating both as a server and as a client.
16789
16790 Historical note: prior to release 4.80, Exim defaulted this value to
16791 "+dont_insert_empty_fragments", which may still be needed for compatibility
16792 with some clients, but which lowers security by increasing exposure to
16793 some now infamous attacks.
16794
16795 Examples:
16796 .code
16797 # Make both old MS and old Eudora happy:
16798 openssl_options = -all +microsoft_big_sslv3_buffer \
16799                        +dont_insert_empty_fragments
16800
16801 # Disable older protocol versions:
16802 openssl_options = +no_sslv2 +no_sslv3
16803 .endd
16804
16805 Possible options may include:
16806 .ilist
16807 &`all`&
16808 .next
16809 &`allow_unsafe_legacy_renegotiation`&
16810 .next
16811 &`cipher_server_preference`&
16812 .next
16813 &`dont_insert_empty_fragments`&
16814 .next
16815 &`ephemeral_rsa`&
16816 .next
16817 &`legacy_server_connect`&
16818 .next
16819 &`microsoft_big_sslv3_buffer`&
16820 .next
16821 &`microsoft_sess_id_bug`&
16822 .next
16823 &`msie_sslv2_rsa_padding`&
16824 .next
16825 &`netscape_challenge_bug`&
16826 .next
16827 &`netscape_reuse_cipher_change_bug`&
16828 .next
16829 &`no_compression`&
16830 .next
16831 &`no_session_resumption_on_renegotiation`&
16832 .next
16833 &`no_sslv2`&
16834 .next
16835 &`no_sslv3`&
16836 .next
16837 &`no_ticket`&
16838 .next
16839 &`no_tlsv1`&
16840 .next
16841 &`no_tlsv1_1`&
16842 .next
16843 &`no_tlsv1_2`&
16844 .next
16845 &`safari_ecdhe_ecdsa_bug`&
16846 .next
16847 &`single_dh_use`&
16848 .next
16849 &`single_ecdh_use`&
16850 .next
16851 &`ssleay_080_client_dh_bug`&
16852 .next
16853 &`sslref2_reuse_cert_type_bug`&
16854 .next
16855 &`tls_block_padding_bug`&
16856 .next
16857 &`tls_d5_bug`&
16858 .next
16859 &`tls_rollback_bug`&
16860 .endlist
16861
16862 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16863 all clients connecting using the MacOS SecureTransport TLS facility prior
16864 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16865 to negotiate TLS then this option value might help, provided that your OpenSSL
16866 release is new enough to contain this work-around.  This may be a situation
16867 where you have to upgrade OpenSSL to get buggy clients working.
16868
16869
16870 .option oracle_servers main "string list" unset
16871 .cindex "Oracle" "server list"
16872 This option provides a list of Oracle servers and associated connection data,
16873 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16874 The option is available only if Exim has been built with Oracle support.
16875
16876
16877 .new
16878 .option panic_coredump main boolean false
16879 This option is rarely needed but can help for some debugging investigations.
16880 If set, when an internal error is detected by Exim which is sufficient
16881 to terminate the process
16882 (all such are logged in the paniclog)
16883 then a coredump is requested.
16884
16885 Note that most systems require additional administrative configuration
16886 to permit write a core file for a setuid program, which is Exim's
16887 common installed configuration.
16888 .wen
16889
16890 .option percent_hack_domains main "domain list&!!" unset
16891 .cindex "&""percent hack""&"
16892 .cindex "source routing" "in email address"
16893 .cindex "address" "source-routed"
16894 The &"percent hack"& is the convention whereby a local part containing a
16895 percent sign is re-interpreted as a new email address, with the percent
16896 replaced by @. This is sometimes called &"source routing"&, though that term is
16897 also applied to RFC 2822 addresses that begin with an @ character. If this
16898 option is set, Exim implements the percent facility for those domains listed,
16899 but no others. This happens before an incoming SMTP address is tested against
16900 an ACL.
16901
16902 &*Warning*&: The &"percent hack"& has often been abused by people who are
16903 trying to get round relaying restrictions. For this reason, it is best avoided
16904 if at all possible. Unfortunately, a number of less security-conscious MTAs
16905 implement it unconditionally. If you are running Exim on a gateway host, and
16906 routing mail through to internal MTAs without processing the local parts, it is
16907 a good idea to reject recipient addresses with percent characters in their
16908 local parts. Exim's default configuration does this.
16909
16910
16911 .option perl_at_start main boolean false
16912 .cindex "Perl"
16913 This option is available only when Exim is built with an embedded Perl
16914 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16915
16916
16917 .option perl_startup main string unset
16918 .cindex "Perl"
16919 This option is available only when Exim is built with an embedded Perl
16920 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16921
16922 .option perl_taintmode main boolean false
16923 .cindex "Perl"
16924 This option enables the taint mode of the embedded Perl interpreter.
16925
16926
16927 .option pgsql_servers main "string list" unset
16928 .cindex "PostgreSQL lookup type" "server list"
16929 This option provides a list of PostgreSQL servers and associated connection
16930 data, to be used in conjunction with &(pgsql)& lookups (see section
16931 &<<SECID72>>&). The option is available only if Exim has been built with
16932 PostgreSQL support.
16933
16934
16935 .option pid_file_path main string&!! "set at compile time"
16936 .cindex "daemon" "pid file path"
16937 .cindex "pid file, path for"
16938 This option sets the name of the file to which the Exim daemon writes its
16939 process id. The string is expanded, so it can contain, for example, references
16940 to the host name:
16941 .code
16942 pid_file_path = /var/log/$primary_hostname/exim.pid
16943 .endd
16944 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16945 spool directory.
16946 The value set by the option can be overridden by the &%-oP%& command line
16947 option. A pid file is not written if a &"non-standard"& daemon is run by means
16948 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16949
16950
16951 .option pipelining_advertise_hosts main "host list&!!" *
16952 .cindex "PIPELINING" "suppressing advertising"
16953 .cindex "ESMTP extensions" PIPELINING
16954 This option can be used to suppress the advertisement of the SMTP
16955 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16956 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16957 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16958 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16959 that clients will use it; &"out of order"& commands that are &"expected"& do
16960 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16961
16962 .option pipelining_connect_advertise_hosts main "host list&!!" *
16963 .cindex "pipelining" "early connection"
16964 .cindex "pipelining" PIPECONNECT
16965 .cindex "ESMTP extensions" PIPECONNECT
16966 If Exim is built without the DISABLE_PIPE_CONNECT build option
16967 this option controls which hosts the facility is advertised to
16968 and from which pipeline early-connection (before MAIL) SMTP
16969 commands are acceptable.
16970 When used, the pipelining saves on roundtrip times.
16971
16972 See also the &%hosts_pipe_connect%& smtp transport option.
16973
16974 The SMTP service extension keyword advertised is &"PIPECONNECT"&;
16975 it permits the client to pipeline
16976 TCP connection and hello command (inclear phase),
16977 or TLS-establishment and hello command (encrypted phase),
16978 on later connections to the same host.
16979
16980
16981 .option prdr_enable main boolean false
16982 .cindex "PRDR" "enabling on server"
16983 .cindex "ESMTP extensions" PRDR
16984 This option can be used to enable the Per-Recipient Data Response extension
16985 to SMTP, defined by Eric Hall.
16986 If the option is set, PRDR is advertised by Exim when operating as a server.
16987 If the client requests PRDR, and more than one recipient, for a message
16988 an additional ACL is called for each recipient after the message content
16989 is received.  See section &<<SECTPRDRACL>>&.
16990
16991 .option preserve_message_logs main boolean false
16992 .cindex "message logs" "preserving"
16993 If this option is set, message log files are not deleted when messages are
16994 completed. Instead, they are moved to a sub-directory of the spool directory
16995 called &_msglog.OLD_&, where they remain available for statistical or debugging
16996 purposes. This is a dangerous option to set on systems with any appreciable
16997 volume of mail. Use with care!
16998
16999
17000 .option primary_hostname main string "see below"
17001 .cindex "name" "of local host"
17002 .cindex "host" "name of local"
17003 .cindex "local host" "name of"
17004 .vindex "&$primary_hostname$&"
17005 This specifies the name of the current host. It is used in the default EHLO or
17006 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17007 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17008 The value is also used by default in some SMTP response messages from an Exim
17009 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17010
17011 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17012 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17013 contains only one component, Exim passes it to &[gethostbyname()]& (or
17014 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17015 version. The variable &$primary_hostname$& contains the host name, whether set
17016 explicitly by this option, or defaulted.
17017
17018
17019 .option print_topbitchars main boolean false
17020 .cindex "printing characters"
17021 .cindex "8-bit characters"
17022 By default, Exim considers only those characters whose codes lie in the range
17023 32&--126 to be printing characters. In a number of circumstances (for example,
17024 when writing log entries) non-printing characters are converted into escape
17025 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17026 is set, code values of 128 and above are also considered to be printing
17027 characters.
17028
17029 This option also affects the header syntax checks performed by the
17030 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17031 the user's full name when constructing From: and Sender: addresses (as
17032 described in section &<<SECTconstr>>&). Setting this option can cause
17033 Exim to generate eight bit message headers that do not conform to the
17034 standards.
17035
17036
17037 .option process_log_path main string unset
17038 .cindex "process log path"
17039 .cindex "log" "process log"
17040 .cindex "&'exiwhat'&"
17041 This option sets the name of the file to which an Exim process writes its
17042 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17043 utility script. If this option is unset, the file called &_exim-process.info_&
17044 in Exim's spool directory is used. The ability to specify the name explicitly
17045 can be useful in environments where two different Exims are running, using
17046 different spool directories.
17047
17048
17049 .option prod_requires_admin main boolean true
17050 .cindex "restricting access to features"
17051 .oindex "&%-M%&"
17052 .oindex "&%-R%&"
17053 .oindex "&%-q%&"
17054 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17055 admin user unless &%prod_requires_admin%& is set false. See also
17056 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17057
17058
17059 .option proxy_protocol_timeout main time 3s
17060 .cindex proxy "proxy protocol"
17061 This option sets the timeout for proxy protocol negotiation.
17062 For details see section &<<SECTproxyInbound>>&.
17063
17064
17065 .option qualify_domain main string "see below"
17066 .cindex "domain" "for qualifying addresses"
17067 .cindex "address" "qualification"
17068 This option specifies the domain name that is added to any envelope sender
17069 addresses that do not have a domain qualification. It also applies to
17070 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17071 are accepted by default only for locally-generated messages. Qualification is
17072 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17073 locally-generated messages, unless the &%-bnq%& command line option is used.
17074
17075 Messages from external sources must always contain fully qualified addresses,
17076 unless the sending host matches &%sender_unqualified_hosts%& or
17077 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17078 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17079 necessary. Internally, Exim always works with fully qualified envelope
17080 addresses. If &%qualify_domain%& is not set, it defaults to the
17081 &%primary_hostname%& value.
17082
17083
17084 .option qualify_recipient main string "see below"
17085 This option allows you to specify a different domain for qualifying recipient
17086 addresses to the one that is used for senders. See &%qualify_domain%& above.
17087
17088
17089
17090 .option queue_domains main "domain list&!!" unset
17091 .cindex "domain" "specifying non-immediate delivery"
17092 .cindex "queueing incoming messages"
17093 .cindex "message" "queueing certain domains"
17094 This option lists domains for which immediate delivery is not required.
17095 A delivery process is started whenever a message is received, but only those
17096 domains that do not match are processed. All other deliveries wait until the
17097 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17098
17099
17100 .option queue_fast_ramp main boolean true
17101 .cindex "queue runner" "two phase"
17102 .cindex "queue" "double scanning"
17103 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17104 command line, may start parallel delivery processes during their first
17105 phase.  This will be done when a threshold number of messages have been
17106 routed for a single host.
17107
17108
17109 .option queue_list_requires_admin main boolean true
17110 .cindex "restricting access to features"
17111 .oindex "&%-bp%&"
17112 The &%-bp%& command-line option, which lists the messages that are on the
17113 queue, requires the caller to be an admin user unless
17114 &%queue_list_requires_admin%& is set false.
17115 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17116
17117
17118 .option queue_only main boolean false
17119 .cindex "queueing incoming messages"
17120 .cindex "message" "queueing unconditionally"
17121 If &%queue_only%& is set, a delivery process is not automatically started
17122 whenever a message is received. Instead, the message waits in the queue for the
17123 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17124 delivered immediately when certain conditions (such as heavy load) occur.
17125
17126 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17127 and &%-odi%& command line options override &%queue_only%& unless
17128 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17129 &%queue_only_load%&, and &%smtp_accept_queue%&.
17130
17131
17132 .option queue_only_file main string unset
17133 .cindex "queueing incoming messages"
17134 .cindex "message" "queueing by file existence"
17135 This option can be set to a colon-separated list of absolute path names, each
17136 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17137 it tests for the existence of each listed path using a call to &[stat()]&. For
17138 each path that exists, the corresponding queueing option is set.
17139 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17140 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17141 .code
17142 queue_only_file = smtp/some/file
17143 .endd
17144 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17145 &_/some/file_& exists.
17146
17147
17148 .option queue_only_load main fixed-point unset
17149 .cindex "load average"
17150 .cindex "queueing incoming messages"
17151 .cindex "message" "queueing by load"
17152 If the system load average is higher than this value, incoming messages from
17153 all sources are queued, and no automatic deliveries are started. If this
17154 happens during local or remote SMTP input, all subsequent messages received on
17155 the same SMTP connection are queued by default, whatever happens to the load in
17156 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17157 false.
17158
17159 Deliveries will subsequently be performed by queue runner processes. This
17160 option has no effect on ancient operating systems on which Exim cannot
17161 determine the load average. See also &%deliver_queue_load_max%& and
17162 &%smtp_load_reserve%&.
17163
17164
17165 .option queue_only_load_latch main boolean true
17166 .cindex "load average" "re-evaluating per message"
17167 When this option is true (the default), once one message has been queued
17168 because the load average is higher than the value set by &%queue_only_load%&,
17169 all subsequent messages received on the same SMTP connection are also queued.
17170 This is a deliberate choice; even though the load average may fall below the
17171 threshold, it doesn't seem right to deliver later messages on the same
17172 connection when not delivering earlier ones. However, there are special
17173 circumstances such as very long-lived connections from scanning appliances
17174 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17175 should be set false. This causes the value of the load average to be
17176 re-evaluated for each message.
17177
17178
17179 .option queue_only_override main boolean true
17180 .cindex "queueing incoming messages"
17181 When this option is true, the &%-od%&&'x'& command line options override the
17182 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17183 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17184 to override; they are accepted, but ignored.
17185
17186
17187 .option queue_run_in_order main boolean false
17188 .cindex "queue runner" "processing messages in order"
17189 If this option is set, queue runs happen in order of message arrival instead of
17190 in an arbitrary order. For this to happen, a complete list of the entire queue
17191 must be set up before the deliveries start. When the queue is all held in a
17192 single directory (the default), a single list is created for both the ordered
17193 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17194 single list is not created when &%queue_run_in_order%& is false. In this case,
17195 the sub-directories are processed one at a time (in a random order), and this
17196 avoids setting up one huge list for the whole queue. Thus, setting
17197 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17198 when the queue is large, because of the extra work in setting up the single,
17199 large list. In most situations, &%queue_run_in_order%& should not be set.
17200
17201
17202
17203 .option queue_run_max main integer&!! 5
17204 .cindex "queue runner" "maximum number of"
17205 This controls the maximum number of queue runner processes that an Exim daemon
17206 can run simultaneously. This does not mean that it starts them all at once,
17207 but rather that if the maximum number are still running when the time comes to
17208 start another one, it refrains from starting another one. This can happen with
17209 very large queues and/or very sluggish deliveries. This option does not,
17210 however, interlock with other processes, so additional queue runners can be
17211 started by other means, or by killing and restarting the daemon.
17212
17213 Setting this option to zero does not suppress queue runs; rather, it disables
17214 the limit, allowing any number of simultaneous queue runner processes to be
17215 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17216 the daemon's command line.
17217
17218 .cindex queues named
17219 .cindex "named queues" "resource limit"
17220 To set limits for different named queues use
17221 an expansion depending on the &$queue_name$& variable.
17222
17223 .option queue_smtp_domains main "domain list&!!" unset
17224 .cindex "queueing incoming messages"
17225 .cindex "message" "queueing remote deliveries"
17226 .cindex "first pass routing"
17227 When this option is set, a delivery process is started whenever a message is
17228 received, routing is performed, and local deliveries take place.
17229 However, if any SMTP deliveries are required for domains that match
17230 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17231 message waits in the queue for the next queue run. Since routing of the message
17232 has taken place, Exim knows to which remote hosts it must be delivered, and so
17233 when the queue run happens, multiple messages for the same host are delivered
17234 over a single SMTP connection. The &%-odqs%& command line option causes all
17235 SMTP deliveries to be queued in this way, and is equivalent to setting
17236 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17237 &%queue_domains%&.
17238
17239
17240 .option receive_timeout main time 0s
17241 .cindex "timeout" "for non-SMTP input"
17242 This option sets the timeout for accepting a non-SMTP message, that is, the
17243 maximum time that Exim waits when reading a message on the standard input. If
17244 the value is zero, it will wait forever. This setting is overridden by the
17245 &%-or%& command line option. The timeout for incoming SMTP messages is
17246 controlled by &%smtp_receive_timeout%&.
17247
17248 .option received_header_text main string&!! "see below"
17249 .cindex "customizing" "&'Received:'& header"
17250 .cindex "&'Received:'& header line" "customizing"
17251 This string defines the contents of the &'Received:'& message header that is
17252 added to each message, except for the timestamp, which is automatically added
17253 on at the end (preceded by a semicolon). The string is expanded each time it is
17254 used. If the expansion yields an empty string, no &'Received:'& header line is
17255 added to the message. Otherwise, the string should start with the text
17256 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17257 header lines.
17258 The default setting is:
17259
17260 .code
17261 received_header_text = Received: \
17262   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17263     {${if def:sender_ident \
17264       {from ${quote_local_part:$sender_ident} }}\
17265         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17266   by $primary_hostname \
17267   ${if def:received_protocol {with $received_protocol }}\
17268   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17269   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17270   (Exim $version_number)\n\t\
17271   ${if def:sender_address \
17272   {(envelope-from <$sender_address>)\n\t}}\
17273   id $message_exim_id\
17274   ${if def:received_for {\n\tfor $received_for}}
17275 .endd
17276
17277 The references to the TLS version and cipher are
17278 omitted when Exim is built without TLS
17279 support. The use of conditional expansions ensures that this works for both
17280 locally generated messages and messages received from remote hosts, giving
17281 header lines such as the following:
17282 .code
17283 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17284 by marley.carol.example with esmtp (Exim 4.00)
17285 (envelope-from <bob@carol.example>)
17286 id 16IOWa-00019l-00
17287 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17288 Received: by scrooge.carol.example with local (Exim 4.00)
17289 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17290 .endd
17291 Until the body of the message has been received, the timestamp is the time when
17292 the message started to be received. Once the body has arrived, and all policy
17293 checks have taken place, the timestamp is updated to the time at which the
17294 message was accepted.
17295
17296
17297 .option received_headers_max main integer 30
17298 .cindex "loop" "prevention"
17299 .cindex "mail loop prevention"
17300 .cindex "&'Received:'& header line" "counting"
17301 When a message is to be delivered, the number of &'Received:'& headers is
17302 counted, and if it is greater than this parameter, a mail loop is assumed to
17303 have occurred, the delivery is abandoned, and an error message is generated.
17304 This applies to both local and remote deliveries.
17305
17306
17307 .option recipient_unqualified_hosts main "host list&!!" unset
17308 .cindex "unqualified addresses"
17309 .cindex "host" "unqualified addresses from"
17310 This option lists those hosts from which Exim is prepared to accept unqualified
17311 recipient addresses in message envelopes. The addresses are made fully
17312 qualified by the addition of the &%qualify_recipient%& value. This option also
17313 affects message header lines. Exim does not reject unqualified recipient
17314 addresses in headers, but it qualifies them only if the message came from a
17315 host that matches &%recipient_unqualified_hosts%&,
17316 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17317 option was not set.
17318
17319
17320 .option recipients_max main integer 50000
17321 .cindex "limit" "number of recipients"
17322 .cindex "recipient" "maximum number"
17323 If this option is set greater than zero, it specifies the maximum number of
17324 original recipients for any message. Additional recipients that are generated
17325 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17326 all recipients over the limit; earlier recipients are delivered as normal.
17327 Non-SMTP messages with too many recipients are failed, and no deliveries are
17328 done.
17329
17330 .cindex "RCPT" "maximum number of incoming"
17331 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17332 RCPT commands in a single message.
17333
17334
17335 .option recipients_max_reject main boolean false
17336 If this option is set true, Exim rejects SMTP messages containing too many
17337 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17338 error to the eventual DATA command. Otherwise (the default) it gives a 452
17339 error to the surplus RCPT commands and accepts the message on behalf of the
17340 initial set of recipients. The remote server should then re-send the message
17341 for the remaining recipients at a later time.
17342
17343
17344 .option remote_max_parallel main integer 4
17345 .cindex "delivery" "parallelism for remote"
17346 This option controls parallel delivery of one message to a number of remote
17347 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17348 does all the remote deliveries for a message one by one. Otherwise, if a single
17349 message has to be delivered to more than one remote host, or if several copies
17350 have to be sent to the same remote host, up to &%remote_max_parallel%&
17351 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17352 deliveries are required, the maximum number of processes are started, and as
17353 each one finishes, another is begun. The order of starting processes is the
17354 same as if sequential delivery were being done, and can be controlled by the
17355 &%remote_sort_domains%& option. If parallel delivery takes place while running
17356 with debugging turned on, the debugging output from each delivery process is
17357 tagged with its process id.
17358
17359 This option controls only the maximum number of parallel deliveries for one
17360 message in one Exim delivery process. Because Exim has no central queue
17361 manager, there is no way of controlling the total number of simultaneous
17362 deliveries if the configuration allows a delivery attempt as soon as a message
17363 is received.
17364
17365 See also the &%max_parallel%& generic transport option,
17366 and the &%serialize_hosts%& smtp transport option.
17367
17368 .cindex "number of deliveries"
17369 .cindex "delivery" "maximum number of"
17370 If you want to control the total number of deliveries on the system, you
17371 need to set the &%queue_only%& option. This ensures that all incoming messages
17372 are added to the queue without starting a delivery process. Then set up an Exim
17373 daemon to start queue runner processes at appropriate intervals (probably
17374 fairly often, for example, every minute), and limit the total number of queue
17375 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17376 delivers only one message at a time, the maximum number of deliveries that can
17377 then take place at once is &%queue_run_max%& multiplied by
17378 &%remote_max_parallel%&.
17379
17380 If it is purely remote deliveries you want to control, use
17381 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17382 doing the SMTP routing before queueing, so that several messages for the same
17383 host will eventually get delivered down the same connection.
17384
17385
17386 .option remote_sort_domains main "domain list&!!" unset
17387 .cindex "sorting remote deliveries"
17388 .cindex "delivery" "sorting remote"
17389 When there are a number of remote deliveries for a message, they are sorted by
17390 domain into the order given by this list. For example,
17391 .code
17392 remote_sort_domains = *.cam.ac.uk:*.uk
17393 .endd
17394 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17395 then to those in the &%uk%& domain, then to any others.
17396
17397
17398 .option retry_data_expire main time 7d
17399 .cindex "hints database" "data expiry"
17400 This option sets a &"use before"& time on retry information in Exim's hints
17401 database. Any older retry data is ignored. This means that, for example, once a
17402 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17403 past failures.
17404
17405
17406 .option retry_interval_max main time 24h
17407 .cindex "retry" "limit on interval"
17408 .cindex "limit" "on retry interval"
17409 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17410 intervals between delivery attempts for messages that cannot be delivered
17411 straight away. This option sets an overall limit to the length of time between
17412 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17413 the default value.
17414
17415
17416 .option return_path_remove main boolean true
17417 .cindex "&'Return-path:'& header line" "removing"
17418 RFC 2821, section 4.4, states that an SMTP server must insert a
17419 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17420 The &'Return-path:'& header preserves the sender address as received in the
17421 MAIL command. This description implies that this header should not be present
17422 in an incoming message. If &%return_path_remove%& is true, any existing
17423 &'Return-path:'& headers are removed from messages at the time they are
17424 received. Exim's transports have options for adding &'Return-path:'& headers at
17425 the time of delivery. They are normally used only for final local deliveries.
17426
17427
17428 .option return_size_limit main integer 100K
17429 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17430
17431
17432 .option rfc1413_hosts main "host list&!!" @[]
17433 .cindex "RFC 1413"
17434 .cindex "host" "for RFC 1413 calls"
17435 RFC 1413 identification calls are made to any client host which matches
17436 an item in the list.
17437 The default value specifies just this host, being any local interface
17438 for the system.
17439
17440 .option rfc1413_query_timeout main time 0s
17441 .cindex "RFC 1413" "query timeout"
17442 .cindex "timeout" "for RFC 1413 call"
17443 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17444 no RFC 1413 calls are ever made.
17445
17446
17447 .option sender_unqualified_hosts main "host list&!!" unset
17448 .cindex "unqualified addresses"
17449 .cindex "host" "unqualified addresses from"
17450 This option lists those hosts from which Exim is prepared to accept unqualified
17451 sender addresses. The addresses are made fully qualified by the addition of
17452 &%qualify_domain%&. This option also affects message header lines. Exim does
17453 not reject unqualified addresses in headers that contain sender addresses, but
17454 it qualifies them only if the message came from a host that matches
17455 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17456 using TCP/IP), and the &%-bnq%& option was not set.
17457
17458
17459 .option slow_lookup_log main integer 0
17460 .cindex "logging" "slow lookups"
17461 .cindex "dns" "logging slow lookups"
17462 This option controls logging of slow lookups.
17463 If the value is nonzero it is taken as a number of milliseconds
17464 and lookups taking longer than this are logged.
17465 Currently this applies only to DNS lookups.
17466
17467
17468
17469 .option smtp_accept_keepalive main boolean true
17470 .cindex "keepalive" "on incoming connection"
17471 This option controls the setting of the SO_KEEPALIVE option on incoming
17472 TCP/IP socket connections. When set, it causes the kernel to probe idle
17473 connections periodically, by sending packets with &"old"& sequence numbers. The
17474 other end of the connection should send an acknowledgment if the connection is
17475 still okay or a reset if the connection has been aborted. The reason for doing
17476 this is that it has the beneficial effect of freeing up certain types of
17477 connection that can get stuck when the remote host is disconnected without
17478 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17479 hours to detect unreachable hosts.
17480
17481
17482
17483 .option smtp_accept_max main integer 20
17484 .cindex "limit" "incoming SMTP connections"
17485 .cindex "SMTP" "incoming connection count"
17486 .cindex "inetd"
17487 This option specifies the maximum number of simultaneous incoming SMTP calls
17488 that Exim will accept. It applies only to the listening daemon; there is no
17489 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17490 value is set to zero, no limit is applied. However, it is required to be
17491 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17492 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17493
17494 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17495 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17496 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17497 and &%smtp_load_reserve%& are then checked before accepting the connection.
17498
17499
17500 .option smtp_accept_max_nonmail main integer 10
17501 .cindex "limit" "non-mail SMTP commands"
17502 .cindex "SMTP" "limiting non-mail commands"
17503 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17504 the connection if there are too many. This option defines &"too many"&. The
17505 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17506 client looping sending EHLO, for example. The check is applied only if the
17507 client host matches &%smtp_accept_max_nonmail_hosts%&.
17508
17509 When a new message is expected, one occurrence of RSET is not counted. This
17510 allows a client to send one RSET between messages (this is not necessary,
17511 but some clients do it). Exim also allows one uncounted occurrence of HELO
17512 or EHLO, and one occurrence of STARTTLS between messages. After
17513 starting up a TLS session, another EHLO is expected, and so it too is not
17514 counted. The first occurrence of AUTH in a connection, or immediately
17515 following STARTTLS is not counted. Otherwise, all commands other than
17516 MAIL, RCPT, DATA, and QUIT are counted.
17517
17518
17519 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17520 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17521 check by setting this option. The default value makes it apply to all hosts. By
17522 changing the value, you can exclude any badly-behaved hosts that you have to
17523 live with.
17524
17525
17526 . Allow this long option name to split; give it unsplit as a fifth argument
17527 . for the automatic .oindex that is generated by .option.
17528 . We insert " &~&~" which is both pretty nasty visually and results in
17529 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17530 . zero-width-space, which would be nicer visually and results in (at least)
17531 . html that Firefox will split on when it's forced to reflow (rather than
17532 . inserting a horizontal scrollbar).  However, the text is still not
17533 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17534 . the option name to split.
17535
17536 .option "smtp_accept_max_per_connection" main integer&!! 1000 &&&
17537          smtp_accept_max_per_connection
17538 .cindex "SMTP" "limiting incoming message count"
17539 .cindex "limit" "messages per SMTP connection"
17540 The value of this option limits the number of MAIL commands that Exim is
17541 prepared to accept over a single SMTP connection, whether or not each command
17542 results in the transfer of a message. After the limit is reached, a 421
17543 response is given to subsequent MAIL commands. This limit is a safety
17544 precaution against a client that goes mad (incidents of this type have been
17545 seen).
17546 The option is expanded after the HELO or EHLO is received
17547 and may depend on values available at that time.
17548 An empty or zero value after expansion removes the limit.
17549
17550
17551 .option smtp_accept_max_per_host main string&!! unset
17552 .cindex "limit" "SMTP connections from one host"
17553 .cindex "host" "limiting SMTP connections from"
17554 This option restricts the number of simultaneous IP connections from a single
17555 host (strictly, from a single IP address) to the Exim daemon. The option is
17556 expanded, to enable different limits to be applied to different hosts by
17557 reference to &$sender_host_address$&. Once the limit is reached, additional
17558 connection attempts from the same host are rejected with error code 421. This
17559 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17560 of zero imposes no limit. If this option is set greater than zero, it is
17561 required that &%smtp_accept_max%& be non-zero.
17562
17563 &*Warning*&: When setting this option you should not use any expansion
17564 constructions that take an appreciable amount of time. The expansion and test
17565 happen in the main daemon loop, in order to reject additional connections
17566 without forking additional processes (otherwise a denial-of-service attack
17567 could cause a vast number or processes to be created). While the daemon is
17568 doing this processing, it cannot accept any other incoming connections.
17569
17570
17571
17572 .option smtp_accept_queue main integer 0
17573 .cindex "SMTP" "incoming connection count"
17574 .cindex "queueing incoming messages"
17575 .cindex "message" "queueing by SMTP connection count"
17576 If the number of simultaneous incoming SMTP connections being handled via the
17577 listening daemon exceeds this value, messages received by SMTP are just placed
17578 in the queue; no delivery processes are started automatically. The count is
17579 fixed at the start of an SMTP connection. It cannot be updated in the
17580 subprocess that receives messages, and so the queueing or not queueing applies
17581 to all messages received in the same connection.
17582
17583 A value of zero implies no limit, and clearly any non-zero value is useful only
17584 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17585 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17586 various &%-od%&&'x'& command line options.
17587
17588
17589 . See the comment on smtp_accept_max_per_connection
17590
17591 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17592          smtp_accept_queue_per_connection
17593 .cindex "queueing incoming messages"
17594 .cindex "message" "queueing by message count"
17595 This option limits the number of delivery processes that Exim starts
17596 automatically when receiving messages via SMTP, whether via the daemon or by
17597 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17598 and the number of messages received in a single SMTP session exceeds this
17599 number, subsequent messages are placed in the queue, but no delivery processes
17600 are started. This helps to limit the number of Exim processes when a server
17601 restarts after downtime and there is a lot of mail waiting for it on other
17602 systems. On large systems, the default should probably be increased, and on
17603 dial-in client systems it should probably be set to zero (that is, disabled).
17604
17605
17606 .option smtp_accept_reserve main integer 0
17607 .cindex "SMTP" "incoming call count"
17608 .cindex "host" "reserved"
17609 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17610 number of SMTP connections that are reserved for connections from the hosts
17611 that are specified in &%smtp_reserve_hosts%&. The value set in
17612 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17613 restricted to this number of connections; the option specifies a minimum number
17614 of connection slots for them, not a maximum. It is a guarantee that this group
17615 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17616 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17617 individual host.
17618
17619 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17620 set to 5, once there are 45 active connections (from any hosts), new
17621 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17622 provided the other criteria for acceptance are met.
17623
17624
17625 .option smtp_active_hostname main string&!! unset
17626 .cindex "host" "name in SMTP responses"
17627 .cindex "SMTP" "host name in responses"
17628 .vindex "&$primary_hostname$&"
17629 This option is provided for multi-homed servers that want to masquerade as
17630 several different hosts. At the start of an incoming SMTP connection, its value
17631 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17632 responses. For example, it is used as domain name in the response to an
17633 incoming HELO or EHLO command.
17634
17635 .vindex "&$smtp_active_hostname$&"
17636 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17637 is saved with any messages that are received. It is therefore available for use
17638 in routers and transports when the message is later delivered.
17639
17640 If this option is unset, or if its expansion is forced to fail, or if the
17641 expansion results in an empty string, the value of &$primary_hostname$& is
17642 used. Other expansion failures cause a message to be written to the main and
17643 panic logs, and the SMTP command receives a temporary error. Typically, the
17644 value of &%smtp_active_hostname%& depends on the incoming interface address.
17645 For example:
17646 .code
17647 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17648   {cox.mydomain}{box.mydomain}}
17649 .endd
17650
17651 Although &$smtp_active_hostname$& is primarily concerned with incoming
17652 messages, it is also used as the default for HELO commands in callout
17653 verification if there is no remote transport from which to obtain a
17654 &%helo_data%& value.
17655
17656 .option smtp_backlog_monitor main integer 0
17657 .cindex "connection backlog" monitoring
17658 If this option is set to greater than zero, and the backlog of available
17659 TCP connections on a socket listening for SMTP is larger than it, a line
17660 is logged giving the value and the socket address and port.
17661 The value is retrived jsut before an accept call.
17662 This facility is only available on Linux.
17663
17664 .option smtp_banner main string&!! "see below"
17665 .cindex "SMTP" "welcome banner"
17666 .cindex "banner for SMTP"
17667 .cindex "welcome banner for SMTP"
17668 .cindex "customizing" "SMTP banner"
17669 This string, which is expanded every time it is used, is output as the initial
17670 positive response to an SMTP connection. The default setting is:
17671 .code
17672 smtp_banner = $smtp_active_hostname ESMTP Exim \
17673   $version_number $tod_full
17674 .endd
17675 Failure to expand the string causes a panic error. If you want to create a
17676 multiline response to the initial SMTP connection, use &"\n"& in the string at
17677 appropriate points, but not at the end. Note that the 220 code is not included
17678 in this string. Exim adds it automatically (several times in the case of a
17679 multiline response).
17680
17681
17682 .option smtp_check_spool_space main boolean true
17683 .cindex "checking disk space"
17684 .cindex "disk space, checking"
17685 .cindex "spool directory" "checking space"
17686 When this option is set, if an incoming SMTP session encounters the SIZE
17687 option on a MAIL command, it checks that there is enough space in the
17688 spool directory's partition to accept a message of that size, while still
17689 leaving free the amount specified by &%check_spool_space%& (even if that value
17690 is zero). If there isn't enough space, a temporary error code is returned.
17691
17692
17693 .option smtp_connect_backlog main integer 20
17694 .cindex "connection backlog" "set maximum"
17695 .cindex "SMTP" "connection backlog"
17696 .cindex "backlog of connections"
17697 This option specifies a maximum number of waiting SMTP connections. Exim passes
17698 this value to the TCP/IP system when it sets up its listener. Once this number
17699 of connections are waiting for the daemon's attention, subsequent connection
17700 attempts are refused at the TCP/IP level. At least, that is what the manuals
17701 say; in some circumstances such connection attempts have been observed to time
17702 out instead. For large systems it is probably a good idea to increase the
17703 value (to 50, say). It also gives some protection against denial-of-service
17704 attacks by SYN flooding.
17705
17706
17707 .option smtp_enforce_sync main boolean true
17708 .cindex "SMTP" "synchronization checking"
17709 .cindex "synchronization checking in SMTP"
17710 The SMTP protocol specification requires the client to wait for a response from
17711 the server at certain points in the dialogue. Without PIPELINING these
17712 synchronization points are after every command; with PIPELINING they are
17713 fewer, but they still exist.
17714
17715 Some spamming sites send out a complete set of SMTP commands without waiting
17716 for any response. Exim protects against this by rejecting a message if the
17717 client has sent further input when it should not have. The error response &"554
17718 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17719 for this error cannot be perfect because of transmission delays (unexpected
17720 input may be on its way but not yet received when Exim checks). However, it
17721 does detect many instances.
17722
17723 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17724 If you want to disable the check selectively (for example, only for certain
17725 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17726 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17727
17728
17729
17730 .option smtp_etrn_command main string&!! unset
17731 .cindex "ETRN" "command to be run"
17732 .cindex "ESMTP extensions" ETRN
17733 .vindex "&$domain$&"
17734 If this option is set, the given command is run whenever an SMTP ETRN
17735 command is received from a host that is permitted to issue such commands (see
17736 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17737 are independently expanded. The expansion variable &$domain$& is set to the
17738 argument of the ETRN command, and no syntax checking is done on it. For
17739 example:
17740 .code
17741 smtp_etrn_command = /etc/etrn_command $domain \
17742                     $sender_host_address
17743 .endd
17744 If the option is not set, the argument for the ETRN command must
17745 be a &'#'& followed by an address string.
17746 In this case an &'exim -R <string>'& command is used;
17747 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17748
17749 A new process is created to run the command, but Exim does not wait for it to
17750 complete. Consequently, its status cannot be checked. If the command cannot be
17751 run, a line is written to the panic log, but the ETRN caller still receives
17752 a 250 success response. Exim is normally running under its own uid when
17753 receiving SMTP, so it is not possible for it to change the uid before running
17754 the command.
17755
17756
17757 .option smtp_etrn_serialize main boolean true
17758 .cindex "ETRN" "serializing"
17759 When this option is set, it prevents the simultaneous execution of more than
17760 one identical command as a result of ETRN in an SMTP connection. See
17761 section &<<SECTETRN>>& for details.
17762
17763
17764 .option smtp_load_reserve main fixed-point unset
17765 .cindex "load average"
17766 If the system load average ever gets higher than this, incoming SMTP calls are
17767 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17768 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17769 the load is over the limit. The option has no effect on ancient operating
17770 systems on which Exim cannot determine the load average. See also
17771 &%deliver_queue_load_max%& and &%queue_only_load%&.
17772
17773
17774
17775 .option smtp_max_synprot_errors main integer 3
17776 .cindex "SMTP" "limiting syntax and protocol errors"
17777 .cindex "limit" "SMTP syntax and protocol errors"
17778 Exim rejects SMTP commands that contain syntax or protocol errors. In
17779 particular, a syntactically invalid email address, as in this command:
17780 .code
17781 RCPT TO:<abc xyz@a.b.c>
17782 .endd
17783 causes immediate rejection of the command, before any other tests are done.
17784 (The ACL cannot be run if there is no valid address to set up for it.) An
17785 example of a protocol error is receiving RCPT before MAIL. If there are
17786 too many syntax or protocol errors in one SMTP session, the connection is
17787 dropped. The limit is set by this option.
17788
17789 .cindex "PIPELINING" "expected errors"
17790 When the PIPELINING extension to SMTP is in use, some protocol errors are
17791 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17792 Exim assumes that PIPELINING will be used if it advertises it (see
17793 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17794 not count towards the limit.
17795
17796
17797
17798 .option smtp_max_unknown_commands main integer 3
17799 .cindex "SMTP" "limiting unknown commands"
17800 .cindex "limit" "unknown SMTP commands"
17801 If there are too many unrecognized commands in an incoming SMTP session, an
17802 Exim server drops the connection. This is a defence against some kinds of abuse
17803 that subvert web
17804 clients
17805 into making connections to SMTP ports; in these circumstances, a number of
17806 non-SMTP command lines are sent first.
17807
17808
17809
17810 .option smtp_ratelimit_hosts main "host list&!!" unset
17811 .cindex "SMTP" "rate limiting"
17812 .cindex "limit" "rate of message arrival"
17813 .cindex "RCPT" "rate limiting"
17814 Some sites find it helpful to be able to limit the rate at which certain hosts
17815 can send them messages, and the rate at which an individual message can specify
17816 recipients.
17817
17818 Exim has two rate-limiting facilities. This section describes the older
17819 facility, which can limit rates within a single connection. The newer
17820 &%ratelimit%& ACL condition can limit rates across all connections. See section
17821 &<<SECTratelimiting>>& for details of the newer facility.
17822
17823 When a host matches &%smtp_ratelimit_hosts%&, the values of
17824 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17825 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17826 respectively. Each option, if set, must contain a set of four comma-separated
17827 values:
17828
17829 .ilist
17830 A threshold, before which there is no rate limiting.
17831 .next
17832 An initial time delay. Unlike other times in Exim, numbers with decimal
17833 fractional parts are allowed here.
17834 .next
17835 A factor by which to increase the delay each time.
17836 .next
17837 A maximum value for the delay. This should normally be less than 5 minutes,
17838 because after that time, the client is liable to timeout the SMTP command.
17839 .endlist
17840
17841 For example, these settings have been used successfully at the site which
17842 first suggested this feature, for controlling mail from their customers:
17843 .code
17844 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17845 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17846 .endd
17847 The first setting specifies delays that are applied to MAIL commands after
17848 two have been received over a single connection. The initial delay is 0.5
17849 seconds, increasing by a factor of 1.05 each time. The second setting applies
17850 delays to RCPT commands when more than four occur in a single message.
17851
17852
17853 .option smtp_ratelimit_mail main string unset
17854 See &%smtp_ratelimit_hosts%& above.
17855
17856
17857 .option smtp_ratelimit_rcpt main string unset
17858 See &%smtp_ratelimit_hosts%& above.
17859
17860
17861 .option smtp_receive_timeout main time&!! 5m
17862 .cindex "timeout" "for SMTP input"
17863 .cindex "SMTP" "input timeout"
17864 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17865 input, including batch SMTP. If a line of input (either an SMTP command or a
17866 data line) is not received within this time, the SMTP connection is dropped and
17867 the message is abandoned.
17868 A line is written to the log containing one of the following messages:
17869 .code
17870 SMTP command timeout on connection from...
17871 SMTP data timeout on connection from...
17872 .endd
17873 The former means that Exim was expecting to read an SMTP command; the latter
17874 means that it was in the DATA phase, reading the contents of a message.
17875
17876 If the first character of the option is a &"$"& the option is
17877 expanded before use and may depend on
17878 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17879
17880
17881 .oindex "&%-os%&"
17882 The value set by this option can be overridden by the
17883 &%-os%& command-line option. A setting of zero time disables the timeout, but
17884 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17885 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17886 timeout is controlled by &%receive_timeout%& and &%-or%&.
17887
17888
17889 .option smtp_reserve_hosts main "host list&!!" unset
17890 This option defines hosts for which SMTP connections are reserved; see
17891 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17892
17893
17894 .option smtp_return_error_details main boolean false
17895 .cindex "SMTP" "details policy failures"
17896 .cindex "policy control" "rejection, returning details"
17897 In the default state, Exim uses bland messages such as
17898 &"Administrative prohibition"& when it rejects SMTP commands for policy
17899 reasons. Many sysadmins like this because it gives away little information
17900 to spammers. However, some other sysadmins who are applying strict checking
17901 policies want to give out much fuller information about failures. Setting
17902 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17903 example, instead of &"Administrative prohibition"&, it might give:
17904 .code
17905 550-Rejected after DATA: '>' missing at end of address:
17906 550 failing address in "From" header is: <user@dom.ain
17907 .endd
17908
17909
17910 .option smtputf8_advertise_hosts main "host list&!!" *
17911 .cindex "SMTPUTF8" "ESMTP extension, advertising"
17912 .cindex "ESMTP extensions" SMTPUTF8
17913 When Exim is built with support for internationalised mail names,
17914 the availability thereof is advertised in
17915 response to EHLO only to those client hosts that match this option. See
17916 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17917
17918
17919 .option spamd_address main string "127.0.0.1 783"
17920 This option is available when Exim is compiled with the content-scanning
17921 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17922 See section &<<SECTscanspamass>>& for more details.
17923
17924
17925
17926 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17927 This option is available when Exim is compiled with SPF support.
17928 See section &<<SECSPF>>& for more details.
17929
17930 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
17931 This option is available when Exim is compiled with SPF support.  It
17932 allows the customisation of the SMTP comment that the SPF library
17933 generates.  You are strongly encouraged to link to your own explanative
17934 site. The template must not contain spaces. If you need spaces in the
17935 output, use the proper placeholder. If libspf2 can not parse the
17936 template, it uses a built-in default broken link. The following placeholders
17937 (along with Exim variables (but see below)) are allowed in the template:
17938 .ilist
17939 &*%_*&: A space.
17940 .next
17941 &*%{L}*&: Envelope sender's local part.
17942 .next
17943 &*%{S}*&: Envelope sender.
17944 .next
17945 &*%{O}*&: Envelope sender's domain.
17946 .next
17947 &*%{D}*&: Current(?) domain.
17948 .next
17949 &*%{I}*&: SMTP client Ip.
17950 .next
17951 &*%{C}*&: SMTP client pretty IP.
17952 .next
17953 &*%{T}*&: Epoch time (UTC).
17954 .next
17955 &*%{P}*&: SMTP client domain name.
17956 .next
17957 &*%{V}*&: IP version.
17958 .next
17959 &*%{H}*&: EHLO/HELO domain.
17960 .next
17961 &*%{R}*&: Receiving domain.
17962 .endlist
17963 The capitalized placeholders do proper URL encoding, if you use them
17964 lowercased, no encoding takes place.  This list was compiled from the
17965 libspf2 sources.
17966
17967 A note on using Exim variables: As
17968 currently the SPF library is initialized before the SMTP EHLO phase,
17969 the variables useful for expansion are quite limited.
17970
17971
17972 .option split_spool_directory main boolean false
17973 .cindex "multiple spool directories"
17974 .cindex "spool directory" "split"
17975 .cindex "directories, multiple"
17976 If this option is set, it causes Exim to split its input directory into 62
17977 subdirectories, each with a single alphanumeric character as its name. The
17978 sixth character of the message id is used to allocate messages to
17979 subdirectories; this is the least significant base-62 digit of the time of
17980 arrival of the message.
17981
17982 Splitting up the spool in this way may provide better performance on systems
17983 where there are long mail queues, by reducing the number of files in any one
17984 directory. The msglog directory is also split up in a similar way to the input
17985 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17986 are still placed in the single directory &_msglog.OLD_&.
17987
17988 It is not necessary to take any special action for existing messages when
17989 changing &%split_spool_directory%&. Exim notices messages that are in the
17990 &"wrong"& place, and continues to process them. If the option is turned off
17991 after a period of being on, the subdirectories will eventually empty and be
17992 automatically deleted.
17993
17994 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17995 changes. Instead of creating a list of all messages in the queue, and then
17996 trying to deliver each one, in turn, it constructs a list of those in one
17997 sub-directory and tries to deliver them, before moving on to the next
17998 sub-directory. The sub-directories are processed in a random order. This
17999 spreads out the scanning of the input directories, and uses less memory. It is
18000 particularly beneficial when there are lots of messages in the queue. However,
18001 if &%queue_run_in_order%& is set, none of this new processing happens. The
18002 entire queue has to be scanned and sorted before any deliveries can start.
18003
18004
18005 .option spool_directory main string&!! "set at compile time"
18006 .cindex "spool directory" "path to"
18007 This defines the directory in which Exim keeps its spool, that is, the messages
18008 it is waiting to deliver. The default value is taken from the compile-time
18009 configuration setting, if there is one. If not, this option must be set. The
18010 string is expanded, so it can contain, for example, a reference to
18011 &$primary_hostname$&.
18012
18013 If the spool directory name is fixed on your installation, it is recommended
18014 that you set it at build time rather than from this option, particularly if the
18015 log files are being written to the spool directory (see &%log_file_path%&).
18016 Otherwise log files cannot be used for errors that are detected early on, such
18017 as failures in the configuration file.
18018
18019 By using this option to override the compiled-in path, it is possible to run
18020 tests of Exim without using the standard spool.
18021
18022 .option spool_wireformat main boolean false
18023 .cindex "spool directory" "file formats"
18024 If this option is set, Exim may for some messages use an alternative format
18025 for data-files in the spool which matches the wire format.
18026 Doing this permits more efficient message reception and transmission.
18027 Currently it is only done for messages received using the ESMTP CHUNKING
18028 option.
18029
18030 The following variables will not have useful values:
18031 .code
18032 $max_received_linelength
18033 $body_linecount
18034 $body_zerocount
18035 .endd
18036
18037 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18038 and any external programs which are passed a reference to a message data file
18039 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18040 will need to be aware of the different formats potentially available.
18041
18042 Using any of the ACL conditions noted will negate the reception benefit
18043 (as a Unix-mbox-format file is constructed for them).
18044 The transmission benefit is maintained.
18045
18046 .option sqlite_lock_timeout main time 5s
18047 .cindex "sqlite lookup type" "lock timeout"
18048 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18049 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18050
18051 .option strict_acl_vars main boolean false
18052 .cindex "&ACL;" "variables, handling unset"
18053 This option controls what happens if a syntactically valid but undefined ACL
18054 variable is referenced. If it is false (the default), an empty string
18055 is substituted; if it is true, an error is generated. See section
18056 &<<SECTaclvariables>>& for details of ACL variables.
18057
18058 .option strip_excess_angle_brackets main boolean false
18059 .cindex "angle brackets, excess"
18060 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18061 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18062 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18063 passed on to another MTA, the excess angle brackets are not passed on. If this
18064 option is not set, multiple pairs of angle brackets cause a syntax error.
18065
18066
18067 .option strip_trailing_dot main boolean false
18068 .cindex "trailing dot on domain"
18069 .cindex "dot" "trailing on domain"
18070 If this option is set, a trailing dot at the end of a domain in an address is
18071 ignored. If this is in the envelope and the message is passed on to another
18072 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18073 domain causes a syntax error.
18074 However, addresses in header lines are checked only when an ACL requests header
18075 syntax checking.
18076
18077
18078 .option syslog_duplication main boolean true
18079 .cindex "syslog" "duplicate log lines; suppressing"
18080 When Exim is logging to syslog, it writes the log lines for its three
18081 separate logs at different syslog priorities so that they can in principle
18082 be separated on the logging hosts. Some installations do not require this
18083 separation, and in those cases, the duplication of certain log lines is a
18084 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18085 particular log line is written to syslog. For lines that normally go to
18086 both the main log and the reject log, the reject log version (possibly
18087 containing message header lines) is written, at LOG_NOTICE priority.
18088 Lines that normally go to both the main and the panic log are written at
18089 the LOG_ALERT priority.
18090
18091
18092 .option syslog_facility main string unset
18093 .cindex "syslog" "facility; setting"
18094 This option sets the syslog &"facility"& name, used when Exim is logging to
18095 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18096 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18097 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18098 details of Exim's logging.
18099
18100
18101 .option syslog_pid main boolean true
18102 .cindex "syslog" "pid"
18103 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18104 omitted when these lines are sent to syslog. (Syslog normally prefixes
18105 the log lines with the PID of the logging process automatically.) You need
18106 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18107 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18108
18109
18110
18111 .option syslog_processname main string &`exim`&
18112 .cindex "syslog" "process name; setting"
18113 This option sets the syslog &"ident"& name, used when Exim is logging to
18114 syslog. The value must be no longer than 32 characters. See chapter
18115 &<<CHAPlog>>& for details of Exim's logging.
18116
18117
18118
18119 .option syslog_timestamp main boolean true
18120 .cindex "syslog" "timestamps"
18121 .cindex timestamps syslog
18122 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18123 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18124 details of Exim's logging.
18125
18126
18127 .option system_filter main string&!! unset
18128 .cindex "filter" "system filter"
18129 .cindex "system filter" "specifying"
18130 .cindex "Sieve filter" "not available for system filter"
18131 This option specifies an Exim filter file that is applied to all messages at
18132 the start of each delivery attempt, before any routing is done. System filters
18133 must be Exim filters; they cannot be Sieve filters. If the system filter
18134 generates any deliveries to files or pipes, or any new mail messages, the
18135 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18136 which transports are to be used. Details of this facility are given in chapter
18137 &<<CHAPsystemfilter>>&.
18138 A forced expansion failure results in no filter operation.
18139
18140
18141 .option system_filter_directory_transport main string&!! unset
18142 .vindex "&$address_file$&"
18143 This sets the name of the transport driver that is to be used when the
18144 &%save%& command in a system message filter specifies a path ending in &"/"&,
18145 implying delivery of each message into a separate file in some directory.
18146 During the delivery, the variable &$address_file$& contains the path name.
18147
18148
18149 .option system_filter_file_transport main string&!! unset
18150 .cindex "file" "transport for system filter"
18151 This sets the name of the transport driver that is to be used when the &%save%&
18152 command in a system message filter specifies a path not ending in &"/"&. During
18153 the delivery, the variable &$address_file$& contains the path name.
18154
18155 .option system_filter_group main string unset
18156 .cindex "gid (group id)" "system filter"
18157 This option is used only when &%system_filter_user%& is also set. It sets the
18158 gid under which the system filter is run, overriding any gid that is associated
18159 with the user. The value may be numerical or symbolic.
18160
18161 .option system_filter_pipe_transport main string&!! unset
18162 .cindex "&(pipe)& transport" "for system filter"
18163 .vindex "&$address_pipe$&"
18164 This specifies the transport driver that is to be used when a &%pipe%& command
18165 is used in a system filter. During the delivery, the variable &$address_pipe$&
18166 contains the pipe command.
18167
18168
18169 .option system_filter_reply_transport main string&!! unset
18170 .cindex "&(autoreply)& transport" "for system filter"
18171 This specifies the transport driver that is to be used when a &%mail%& command
18172 is used in a system filter.
18173
18174
18175 .option system_filter_user main string unset
18176 .cindex "uid (user id)" "system filter"
18177 If this option is set to root, the system filter is run in the main Exim
18178 delivery process, as root.  Otherwise, the system filter runs in a separate
18179 process, as the given user, defaulting to the Exim run-time user.
18180 Unless the string consists entirely of digits, it
18181 is looked up in the password data. Failure to find the named user causes a
18182 configuration error. The gid is either taken from the password data, or
18183 specified by &%system_filter_group%&. When the uid is specified numerically,
18184 &%system_filter_group%& is required to be set.
18185
18186 If the system filter generates any pipe, file, or reply deliveries, the uid
18187 under which the filter is run is used when transporting them, unless a
18188 transport option overrides.
18189
18190
18191 .option tcp_nodelay main boolean true
18192 .cindex "daemon" "TCP_NODELAY on sockets"
18193 .cindex "Nagle algorithm"
18194 .cindex "TCP_NODELAY on listening sockets"
18195 If this option is set false, it stops the Exim daemon setting the
18196 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18197 turns off the &"Nagle algorithm"&, which is a way of improving network
18198 performance in interactive (character-by-character) situations. Turning it off
18199 should improve Exim's performance a bit, so that is what happens by default.
18200 However, it appears that some broken clients cannot cope, and time out. Hence
18201 this option. It affects only those sockets that are set up for listening by the
18202 daemon. Sockets created by the smtp transport for delivering mail always set
18203 TCP_NODELAY.
18204
18205
18206 .option timeout_frozen_after main time 0s
18207 .cindex "frozen messages" "timing out"
18208 .cindex "timeout" "frozen messages"
18209 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18210 message of any kind that has been in the queue for longer than the given time
18211 is automatically cancelled at the next queue run. If the frozen message is a
18212 bounce message, it is just discarded; otherwise, a bounce is sent to the
18213 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18214 If you want to timeout frozen bounce messages earlier than other kinds of
18215 frozen message, see &%ignore_bounce_errors_after%&.
18216
18217 &*Note:*& the default value of zero means no timeouts; with this setting,
18218 frozen messages remain in the queue forever (except for any frozen bounce
18219 messages that are released by &%ignore_bounce_errors_after%&).
18220
18221
18222 .option timezone main string unset
18223 .cindex "timezone, setting"
18224 .cindex "environment" "values from"
18225 The value of &%timezone%& is used to set the environment variable TZ while
18226 running Exim (if it is different on entry). This ensures that all timestamps
18227 created by Exim are in the required timezone. If you want all your timestamps
18228 to be in UTC (aka GMT) you should set
18229 .code
18230 timezone = UTC
18231 .endd
18232 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18233 or, if that is not set, from the value of the TZ environment variable when Exim
18234 is built. If &%timezone%& is set to the empty string, either at build or run
18235 time, any existing TZ variable is removed from the environment when Exim
18236 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18237 unfortunately not all, operating systems.
18238
18239
18240 .option tls_advertise_hosts main "host list&!!" *
18241 .cindex "TLS" "advertising"
18242 .cindex "encryption" "on SMTP connection"
18243 .cindex "SMTP" "encrypted connection"
18244 .cindex "ESMTP extensions" STARTTLS
18245 When Exim is built with support for TLS encrypted connections, the availability
18246 of the STARTTLS command to set up an encrypted session is advertised in
18247 response to EHLO only to those client hosts that match this option. See
18248 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18249 Note that the default value requires that a certificate be supplied
18250 using the &%tls_certificate%& option.  If TLS support for incoming connections
18251 is not required the &%tls_advertise_hosts%& option should be set empty.
18252
18253
18254 .option tls_alpn main "string list&!!" "smtp : esmtp"
18255 .cindex TLS "Application Layer Protocol Names"
18256 .cindex TLS ALPN
18257 .cindex ALPN "set acceptable names for server"
18258 If this option is set,
18259 the TLS library supports ALPN,
18260 and the client offers either more than
18261 ALPN name or a name which does not match the list,
18262 the TLS connection is declined.
18263
18264
18265 .option tls_certificate main "string list&!!" unset
18266 .cindex "TLS" "server certificate; location of"
18267 .cindex "certificate" "server, location of"
18268 The value of this option is expanded, and must then be a list of absolute paths to
18269 files which contain the server's certificates (in PEM format).
18270 Commonly only one file is needed.
18271 The server's private key is also
18272 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18273 &<<CHAPTLS>>& for further details.
18274
18275 &*Note*&: The certificates defined by this option are used only when Exim is
18276 receiving incoming messages as a server. If you want to supply certificates for
18277 use when sending messages as a client, you must set the &%tls_certificate%&
18278 option in the relevant &(smtp)& transport.
18279
18280 &*Note*&: If you use filenames based on IP addresses, change the list
18281 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18282
18283 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18284 when a list of more than one
18285 file is used, the &$tls_in_ourcert$& variable is unreliable.
18286 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18287
18288 .cindex SNI "selecting server certificate based on"
18289 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18290 if the OpenSSL build supports TLS extensions and the TLS client sends the
18291 Server Name Indication extension, then this option and others documented in
18292 &<<SECTtlssni>>& will be re-expanded.
18293
18294 If this option is unset or empty a self-signed certificate will be
18295 used.
18296 Under Linux this is generated at daemon startup; on other platforms it will be
18297 generated fresh for every connection.
18298
18299 .option tls_crl main string&!! unset
18300 .cindex "TLS" "server certificate revocation list"
18301 .cindex "certificate" "revocation list for server"
18302 This option specifies a certificate revocation list. The expanded value must
18303 be the name of a file that contains CRLs in PEM format.
18304
18305 Under OpenSSL the option can specify a directory with CRL files.
18306
18307 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18308 for each signing element of the certificate chain (i.e. all but the leaf).
18309 For the file variant this can be multiple PEM blocks in the one file.
18310
18311 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18312
18313
18314 .option tls_dh_max_bits main integer 2236
18315 .cindex "TLS" "D-H bit count"
18316 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18317 the chosen TLS library.  That value might prove to be too high for
18318 interoperability.  This option provides a maximum clamp on the value
18319 suggested, trading off security for interoperability.
18320
18321 The value must be at least 1024.
18322
18323 The value 2236 was chosen because, at time of adding the option, it was the
18324 hard-coded maximum value supported by the NSS cryptographic library, as used
18325 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18326
18327 If you prefer more security and are willing to break some clients, raise this
18328 number.
18329
18330 Note that the value passed to GnuTLS for *generating* a new prime may be a
18331 little less than this figure, because GnuTLS is inexact and may produce a
18332 larger prime than requested.
18333
18334
18335 .option tls_dhparam main string&!! unset
18336 .cindex "TLS" "D-H parameters for server"
18337 The value of this option is expanded and indicates the source of DH parameters
18338 to be used by Exim.
18339
18340 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
18341 local DH parameters*&, which has been supported across all versions of Exim.  The
18342 other specific constants available are a fallback so that even when
18343 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18344
18345 If &%tls_dhparam%& is a filename starting with a &`/`&,
18346 then it names a file from which DH
18347 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18348 PKCS#3 representation of the DH prime.  If the file does not exist, for
18349 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18350 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18351 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18352 and treated as though the &%tls_dhparam%& were set to "none".
18353
18354 If this option expands to the string "none", then no DH parameters will be
18355 loaded by Exim.
18356
18357 If this option expands to the string "historic" and Exim is using GnuTLS, then
18358 Exim will attempt to load a file from inside the spool directory.  If the file
18359 does not exist, Exim will attempt to create it.
18360 See section &<<SECTgnutlsparam>>& for further details.
18361
18362 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18363 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18364
18365 In older versions of Exim the default was the 2048 bit prime described in section
18366 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18367 in IKE is assigned number 23.
18368
18369 Otherwise, the option must expand to the name used by Exim for any of a number
18370 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18371 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18372 the number used by IKE, or "default" which corresponds to
18373 &`exim.dev.20160529.3`&.
18374
18375 The available standard primes are:
18376 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18377 &`ike1`&, &`ike2`&, &`ike5`&,
18378 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18379 &`ike22`&, &`ike23`& and &`ike24`&.
18380
18381 The available additional primes are:
18382 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18383
18384 Some of these will be too small to be accepted by clients.
18385 Some may be too large to be accepted by clients.
18386 The open cryptographic community has suspicions about the integrity of some
18387 of the later IKE values, which led into RFC7919 providing new fixed constants
18388 (the "ffdhe" identifiers).
18389
18390 At this point, all of the "ike" values should be considered obsolete;
18391 they are still in Exim to avoid breaking unusual configurations, but are
18392 candidates for removal the next time we have backwards-incompatible changes.
18393 Two of them in particular (&`ike1`& and &`ike22`&) are called out by RFC 8247
18394 as MUST NOT use for IPSEC, and two more (&`ike23`& and &`ike24`&) as
18395 SHOULD NOT.
18396 Because of this, Exim regards them as deprecated; if either of the first pair
18397 are used, warnings will be logged in the paniclog, and if any are used then
18398 warnings will be logged in the mainlog.
18399 All four will be removed in a future Exim release.
18400
18401 The TLS protocol does not negotiate an acceptable size for this; clients tend
18402 to hard-drop connections if what is offered by the server is unacceptable,
18403 whether too large or too small, and there's no provision for the client to
18404 tell the server what these constraints are.  Thus, as a server operator, you
18405 need to make an educated guess as to what is most likely to work for your
18406 userbase.
18407
18408 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18409 is most likely to maximise interoperability.  The upper bound comes from
18410 applications using the Mozilla Network Security Services (NSS) library, which
18411 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18412 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18413 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18414 acceptable bound from 1024 to 2048.
18415
18416
18417 .option tls_eccurve main string&!! &`auto`&
18418 .cindex TLS "EC cryptography"
18419 This option selects a EC curve for use by Exim when used with OpenSSL.
18420 It has no effect when Exim is used with GnuTLS.
18421
18422 After expansion it must contain a valid EC curve parameter, such as
18423 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
18424 for valid selections.
18425
18426 For OpenSSL versions before (and not including) 1.0.2, the string
18427 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18428 &`auto`& tells the library to choose.
18429
18430 If the option expands to an empty string, no EC curves will be enabled.
18431
18432
18433 .option tls_ocsp_file main string&!! unset
18434 .cindex TLS "certificate status"
18435 .cindex TLS "OCSP proof file"
18436 This option
18437 must if set expand to the absolute path to a file which contains a current
18438 status proof for the server's certificate, as obtained from the
18439 Certificate Authority.
18440
18441 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18442 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18443
18444 For OpenSSL 1.1.0 or later, and
18445 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18446 of files, to match a list given for the &%tls_certificate%& option.
18447 The ordering of the two lists must match.
18448 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18449
18450 The file(s) should be in DER format,
18451 except for GnuTLS 3.6.3 or later
18452 or for OpenSSL,
18453 when an optional filetype prefix can be used.
18454 The prefix must be one of "DER" or "PEM", followed by
18455 a single space.  If one is used it sets the format for subsequent
18456 files in the list; the initial format is DER.
18457 If multiple proofs are wanted, for multiple chain elements
18458 (this only works under TLS1.3)
18459 they must be coded as a combined OCSP response.
18460
18461 Although GnuTLS will accept PEM files with multiple separate
18462 PEM blobs (ie. separate OCSP responses), it sends them in the
18463 TLS Certificate record interleaved with the certificates of the chain;
18464 although a GnuTLS client is happy with that, an OpenSSL client is not.
18465
18466 .option tls_on_connect_ports main "string list" unset
18467 .cindex SSMTP
18468 .cindex SMTPS
18469 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18470 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18471 set up without waiting for the client to issue a STARTTLS command. For
18472 further details, see section &<<SECTsupobssmt>>&.
18473
18474
18475
18476 .option tls_privatekey main "string list&!!" unset
18477 .cindex "TLS" "server private key; location of"
18478 The value of this option is expanded, and must then be a list of absolute paths to
18479 files which contains the server's private keys.
18480 If this option is unset, or if
18481 the expansion is forced to fail, or the result is an empty string, the private
18482 key is assumed to be in the same file as the server's certificates. See chapter
18483 &<<CHAPTLS>>& for further details.
18484
18485 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18486
18487
18488 .option tls_remember_esmtp main boolean false
18489 .cindex "TLS" "esmtp state; remembering"
18490 .cindex "TLS" "broken clients"
18491 If this option is set true, Exim violates the RFCs by remembering that it is in
18492 &"esmtp"& state after successfully negotiating a TLS session. This provides
18493 support for broken clients that fail to send a new EHLO after starting a
18494 TLS session.
18495
18496
18497 .option tls_require_ciphers main string&!! unset
18498 .cindex "TLS" "requiring specific ciphers"
18499 .cindex "cipher" "requiring specific"
18500 This option controls which ciphers can be used for incoming TLS connections.
18501 The &(smtp)& transport has an option of the same name for controlling outgoing
18502 connections. This option is expanded for each connection, so can be varied for
18503 different clients if required. The value of this option must be a list of
18504 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18505 in somewhat different ways. If GnuTLS is being used, the client controls the
18506 preference order of the available ciphers. Details are given in sections
18507 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18508
18509
18510 .option tls_resumption_hosts main "host list&!!" unset
18511 .cindex TLS resumption
18512 This option controls which connections to offer the TLS resumption feature.
18513 See &<<SECTresumption>>& for details.
18514
18515
18516 .option tls_try_verify_hosts main "host list&!!" unset
18517 .cindex "TLS" "client certificate verification"
18518 .cindex "certificate" "verification of client"
18519 See &%tls_verify_hosts%& below.
18520
18521
18522 .option tls_verify_certificates main string&!! system
18523 .cindex "TLS" "client certificate verification"
18524 .cindex "certificate" "verification of client"
18525 The value of this option is expanded, and must then be either the
18526 word "system"
18527 or the absolute path to
18528 a file or directory containing permitted certificates for clients that
18529 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18530
18531 The "system" value for the option will use a
18532 system default location compiled into the SSL library.
18533 This is not available for GnuTLS versions preceding 3.0.20,
18534 and will be taken as empty; an explicit location
18535 must be specified.
18536
18537 The use of a directory for the option value is not available for GnuTLS versions
18538 preceding 3.3.6 and a single file must be used.
18539
18540 With OpenSSL the certificates specified
18541 explicitly
18542 either by file or directory
18543 are added to those given by the system default location.
18544
18545 These certificates should be for the certificate authorities trusted, rather
18546 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18547 the value is a file then the certificates are sent by Exim as a server to
18548 connecting clients, defining the list of accepted certificate authorities.
18549 Thus the values defined should be considered public data.  To avoid this,
18550 use the explicit directory version. (If your peer is Exim up to 4.85,
18551 using GnuTLS, you may need to send the CAs (thus using the file
18552 variant). Otherwise the peer doesn't send its certificate.)
18553
18554 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18555
18556 A forced expansion failure or setting to an empty string is equivalent to
18557 being unset.
18558
18559
18560 .option tls_verify_hosts main "host list&!!" unset
18561 .cindex "TLS" "client certificate verification"
18562 .cindex "certificate" "verification of client"
18563 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18564 certificates from clients. The expected certificates are defined by
18565 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18566 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18567 &%tls_verify_certificates%& is not set.
18568
18569 Any client that matches &%tls_verify_hosts%& is constrained by
18570 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18571 present one of the listed certificates. If it does not, the connection is
18572 aborted.
18573 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18574 the host to use TLS. It can still send SMTP commands through unencrypted
18575 connections. Forcing a client to use TLS has to be done separately using an
18576 ACL to reject inappropriate commands when the connection is not encrypted.
18577
18578 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18579 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18580 certificate and checks it against &%tls_verify_certificates%&, but does not
18581 abort the connection if there is no certificate or if it does not match. This
18582 state can be detected in an ACL, which makes it possible to implement policies
18583 such as &"accept for relay only if a verified certificate has been received,
18584 but accept for local delivery if encrypted, even without a verified
18585 certificate"&.
18586
18587 Client hosts that match neither of these lists are not asked to present
18588 certificates.
18589
18590
18591 .option trusted_groups main "string list&!!" unset
18592 .cindex "trusted groups"
18593 .cindex "groups" "trusted"
18594 This option is expanded just once, at the start of Exim's processing. If this
18595 option is set, any process that is running in one of the listed groups, or
18596 which has one of them as a supplementary group, is trusted. The groups can be
18597 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18598 details of what trusted callers are permitted to do. If neither
18599 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18600 are trusted.
18601
18602 .option trusted_users main "string list&!!" unset
18603 .cindex "trusted users"
18604 .cindex "user" "trusted"
18605 This option is expanded just once, at the start of Exim's processing. If this
18606 option is set, any process that is running as one of the listed users is
18607 trusted. The users can be specified numerically or by name. See section
18608 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18609 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18610 Exim user are trusted.
18611
18612 .option unknown_login main string&!! unset
18613 .cindex "uid (user id)" "unknown caller"
18614 .vindex "&$caller_uid$&"
18615 This is a specialized feature for use in unusual configurations. By default, if
18616 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18617 gives up. The &%unknown_login%& option can be used to set a login name to be
18618 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18619 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18620 is used for the user's real name (gecos field), unless this has been set by the
18621 &%-F%& option.
18622
18623 .option unknown_username main string unset
18624 See &%unknown_login%&.
18625
18626 .option untrusted_set_sender main "address list&!!" unset
18627 .cindex "trusted users"
18628 .cindex "sender" "setting by untrusted user"
18629 .cindex "untrusted user setting sender"
18630 .cindex "user" "untrusted setting sender"
18631 .cindex "envelope from"
18632 .cindex "envelope sender"
18633 When an untrusted user submits a message to Exim using the standard input, Exim
18634 normally creates an envelope sender address from the user's login and the
18635 default qualification domain. Data from the &%-f%& option (for setting envelope
18636 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18637 is used) is ignored.
18638
18639 However, untrusted users are permitted to set an empty envelope sender address,
18640 to declare that a message should never generate any bounces. For example:
18641 .code
18642 exim -f '<>' user@domain.example
18643 .endd
18644 .vindex "&$sender_ident$&"
18645 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18646 other envelope sender addresses in a controlled way. When it is set, untrusted
18647 users are allowed to set envelope sender addresses that match any of the
18648 patterns in the list. Like all address lists, the string is expanded. The
18649 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18650 users to setting senders that start with their login ids
18651 followed by a hyphen
18652 by a setting like this:
18653 .code
18654 untrusted_set_sender = ^$sender_ident-
18655 .endd
18656 If you want to allow untrusted users to set envelope sender addresses without
18657 restriction, you can use
18658 .code
18659 untrusted_set_sender = *
18660 .endd
18661 The &%untrusted_set_sender%& option applies to all forms of local input, but
18662 only to the setting of the envelope sender. It does not permit untrusted users
18663 to use the other options which trusted user can use to override message
18664 parameters. Furthermore, it does not stop Exim from removing an existing
18665 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18666 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18667 overriding these actions. The handling of the &'Sender:'& header is also
18668 described in section &<<SECTthesenhea>>&.
18669
18670 The log line for a message's arrival shows the envelope sender following
18671 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18672 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18673 envelope sender address, the user's login is shown in parentheses after the
18674 sender address.
18675
18676
18677 .option uucp_from_pattern main string "see below"
18678 .cindex "&""From""& line"
18679 .cindex "UUCP" "&""From""& line"
18680 Some applications that pass messages to an MTA via a command line interface use
18681 an initial line starting with &"From&~"& to pass the envelope sender. In
18682 particular, this is used by UUCP software. Exim recognizes such a line by means
18683 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18684 matches, the sender address is constructed by expanding the contents of
18685 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18686 default pattern recognizes lines in the following two forms:
18687 .code
18688 From ph10 Fri Jan  5 12:35 GMT 1996
18689 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18690 .endd
18691 The pattern can be seen by running
18692 .code
18693 exim -bP uucp_from_pattern
18694 .endd
18695 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18696 year in the second case. The first word after &"From&~"& is matched in the
18697 regular expression by a parenthesized subpattern. The default value for
18698 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18699 (&"ph10"& in the example above) as the message's sender. See also
18700 &%ignore_fromline_hosts%&.
18701
18702
18703 .option uucp_from_sender main string&!! &`$1`&
18704 See &%uucp_from_pattern%& above.
18705
18706
18707 .option warn_message_file main string&!! unset
18708 .cindex "warning of delay" "customizing the message"
18709 .cindex "customizing" "warning message"
18710 This option defines a template file containing paragraphs of text to be used
18711 for constructing the warning message which is sent by Exim when a message has
18712 been in the queue for a specified amount of time, as specified by
18713 &%delay_warning%&. Details of the file's contents are given in chapter
18714 &<<CHAPemsgcust>>&.
18715 .cindex warn_message_file "tainted data"
18716 The option is expanded to give the file path, which must be
18717 absolute and untainted.
18718 See also &%bounce_message_file%&.
18719
18720
18721 .option write_rejectlog main boolean true
18722 .cindex "reject log" "disabling"
18723 If this option is set false, Exim no longer writes anything to the reject log.
18724 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18725 .ecindex IIDconfima
18726 .ecindex IIDmaiconf
18727
18728
18729
18730
18731 . ////////////////////////////////////////////////////////////////////////////
18732 . ////////////////////////////////////////////////////////////////////////////
18733
18734 .chapter "Generic options for routers" "CHAProutergeneric"
18735 .scindex IIDgenoprou1 "options" "generic; for routers"
18736 .scindex IIDgenoprou2 "generic options" "router"
18737 This chapter describes the generic options that apply to all routers.
18738 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18739
18740 For a general description of how a router operates, see sections
18741 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18742 which the preconditions are tested. The order of expansion of the options that
18743 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18744 &%headers_remove%&, &%transport%&.
18745
18746 The name of a router is limited to be &drivernamemax; ASCII characters long;
18747 prior to Exim 4.95 names would be silently truncated at this length, but now
18748 it is enforced.
18749
18750
18751 .option address_data routers string&!! unset
18752 .cindex "router" "data attached to address"
18753 The string is expanded just before the router is run, that is, after all the
18754 precondition tests have succeeded. If the expansion is forced to fail, the
18755 router declines, the value of &%address_data%& remains unchanged, and the
18756 &%more%& option controls what happens next. Other expansion failures cause
18757 delivery of the address to be deferred.
18758
18759 .vindex "&$address_data$&"
18760 When the expansion succeeds, the value is retained with the address, and can be
18761 accessed using the variable &$address_data$& in the current router, subsequent
18762 routers, and the eventual transport.
18763
18764 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18765 that runs a user's filter file, the contents of &$address_data$& are accessible
18766 in the filter. This is not normally a problem, because such data is usually
18767 either not confidential or it &"belongs"& to the current user, but if you do
18768 put confidential data into &$address_data$& you need to remember this point.
18769
18770 Even if the router declines or passes, the value of &$address_data$& remains
18771 with the address, though it can be changed by another &%address_data%& setting
18772 on a subsequent router. If a router generates child addresses, the value of
18773 &$address_data$& propagates to them. This also applies to the special kind of
18774 &"child"& that is generated by a router with the &%unseen%& option.
18775
18776 The idea of &%address_data%& is that you can use it to look up a lot of data
18777 for the address once, and then pick out parts of the data later. For example,
18778 you could use a single LDAP lookup to return a string of the form
18779 .code
18780 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18781 .endd
18782 In the transport you could pick out the mailbox by a setting such as
18783 .code
18784 file = ${extract{mailbox}{$address_data}}
18785 .endd
18786 This makes the configuration file less messy, and also reduces the number of
18787 lookups (though Exim does cache lookups).
18788
18789 See also the &%set%& option below.
18790
18791 .vindex "&$sender_address_data$&"
18792 .vindex "&$address_data$&"
18793 The &%address_data%& facility is also useful as a means of passing information
18794 from one router to another, and from a router to a transport. In addition, if
18795 &$address_data$& is set by a router when verifying a recipient address from an
18796 ACL, it remains available for use in the rest of the ACL statement. After
18797 verifying a sender, the value is transferred to &$sender_address_data$&.
18798
18799
18800
18801 .option address_test routers&!? boolean true
18802 .oindex "&%-bt%&"
18803 .cindex "router" "skipping when address testing"
18804 If this option is set false, the router is skipped when routing is being tested
18805 by means of the &%-bt%& command line option. This can be a convenience when
18806 your first router sends messages to an external scanner, because it saves you
18807 having to set the &"already scanned"& indicator when testing real address
18808 routing.
18809
18810
18811
18812 .option cannot_route_message routers string&!! unset
18813 .cindex "router" "customizing &""cannot route""& message"
18814 .cindex "customizing" "&""cannot route""& message"
18815 This option specifies a text message that is used when an address cannot be
18816 routed because Exim has run out of routers. The default message is
18817 &"Unrouteable address"&. This option is useful only on routers that have
18818 &%more%& set false, or on the very last router in a configuration, because the
18819 value that is used is taken from the last router that is considered. This
18820 includes a router that is skipped because its preconditions are not met, as
18821 well as a router that declines. For example, using the default configuration,
18822 you could put:
18823 .code
18824 cannot_route_message = Remote domain not found in DNS
18825 .endd
18826 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18827 and
18828 .code
18829 cannot_route_message = Unknown local user
18830 .endd
18831 on the final router that checks for local users. If string expansion fails for
18832 this option, the default message is used. Unless the expansion failure was
18833 explicitly forced, a message about the failure is written to the main and panic
18834 logs, in addition to the normal message about the routing failure.
18835
18836
18837 .option caseful_local_part routers boolean false
18838 .cindex "case of local parts"
18839 .cindex "router" "case of local parts"
18840 By default, routers handle the local parts of addresses in a case-insensitive
18841 manner, though the actual case is preserved for transmission with the message.
18842 If you want the case of letters to be significant in a router, you must set
18843 this option true. For individual router options that contain address or local
18844 part lists (for example, &%local_parts%&), case-sensitive matching can be
18845 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18846 more details.
18847
18848 .vindex "&$local_part$&"
18849 .vindex "&$original_local_part$&"
18850 .vindex "&$parent_local_part$&"
18851 The value of the &$local_part$& variable is forced to lower case while a
18852 router is running unless &%caseful_local_part%& is set. When a router assigns
18853 an address to a transport, the value of &$local_part$& when the transport runs
18854 is the same as it was in the router. Similarly, when a router generates child
18855 addresses by aliasing or forwarding, the values of &$original_local_part$&
18856 and &$parent_local_part$& are those that were used by the redirecting router.
18857
18858 This option applies to the processing of an address by a router. When a
18859 recipient address is being processed in an ACL, there is a separate &%control%&
18860 modifier that can be used to specify case-sensitive processing within the ACL
18861 (see section &<<SECTcontrols>>&).
18862
18863
18864
18865 .option check_local_user routers&!? boolean false
18866 .cindex "local user, checking in router"
18867 .cindex "router" "checking for local user"
18868 .cindex "&_/etc/passwd_&"
18869 .vindex "&$home$&"
18870 When this option is true, Exim checks that the local part of the recipient
18871 address (with affixes removed if relevant) is the name of an account on the
18872 local system. The check is done by calling the &[getpwnam()]& function rather
18873 than trying to read &_/etc/passwd_& directly. This means that other methods of
18874 holding password data (such as NIS) are supported. If the local part is a local
18875 user,
18876 .cindex "tainted data" "de-tainting"
18877 .cindex "de-tainting" "using router check_local_user option"
18878 &$local_part_data$& is set to an untainted version of the local part and
18879 &$home$& is set from the password data. The latter can be tested in other
18880 preconditions that are evaluated after this one (the order of evaluation is
18881 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18882 overridden by &%router_home_directory%&. If the local part is not a local user,
18883 the router is skipped.
18884
18885 If you want to check that the local part is either the name of a local user
18886 or matches something else, you cannot combine &%check_local_user%& with a
18887 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18888 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18889 setting to achieve this. For example:
18890 .code
18891 local_parts = passwd;$local_part : lsearch;/etc/other/users
18892 .endd
18893 Note, however, that the side effects of &%check_local_user%& (such as setting
18894 up a home directory) do not occur when a &(passwd)& lookup is used in a
18895 &%local_parts%& (or any other) precondition.
18896
18897
18898
18899 .option condition routers&!? string&!! unset
18900 .cindex "router" "customized precondition"
18901 This option specifies a general precondition test that has to succeed for the
18902 router to be called. The &%condition%& option is the last precondition to be
18903 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18904 result is a forced failure, or an empty string, or one of the strings &"0"& or
18905 &"no"& or &"false"& (checked without regard to the case of the letters), the
18906 router is skipped, and the address is offered to the next one.
18907
18908 If the result is any other value, the router is run (as this is the last
18909 precondition to be evaluated, all the other preconditions must be true).
18910
18911 This option is unusual in that multiple &%condition%& options may be present.
18912 All &%condition%& options must succeed.
18913
18914 The &%condition%& option provides a means of applying custom conditions to the
18915 running of routers. Note that in the case of a simple conditional expansion,
18916 the default expansion values are exactly what is wanted. For example:
18917 .code
18918 condition = ${if >{$message_age}{600}}
18919 .endd
18920 Because of the default behaviour of the string expansion, this is equivalent to
18921 .code
18922 condition = ${if >{$message_age}{600}{true}{}}
18923 .endd
18924
18925 A multiple condition example, which succeeds:
18926 .code
18927 condition = ${if >{$message_age}{600}}
18928 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18929 condition = foobar
18930 .endd
18931
18932 If the expansion fails (other than forced failure) delivery is deferred. Some
18933 of the other precondition options are common special cases that could in fact
18934 be specified using &%condition%&.
18935
18936 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18937 are far older, and use one set of semantics.  ACLs are newer and when
18938 they were created, the ACL &%condition%& process was given far stricter
18939 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18940 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18941 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18942 Router rules processing behavior.
18943
18944 This is best illustrated in an example:
18945 .code
18946 # If used in an ACL condition will fail with a syntax error, but
18947 # in a router condition any extra characters are treated as a string
18948
18949 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18950 true {yes} {no}}
18951
18952 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18953  {yes} {no}}
18954 .endd
18955 In each example above, the &%if%& statement actually ends after
18956 &"{google.com}}"&.  Since no true or false braces were defined, the
18957 default &%if%& behavior is to return a boolean true or a null answer
18958 (which evaluates to false). The rest of the line is then treated as a
18959 string. So the first example resulted in the boolean answer &"true"&
18960 with the string &" {yes} {no}}"& appended to it. The second example
18961 resulted in the null output (indicating false) with the string
18962 &" {yes} {no}}"& appended to it.
18963
18964 In fact you can put excess forward braces in too.  In the router
18965 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18966 mean something, like after a &"$"& or when required as part of a
18967 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18968 string characters.
18969
18970 Thus, in a Router, the above expansion strings will both always evaluate
18971 true, as the result of expansion is a non-empty string which doesn't
18972 match an explicit false value.  This can be tricky to debug.  By
18973 contrast, in an ACL either of those strings will always result in an
18974 expansion error because the result doesn't look sufficiently boolean.
18975
18976
18977 .option debug_print routers string&!! unset
18978 .cindex "testing" "variables in drivers"
18979 If this option is set and debugging is enabled (see the &%-d%& command line
18980 option) or in address-testing mode (see the &%-bt%& command line option),
18981 the string is expanded and included in the debugging output.
18982 If expansion of the string fails, the error message is written to the debugging
18983 output, and Exim carries on processing.
18984 This option is provided to help with checking out the values of variables and
18985 so on when debugging router configurations. For example, if a &%condition%&
18986 option appears not to be working, &%debug_print%& can be used to output the
18987 variables it references. The output happens after checks for &%domains%&,
18988 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18989 are tested. A newline is added to the text if it does not end with one.
18990 The variable &$router_name$& contains the name of the router.
18991
18992
18993
18994 .option disable_logging routers boolean false
18995 If this option is set true, nothing is logged for any routing errors
18996 or for any deliveries caused by this router. You should not set this option
18997 unless you really, really know what you are doing. See also the generic
18998 transport option of the same name.
18999
19000 .option dnssec_request_domains routers "domain list&!!" *
19001 .cindex "MX record" "security"
19002 .cindex "DNSSEC" "MX lookup"
19003 .cindex "security" "MX lookup"
19004 .cindex "DNS" "DNSSEC"
19005 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
19006 the DNSSEC request bit set.
19007 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19008
19009 .option dnssec_require_domains routers "domain list&!!" unset
19010 .cindex "MX record" "security"
19011 .cindex "DNSSEC" "MX lookup"
19012 .cindex "security" "MX lookup"
19013 .cindex "DNS" "DNSSEC"
19014 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19015 the DNSSEC request bit set.  Any returns not having the Authenticated Data bit
19016 (AD bit) set will be ignored and logged as a host-lookup failure.
19017 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19018
19019
19020 .option domains routers&!? "domain list&!!" unset
19021 .cindex "router" "restricting to specific domains"
19022 .vindex "&$domain_data$&"
19023 If this option is set, the router is skipped unless the current domain matches
19024 the list. If the match is achieved by means of a file lookup, the data that the
19025 lookup returned for the domain is placed in &$domain_data$& for use in string
19026 expansions of the driver's private options and in the transport.
19027 See section &<<SECTrouprecon>>& for
19028 a list of the order in which preconditions are evaluated.
19029
19030
19031
19032 .option driver routers string unset
19033 This option must always be set. It specifies which of the available routers is
19034 to be used.
19035
19036
19037 .option dsn_lasthop routers boolean false
19038 .cindex "DSN" "success"
19039 .cindex "Delivery Status Notification" "success"
19040 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19041 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19042 instead send a success DSN as if the next hop does not support DSN.
19043 Not effective on redirect routers.
19044
19045
19046
19047 .option errors_to routers string&!! unset
19048 .cindex "envelope from"
19049 .cindex "envelope sender"
19050 .cindex "router" "changing address for errors"
19051 If a router successfully handles an address, it may assign the address to a
19052 transport for delivery or it may generate child addresses. In both cases, if
19053 there is a delivery problem during later processing, the resulting bounce
19054 message is sent to the address that results from expanding this string,
19055 provided that the address verifies successfully. The &%errors_to%& option is
19056 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19057
19058 The &%errors_to%& setting associated with an address can be overridden if it
19059 subsequently passes through other routers that have their own &%errors_to%&
19060 settings, or if the message is delivered by a transport with a &%return_path%&
19061 setting.
19062
19063 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19064 the expansion fails to verify, the errors address associated with the incoming
19065 address is used. At top level, this is the envelope sender. A non-forced
19066 expansion failure causes delivery to be deferred.
19067
19068 If an address for which &%errors_to%& has been set ends up being delivered over
19069 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19070 any bounces that are generated by other MTAs on the delivery route are also
19071 sent there. You can set &%errors_to%& to the empty string by either of these
19072 settings:
19073 .code
19074 errors_to =
19075 errors_to = ""
19076 .endd
19077 An expansion item that yields an empty string has the same effect. If you do
19078 this, a locally detected delivery error for addresses processed by this router
19079 no longer gives rise to a bounce message; the error is discarded. If the
19080 address is delivered to a remote host, the return path is set to &`<>`&, unless
19081 overridden by the &%return_path%& option on the transport.
19082
19083 .vindex "&$address_data$&"
19084 If for some reason you want to discard local errors, but use a non-empty
19085 MAIL command for remote delivery, you can preserve the original return
19086 path in &$address_data$& in the router, and reinstate it in the transport by
19087 setting &%return_path%&.
19088
19089 The most common use of &%errors_to%& is to direct mailing list bounces to the
19090 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19091 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19092
19093
19094
19095 .option expn routers&!? boolean true
19096 .cindex "address" "testing"
19097 .cindex "testing" "addresses"
19098 .cindex "EXPN" "router skipping"
19099 .cindex "router" "skipping for EXPN"
19100 If this option is turned off, the router is skipped when testing an address
19101 as a result of processing an SMTP EXPN command. You might, for example,
19102 want to turn it off on a router for users' &_.forward_& files, while leaving it
19103 on for the system alias file.
19104 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19105 are evaluated.
19106
19107 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19108 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19109 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19110
19111
19112
19113 .option fail_verify routers boolean false
19114 .cindex "router" "forcing verification failure"
19115 Setting this option has the effect of setting both &%fail_verify_sender%& and
19116 &%fail_verify_recipient%& to the same value.
19117
19118
19119
19120 .option fail_verify_recipient routers boolean false
19121 If this option is true and an address is accepted by this router when
19122 verifying a recipient, verification fails.
19123
19124
19125
19126 .option fail_verify_sender routers boolean false
19127 If this option is true and an address is accepted by this router when
19128 verifying a sender, verification fails.
19129
19130
19131
19132 .option fallback_hosts routers "string list" unset
19133 .cindex "router" "fallback hosts"
19134 .cindex "fallback" "hosts specified on router"
19135 String expansion is not applied to this option. The argument must be a
19136 colon-separated list of host names or IP addresses. The list separator can be
19137 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19138 each name or address. In fact, the format of each item is exactly the same as
19139 defined for the list of hosts in a &(manualroute)& router (see section
19140 &<<SECTformatonehostitem>>&).
19141
19142 If a router queues an address for a remote transport, this host list is
19143 associated with the address, and used instead of the transport's fallback host
19144 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19145 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19146 transport for further details.
19147
19148
19149 .option group routers string&!! "see below"
19150 .cindex "gid (group id)" "local delivery"
19151 .cindex "local transports" "uid and gid"
19152 .cindex "transport" "local"
19153 .cindex "router" "setting group"
19154 When a router queues an address for a transport, and the transport does not
19155 specify a group, the group given here is used when running the delivery
19156 process.
19157 The group may be specified numerically or by name. If expansion fails, the
19158 error is logged and delivery is deferred.
19159 The default is unset, unless &%check_local_user%& is set, when the default
19160 is taken from the password information. See also &%initgroups%& and &%user%&
19161 and the discussion in chapter &<<CHAPenvironment>>&.
19162
19163
19164
19165 .option headers_add routers list&!! unset
19166 .cindex "header lines" "adding"
19167 .cindex "router" "adding header lines"
19168 This option specifies a list of text headers,
19169 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19170 that is associated with any addresses that are accepted by the router.
19171 Each item is separately expanded, at routing time.  However, this
19172 option has no effect when an address is just being verified. The way in which
19173 the text is used to add header lines at transport time is described in section
19174 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19175 message is in the process of being transported. This means that references to
19176 header lines in string expansions in the transport's configuration do not
19177 &"see"& the added header lines.
19178
19179 The &%headers_add%& option is expanded after &%errors_to%&, but before
19180 &%headers_remove%& and &%transport%&. If an item is empty, or if
19181 an item expansion is forced to fail, the item has no effect. Other expansion
19182 failures are treated as configuration errors.
19183
19184 Unlike most options, &%headers_add%& can be specified multiple times
19185 for a router; all listed headers are added.
19186
19187 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19188 router that has the &%one_time%& option set.
19189
19190 .cindex "duplicate addresses"
19191 .oindex "&%unseen%&"
19192 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19193 additions are deleted when the address is passed on to subsequent routers.
19194 For a &%redirect%& router, if a generated address is the same as the incoming
19195 address, this can lead to duplicate addresses with different header
19196 modifications. Exim does not do duplicate deliveries (except, in certain
19197 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19198 which of the duplicates is discarded, so this ambiguous situation should be
19199 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19200
19201
19202
19203 .option headers_remove routers list&!! unset
19204 .cindex "header lines" "removing"
19205 .cindex "router" "removing header lines"
19206 This option specifies a list of text headers,
19207 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19208 that is associated with any addresses that are accepted by the router.
19209 However, the option has no effect when an address is just being verified.
19210 Each list item is separately expanded, at transport time.
19211 If an item ends in *, it will match any header with the given prefix.
19212 The way in which
19213 the text is used to remove header lines at transport time is described in
19214 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19215 the message is in the process of being transported. This means that references
19216 to header lines in string expansions in the transport's configuration still
19217 &"see"& the original header lines.
19218
19219 The &%headers_remove%& option is handled after &%errors_to%& and
19220 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19221 the item has no effect. Other expansion failures are treated as configuration
19222 errors.
19223
19224 Unlike most options, &%headers_remove%& can be specified multiple times
19225 for a router; all listed headers are removed.
19226
19227 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19228 router that has the &%one_time%& option set.
19229
19230 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19231 removal requests are deleted when the address is passed on to subsequent
19232 routers, and this can lead to problems with duplicates -- see the similar
19233 warning for &%headers_add%& above.
19234
19235 &*Warning 3*&: Because of the separate expansion of the list items,
19236 items that contain a list separator must have it doubled.
19237 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19238
19239
19240
19241 .option ignore_target_hosts routers "host list&!!" unset
19242 .cindex "IP address" "discarding"
19243 .cindex "router" "discarding IP addresses"
19244 Although this option is a host list, it should normally contain IP address
19245 entries rather than names. If any host that is looked up by the router has an
19246 IP address that matches an item in this list, Exim behaves as if that IP
19247 address did not exist. This option allows you to cope with rogue DNS entries
19248 like
19249 .code
19250 remote.domain.example.  A  127.0.0.1
19251 .endd
19252 by setting
19253 .code
19254 ignore_target_hosts = 127.0.0.1
19255 .endd
19256 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19257 discarded in this way, the router declines. In a conventional configuration, an
19258 attempt to mail to such a domain would normally provoke the &"unrouteable
19259 domain"& error, and an attempt to verify an address in the domain would fail.
19260 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19261 router declines if presented with one of the listed addresses.
19262
19263 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19264 means of the first or the second of the following settings, respectively:
19265 .code
19266 ignore_target_hosts = 0.0.0.0/0
19267 ignore_target_hosts = <; 0::0/0
19268 .endd
19269 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19270 in the second line matches all IPv6 addresses.
19271
19272 This option may also be useful for ignoring link-local and site-local IPv6
19273 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19274 is expanded before use as a list, it is possible to make it dependent on the
19275 domain that is being routed.
19276
19277 .vindex "&$host_address$&"
19278 During its expansion, &$host_address$& is set to the IP address that is being
19279 checked.
19280
19281 .option initgroups routers boolean false
19282 .cindex "additional groups"
19283 .cindex "groups" "additional"
19284 .cindex "local transports" "uid and gid"
19285 .cindex "transport" "local"
19286 If the router queues an address for a transport, and this option is true, and
19287 the uid supplied by the router is not overridden by the transport, the
19288 &[initgroups()]& function is called when running the transport to ensure that
19289 any additional groups associated with the uid are set up. See also &%group%&
19290 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19291
19292
19293
19294 .option local_part_prefix routers&!? "string list" unset
19295 .cindex affix "router precondition"
19296 .cindex "router" "prefix for local part"
19297 .cindex "prefix" "for local part, used in router"
19298 If this option is set, the router is skipped unless the local part starts with
19299 one of the given strings, or &%local_part_prefix_optional%& is true. See
19300 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19301 evaluated.
19302
19303 The list is scanned from left to right, and the first prefix that matches is
19304 used. A limited form of wildcard is available; if the prefix begins with an
19305 asterisk, it matches the longest possible sequence of arbitrary characters at
19306 the start of the local part. An asterisk should therefore always be followed by
19307 some character that does not occur in normal local parts.
19308 .cindex "multiple mailboxes"
19309 .cindex "mailbox" "multiple"
19310 Wildcarding can be used to set up multiple user mailboxes, as described in
19311 section &<<SECTmulbox>>&.
19312
19313 .vindex "&$local_part$&"
19314 .vindex "&$local_part_prefix$&"
19315 During the testing of the &%local_parts%& option, and while the router is
19316 running, the prefix is removed from the local part, and is available in the
19317 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19318 the router accepts the address, this remains true during subsequent delivery by
19319 a transport. In particular, the local part that is transmitted in the RCPT
19320 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19321 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19322 the relevant transport.
19323
19324 .vindex &$local_part_prefix_v$&
19325 If wildcarding (above) was used then the part of the prefix matching the
19326 wildcard is available in &$local_part_prefix_v$&.
19327
19328 When an address is being verified, &%local_part_prefix%& affects only the
19329 behaviour of the router. If the callout feature of verification is in use, this
19330 means that the full address, including the prefix, will be used during the
19331 callout.
19332
19333 The prefix facility is commonly used to handle local parts of the form
19334 &%owner-something%&. Another common use is to support local parts of the form
19335 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19336 to tell a user their forwarding is broken &-- by placing a router like this one
19337 immediately before the router that handles &_.forward_& files:
19338 .code
19339 real_localuser:
19340   driver = accept
19341   local_part_prefix = real-
19342   check_local_user
19343   transport = local_delivery
19344 .endd
19345 For security, it would probably be a good idea to restrict the use of this
19346 router to locally-generated messages, using a condition such as this:
19347 .code
19348   condition = ${if match {$sender_host_address}\
19349                          {\N^(|127\.0\.0\.1)$\N}}
19350 .endd
19351
19352 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19353 both conditions must be met if not optional. Care must be taken if wildcards
19354 are used in both a prefix and a suffix on the same router. Different
19355 separator characters must be used to avoid ambiguity.
19356
19357
19358 .option local_part_prefix_optional routers boolean false
19359 See &%local_part_prefix%& above.
19360
19361
19362
19363 .option local_part_suffix routers&!? "string list" unset
19364 .cindex "router" "suffix for local part"
19365 .cindex "suffix for local part" "used in router"
19366 This option operates in the same way as &%local_part_prefix%&, except that the
19367 local part must end (rather than start) with the given string, the
19368 &%local_part_suffix_optional%& option determines whether the suffix is
19369 mandatory, and the wildcard * character, if present, must be the last
19370 character of the suffix. This option facility is commonly used to handle local
19371 parts of the form &%something-request%& and multiple user mailboxes of the form
19372 &%username-foo%&.
19373
19374
19375 .option local_part_suffix_optional routers boolean false
19376 See &%local_part_suffix%& above.
19377
19378
19379
19380 .option local_parts routers&!? "local part list&!!" unset
19381 .cindex "router" "restricting to specific local parts"
19382 .cindex "local part" "checking in router"
19383 The router is run only if the local part of the address matches the list.
19384 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19385 are evaluated, and
19386 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19387 string is expanded, it is possible to make it depend on the domain, for
19388 example:
19389 .code
19390 local_parts = dbm;/usr/local/specials/$domain_data
19391 .endd
19392 .vindex "&$local_part_data$&"
19393 If the match is achieved by a lookup, the data that the lookup returned
19394 for the local part is placed in the variable &$local_part_data$& for use in
19395 expansions of the router's private options or in the transport.
19396 You might use this option, for
19397 example, if you have a large number of local virtual domains, and you want to
19398 send all postmaster mail to the same place without having to set up an alias in
19399 each virtual domain:
19400 .code
19401 postmaster:
19402   driver = redirect
19403   local_parts = postmaster
19404   data = postmaster@real.domain.example
19405 .endd
19406
19407
19408 .option log_as_local routers boolean "see below"
19409 .cindex "log" "delivery line"
19410 .cindex "delivery" "log line format"
19411 Exim has two logging styles for delivery, the idea being to make local
19412 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19413 recipient address is given just as the local part, without a domain. The use of
19414 this style is controlled by this option. It defaults to true for the &(accept)&
19415 router, and false for all the others. This option applies only when a
19416 router assigns an address to a transport. It has no effect on routers that
19417 redirect addresses.
19418
19419
19420
19421 .option more routers boolean&!! true
19422 The result of string expansion for this option must be a valid boolean value,
19423 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19424 result causes an error, and delivery is deferred. If the expansion is forced to
19425 fail, the default value for the option (true) is used. Other failures cause
19426 delivery to be deferred.
19427
19428 If this option is set false, and the router declines to handle the address, no
19429 further routers are tried, routing fails, and the address is bounced.
19430 .oindex "&%self%&"
19431 However, if the router explicitly passes an address to the following router by
19432 means of the setting
19433 .code
19434 self = pass
19435 .endd
19436 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19437 does not affect the behaviour if one of the precondition tests fails. In that
19438 case, the address is always passed to the next router.
19439
19440 Note that &%address_data%& is not considered to be a precondition. If its
19441 expansion is forced to fail, the router declines, and the value of &%more%&
19442 controls what happens next.
19443
19444
19445 .option pass_on_timeout routers boolean false
19446 .cindex "timeout" "of router"
19447 .cindex "router" "timeout"
19448 If a router times out during a host lookup, it normally causes deferral of the
19449 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19450 router, overriding &%no_more%&. This may be helpful for systems that are
19451 intermittently connected to the Internet, or those that want to pass to a smart
19452 host any messages that cannot immediately be delivered.
19453
19454 There are occasional other temporary errors that can occur while doing DNS
19455 lookups. They are treated in the same way as a timeout, and this option
19456 applies to all of them.
19457
19458
19459
19460 .option pass_router routers string unset
19461 .cindex "router" "go to after &""pass""&"
19462 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19463 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19464 routing to continue, and overriding a false setting of &%more%&. When one of
19465 these routers returns &"pass"&, the address is normally handed on to the next
19466 router in sequence. This can be changed by setting &%pass_router%& to the name
19467 of another router. However (unlike &%redirect_router%&) the named router must
19468 be below the current router, to avoid loops. Note that this option applies only
19469 to the special case of &"pass"&. It does not apply when a router returns
19470 &"decline"& because it cannot handle an address.
19471
19472
19473
19474 .option redirect_router routers string unset
19475 .cindex "router" "start at after redirection"
19476 Sometimes an administrator knows that it is pointless to reprocess addresses
19477 generated from alias or forward files with the same router again. For
19478 example, if an alias file translates real names into login ids there is no
19479 point searching the alias file a second time, especially if it is a large file.
19480
19481 The &%redirect_router%& option can be set to the name of any router instance.
19482 It causes the routing of any generated addresses to start at the named router
19483 instead of at the first router. This option has no effect if the router in
19484 which it is set does not generate new addresses.
19485
19486
19487
19488 .option require_files routers&!? "string list&!!" unset
19489 .cindex "file" "requiring for router"
19490 .cindex "router" "requiring file existence"
19491 This option provides a general mechanism for predicating the running of a
19492 router on the existence or non-existence of certain files or directories.
19493 Before running a router, as one of its precondition tests, Exim works its way
19494 through the &%require_files%& list, expanding each item separately.
19495
19496 Because the list is split before expansion, any colons in expansion items must
19497 be doubled, or the facility for using a different list separator must be used
19498 (&<<SECTlistsepchange>>&).
19499 If any expansion is forced to fail, the item is ignored. Other expansion
19500 failures cause routing of the address to be deferred.
19501
19502 If any expanded string is empty, it is ignored. Otherwise, except as described
19503 below, each string must be a fully qualified file path, optionally preceded by
19504 &"!"&. The paths are passed to the &[stat()]& function to test for the
19505 existence of the files or directories. The router is skipped if any paths not
19506 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19507
19508 .cindex "NFS"
19509 If &[stat()]& cannot determine whether a file exists or not, delivery of
19510 the message is deferred. This can happen when NFS-mounted filesystems are
19511 unavailable.
19512
19513 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19514 options, so you cannot use it to check for the existence of a file in which to
19515 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19516 full list of the order in which preconditions are evaluated.) However, as
19517 these options are all expanded, you can use the &%exists%& expansion condition
19518 to make such tests. The &%require_files%& option is intended for checking files
19519 that the router may be going to use internally, or which are needed by a
19520 transport (e.g., &_.procmailrc_&).
19521
19522 During delivery, the &[stat()]& function is run as root, but there is a
19523 facility for some checking of the accessibility of a file by another user.
19524 This is not a proper permissions check, but just a &"rough"& check that
19525 operates as follows:
19526
19527 If an item in a &%require_files%& list does not contain any forward slash
19528 characters, it is taken to be the user (and optional group, separated by a
19529 comma) to be checked for subsequent files in the list. If no group is specified
19530 but the user is specified symbolically, the gid associated with the uid is
19531 used. For example:
19532 .code
19533 require_files = mail:/some/file
19534 require_files = $local_part_data:$home/.procmailrc
19535 .endd
19536 If a user or group name in a &%require_files%& list does not exist, the
19537 &%require_files%& condition fails.
19538
19539 Exim performs the check by scanning along the components of the file path, and
19540 checking the access for the given uid and gid. It checks for &"x"& access on
19541 directories, and &"r"& access on the final file. Note that this means that file
19542 access control lists, if the operating system has them, are ignored.
19543
19544 &*Warning 1*&: When the router is being run to verify addresses for an
19545 incoming SMTP message, Exim is not running as root, but under its own uid. This
19546 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19547 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19548 user is not permitted to read one of the directories on the file's path.
19549
19550 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19551 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19552 without root access. In this case, if a check for access by a particular user
19553 is requested, Exim creates a subprocess that runs as that user, and tries the
19554 check again in that process.
19555
19556 The default action for handling an unresolved EACCES is to consider it to
19557 be caused by a configuration error, and routing is deferred because the
19558 existence or non-existence of the file cannot be determined. However, in some
19559 circumstances it may be desirable to treat this condition as if the file did
19560 not exist. If the filename (or the exclamation mark that precedes the filename
19561 for non-existence) is preceded by a plus sign, the EACCES error is treated
19562 as if the file did not exist. For example:
19563 .code
19564 require_files = +/some/file
19565 .endd
19566 If the router is not an essential part of verification (for example, it
19567 handles users' &_.forward_& files), another solution is to set the &%verify%&
19568 option false so that the router is skipped when verifying.
19569
19570
19571
19572 .option retry_use_local_part routers boolean "see below"
19573 .cindex "hints database" "retry keys"
19574 .cindex "local part" "in retry keys"
19575 When a delivery suffers a temporary routing failure, a retry record is created
19576 in Exim's hints database. For addresses whose routing depends only on the
19577 domain, the key for the retry record should not involve the local part, but for
19578 other addresses, both the domain and the local part should be included.
19579 Usually, remote routing is of the former kind, and local routing is of the
19580 latter kind.
19581
19582 This option controls whether the local part is used to form the key for retry
19583 hints for addresses that suffer temporary errors while being handled by this
19584 router. The default value is true for any router that has any of
19585 &%check_local_user%&,
19586 &%local_parts%&,
19587 &%condition%&,
19588 &%local_part_prefix%&,
19589 &%local_part_suffix%&,
19590 &%senders%& or
19591 &%require_files%&
19592 set, and false otherwise. Note that this option does not apply to hints keys
19593 for transport delays; they are controlled by a generic transport option of the
19594 same name.
19595
19596 Failing to set this option when it is needed
19597 (because a remote router handles only some of the local-parts for a domain)
19598 can result in incorrect error messages being generated.
19599
19600 The setting of &%retry_use_local_part%& applies only to the router on which it
19601 appears. If the router generates child addresses, they are routed
19602 independently; this setting does not become attached to them.
19603
19604
19605
19606 .option router_home_directory routers string&!! unset
19607 .cindex "router" "home directory for"
19608 .cindex "home directory" "for router"
19609 .vindex "&$home$&"
19610 This option sets a home directory for use while the router is running. (Compare
19611 &%transport_home_directory%&, which sets a home directory for later
19612 transporting.) In particular, if used on a &(redirect)& router, this option
19613 sets a value for &$home$& while a filter is running. The value is expanded;
19614 forced expansion failure causes the option to be ignored &-- other failures
19615 cause the router to defer.
19616
19617 Expansion of &%router_home_directory%& happens immediately after the
19618 &%check_local_user%& test (if configured), before any further expansions take
19619 place.
19620 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19621 are evaluated.)
19622 While the router is running, &%router_home_directory%& overrides the value of
19623 &$home$& that came from &%check_local_user%&.
19624
19625 When a router accepts an address and assigns it to a local transport (including
19626 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19627 delivery), the home directory setting for the transport is taken from the first
19628 of these values that is set:
19629
19630 .ilist
19631 The &%home_directory%& option on the transport;
19632 .next
19633 The &%transport_home_directory%& option on the router;
19634 .next
19635 The password data if &%check_local_user%& is set on the router;
19636 .next
19637 The &%router_home_directory%& option on the router.
19638 .endlist
19639
19640 In other words, &%router_home_directory%& overrides the password data for the
19641 router, but not for the transport.
19642
19643
19644
19645 .option self routers string freeze
19646 .cindex "MX record" "pointing to local host"
19647 .cindex "local host" "MX pointing to"
19648 This option applies to those routers that use a recipient address to find a
19649 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19650 and &(manualroute)& routers.
19651 Certain configurations of the &(queryprogram)& router can also specify a list
19652 of remote hosts.
19653 Usually such routers are configured to send the message to a remote host via an
19654 &(smtp)& transport. The &%self%& option specifies what happens when the first
19655 host on the list turns out to be the local host.
19656 The way in which Exim checks for the local host is described in section
19657 &<<SECTreclocipadd>>&.
19658
19659 Normally this situation indicates either an error in Exim's configuration (for
19660 example, the router should be configured not to process this domain), or an
19661 error in the DNS (for example, the MX should not point to this host). For this
19662 reason, the default action is to log the incident, defer the address, and
19663 freeze the message. The following alternatives are provided for use in special
19664 cases:
19665
19666 .vlist
19667 .vitem &%defer%&
19668 Delivery of the message is tried again later, but the message is not frozen.
19669
19670 .vitem "&%reroute%&: <&'domain'&>"
19671 The domain is changed to the given domain, and the address is passed back to
19672 be reprocessed by the routers. No rewriting of headers takes place. This
19673 behaviour is essentially a redirection.
19674
19675 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19676 The domain is changed to the given domain, and the address is passed back to be
19677 reprocessed by the routers. Any headers that contain the original domain are
19678 rewritten.
19679
19680 .vitem &%pass%&
19681 .oindex "&%more%&"
19682 .vindex "&$self_hostname$&"
19683 The router passes the address to the next router, or to the router named in the
19684 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19685 subsequent routing and delivery, the variable &$self_hostname$& contains the
19686 name of the local host that the router encountered. This can be used to
19687 distinguish between different cases for hosts with multiple names. The
19688 combination
19689 .code
19690 self = pass
19691 no_more
19692 .endd
19693 ensures that only those addresses that routed to the local host are passed on.
19694 Without &%no_more%&, addresses that were declined for other reasons would also
19695 be passed to the next router.
19696
19697 .vitem &%fail%&
19698 Delivery fails and an error report is generated.
19699
19700 .vitem &%send%&
19701 .cindex "local host" "sending to"
19702 The anomaly is ignored and the address is queued for the transport. This
19703 setting should be used with extreme caution. For an &(smtp)& transport, it
19704 makes sense only in cases where the program that is listening on the SMTP port
19705 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19706 different configuration file that handles the domain in another way.
19707 .endlist
19708
19709
19710
19711 .option senders routers&!? "address list&!!" unset
19712 .cindex "router" "checking senders"
19713 If this option is set, the router is skipped unless the message's sender
19714 address matches something on the list.
19715 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19716 are evaluated.
19717
19718 There are issues concerning verification when the running of routers is
19719 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19720 setting, it sets the sender to the null string. When using the &%-bt%& option
19721 to check a configuration file, it is necessary also to use the &%-f%& option to
19722 set an appropriate sender. For incoming mail, the sender is unset when
19723 verifying the sender, but is available when verifying any recipients. If the
19724 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19725 matters.
19726
19727
19728 .option set routers "string list" unset
19729 .cindex router variables
19730 This option may be used multiple times on a router;
19731 because of this the list aspect is mostly irrelevant.
19732 The list separator is a semicolon but can be changed in the
19733 usual way.
19734
19735 Each list-element given must be of the form &"name = value"&
19736 and the names used must start with the string &"r_"&.
19737 Values containing a list-separator should have them doubled.
19738 When a router runs, the strings are evaluated in order,
19739 to create variables which are added to the set associated with
19740 the address.
19741 This is done immediately after all the preconditions, before the
19742 evaluation of the &%address_data%& option.
19743 The variable is set with the expansion of the value.
19744 The variables can be used by the router options
19745 (not including any preconditions)
19746 and by the transport.
19747 Later definitions of a given named variable will override former ones.
19748 Variable use is via the usual &$r_...$& syntax.
19749
19750 This is similar to the &%address_data%& option, except that
19751 many independent variables can be used, with choice of naming.
19752
19753
19754 .option translate_ip_address routers string&!! unset
19755 .cindex "IP address" "translating"
19756 .cindex "packet radio"
19757 .cindex "router" "IP address translation"
19758 There exist some rare networking situations (for example, packet radio) where
19759 it is helpful to be able to translate IP addresses generated by normal routing
19760 mechanisms into other IP addresses, thus performing a kind of manual IP
19761 routing. This should be done only if the normal IP routing of the TCP/IP stack
19762 is inadequate or broken. Because this is an extremely uncommon requirement, the
19763 code to support this option is not included in the Exim binary unless
19764 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19765
19766 .vindex "&$host_address$&"
19767 The &%translate_ip_address%& string is expanded for every IP address generated
19768 by the router, with the generated address set in &$host_address$&. If the
19769 expansion is forced to fail, no action is taken.
19770 For any other expansion error, delivery of the message is deferred.
19771 If the result of the expansion is an IP address, that replaces the original
19772 address; otherwise the result is assumed to be a host name &-- this is looked
19773 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19774 produce one or more replacement IP addresses. For example, to subvert all IP
19775 addresses in some specific networks, this could be added to a router:
19776 .code
19777 translate_ip_address = \
19778   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19779     {$value}fail}}
19780 .endd
19781 The file would contain lines like
19782 .code
19783 10.2.3.128/26    some.host
19784 10.8.4.34/26     10.44.8.15
19785 .endd
19786 You should not make use of this facility unless you really understand what you
19787 are doing.
19788
19789
19790
19791 .option transport routers string&!! unset
19792 This option specifies the transport to be used when a router accepts an address
19793 and sets it up for delivery. A transport is never needed if a router is used
19794 only for verification. The value of the option is expanded at routing time,
19795 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19796 and result must be the name of one of the configured transports. If it is not,
19797 delivery is deferred.
19798
19799 The &%transport%& option is not used by the &(redirect)& router, but it does
19800 have some private options that set up transports for pipe and file deliveries
19801 (see chapter &<<CHAPredirect>>&).
19802
19803
19804
19805 .option transport_current_directory routers string&!! unset
19806 .cindex "current directory for local transport"
19807 This option associates a current directory with any address that is routed
19808 to a local transport. This can happen either because a transport is
19809 explicitly configured for the router, or because it generates a delivery to a
19810 file or a pipe. During the delivery process (that is, at transport time), this
19811 option string is expanded and is set as the current directory, unless
19812 overridden by a setting on the transport.
19813 If the expansion fails for any reason, including forced failure, an error is
19814 logged, and delivery is deferred.
19815 See chapter &<<CHAPenvironment>>& for details of the local delivery
19816 environment.
19817
19818
19819
19820
19821 .option transport_home_directory routers string&!! "see below"
19822 .cindex "home directory" "for local transport"
19823 This option associates a home directory with any address that is routed to a
19824 local transport. This can happen either because a transport is explicitly
19825 configured for the router, or because it generates a delivery to a file or a
19826 pipe. During the delivery process (that is, at transport time), the option
19827 string is expanded and is set as the home directory, unless overridden by a
19828 setting of &%home_directory%& on the transport.
19829 If the expansion fails for any reason, including forced failure, an error is
19830 logged, and delivery is deferred.
19831
19832 If the transport does not specify a home directory, and
19833 &%transport_home_directory%& is not set for the router, the home directory for
19834 the transport is taken from the password data if &%check_local_user%& is set for
19835 the router. Otherwise it is taken from &%router_home_directory%& if that option
19836 is set; if not, no home directory is set for the transport.
19837
19838 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19839 environment.
19840
19841
19842
19843
19844 .option unseen routers boolean&!! false
19845 .cindex "router" "carrying on after success"
19846 The result of string expansion for this option must be a valid boolean value,
19847 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19848 result causes an error, and delivery is deferred. If the expansion is forced to
19849 fail, the default value for the option (false) is used. Other failures cause
19850 delivery to be deferred.
19851
19852 When this option is set true, routing does not cease if the router accepts the
19853 address. Instead, a copy of the incoming address is passed to the next router,
19854 overriding a false setting of &%more%&. There is little point in setting
19855 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19856 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19857 sometimes true and sometimes false).
19858
19859 .cindex "copy of message (&%unseen%& option)"
19860 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19861 qualifier in filter files. It can be used to cause copies of messages to be
19862 delivered to some other destination, while also carrying out a normal delivery.
19863 In effect, the current address is made into a &"parent"& that has two children
19864 &-- one that is delivered as specified by this router, and a clone that goes on
19865 to be routed further. For this reason, &%unseen%& may not be combined with the
19866 &%one_time%& option in a &(redirect)& router.
19867
19868 &*Warning*&: Header lines added to the address (or specified for removal) by
19869 this router or by previous routers affect the &"unseen"& copy of the message
19870 only. The clone that continues to be processed by further routers starts with
19871 no added headers and none specified for removal. For a &%redirect%& router, if
19872 a generated address is the same as the incoming address, this can lead to
19873 duplicate addresses with different header modifications. Exim does not do
19874 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19875 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19876 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19877 &%redirect%& router may be of help.
19878
19879 Unlike the handling of header modifications, any data that was set by the
19880 &%address_data%& option in the current or previous routers &'is'& passed on to
19881 subsequent routers.
19882
19883
19884 .option user routers string&!! "see below"
19885 .cindex "uid (user id)" "local delivery"
19886 .cindex "local transports" "uid and gid"
19887 .cindex "transport" "local"
19888 .cindex "router" "user for filter processing"
19889 .cindex "filter" "user for processing"
19890 When a router queues an address for a transport, and the transport does not
19891 specify a user, the user given here is used when running the delivery process.
19892 The user may be specified numerically or by name. If expansion fails, the
19893 error is logged and delivery is deferred.
19894 This user is also used by the &(redirect)& router when running a filter file.
19895 The default is unset, except when &%check_local_user%& is set. In this case,
19896 the default is taken from the password information. If the user is specified as
19897 a name, and &%group%& is not set, the group associated with the user is used.
19898 See also &%initgroups%& and &%group%& and the discussion in chapter
19899 &<<CHAPenvironment>>&.
19900
19901
19902
19903 .option verify routers&!? boolean true
19904 Setting this option has the effect of setting &%verify_sender%& and
19905 &%verify_recipient%& to the same value.
19906
19907
19908 .option verify_only routers&!? boolean false
19909 .cindex "EXPN" "with &%verify_only%&"
19910 .oindex "&%-bv%&"
19911 .cindex "router" "used only when verifying"
19912 If this option is set, the router is used only when verifying an address,
19913 delivering in cutthrough mode or
19914 testing with the &%-bv%& option, not when actually doing a delivery, testing
19915 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19916 restricted to verifying only senders or recipients by means of
19917 &%verify_sender%& and &%verify_recipient%&.
19918
19919 &*Warning*&: When the router is being run to verify addresses for an incoming
19920 SMTP message, Exim is not running as root, but under its own uid. If the router
19921 accesses any files, you need to make sure that they are accessible to the Exim
19922 user or group.
19923
19924
19925 .option verify_recipient routers&!? boolean true
19926 If this option is false, the router is skipped when verifying recipient
19927 addresses,
19928 delivering in cutthrough mode
19929 or testing recipient verification using &%-bv%&.
19930 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19931 are evaluated.
19932 See also the &$verify_mode$& variable.
19933
19934
19935 .option verify_sender routers&!? boolean true
19936 If this option is false, the router is skipped when verifying sender addresses
19937 or testing sender verification using &%-bvs%&.
19938 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19939 are evaluated.
19940 See also the &$verify_mode$& variable.
19941 .ecindex IIDgenoprou1
19942 .ecindex IIDgenoprou2
19943
19944
19945
19946
19947
19948
19949 . ////////////////////////////////////////////////////////////////////////////
19950 . ////////////////////////////////////////////////////////////////////////////
19951
19952 .chapter "The accept router" "CHID4"
19953 .cindex "&(accept)& router"
19954 .cindex "routers" "&(accept)&"
19955 The &(accept)& router has no private options of its own. Unless it is being
19956 used purely for verification (see &%verify_only%&) a transport is required to
19957 be defined by the generic &%transport%& option. If the preconditions that are
19958 specified by generic options are met, the router accepts the address and queues
19959 it for the given transport. The most common use of this router is for setting
19960 up deliveries to local mailboxes. For example:
19961 .code
19962 localusers:
19963   driver = accept
19964   domains = mydomain.example
19965   check_local_user
19966   transport = local_delivery
19967 .endd
19968 The &%domains%& condition in this example checks the domain of the address, and
19969 &%check_local_user%& checks that the local part is the login of a local user.
19970 When both preconditions are met, the &(accept)& router runs, and queues the
19971 address for the &(local_delivery)& transport.
19972
19973
19974
19975
19976
19977
19978 . ////////////////////////////////////////////////////////////////////////////
19979 . ////////////////////////////////////////////////////////////////////////////
19980
19981 .chapter "The dnslookup router" "CHAPdnslookup"
19982 .scindex IIDdnsrou1 "&(dnslookup)& router"
19983 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19984 The &(dnslookup)& router looks up the hosts that handle mail for the
19985 recipient's domain in the DNS. A transport must always be set for this router,
19986 unless &%verify_only%& is set.
19987
19988 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19989 SRV records. If none are found, or if SRV support is not configured,
19990 MX records are looked up. If no MX records exist, address records are sought.
19991 However, &%mx_domains%& can be set to disable the direct use of address
19992 records.
19993
19994 MX records of equal priority are sorted by Exim into a random order. Exim then
19995 looks for address records for the host names obtained from MX or SRV records.
19996 When a host has more than one IP address, they are sorted into a random order,
19997 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19998 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19999 generic option, the router declines.
20000
20001 Unless they have the highest priority (lowest MX value), MX records that point
20002 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
20003 are discarded, together with any other MX records of equal or lower priority.
20004
20005 .cindex "MX record" "pointing to local host"
20006 .cindex "local host" "MX pointing to"
20007 .oindex "&%self%&" "in &(dnslookup)& router"
20008 If the host pointed to by the highest priority MX record, or looked up as an
20009 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20010 happens is controlled by the generic &%self%& option.
20011
20012
20013 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20014 There have been problems with DNS servers when SRV records are looked up.
20015 Some misbehaving servers return a DNS error or timeout when a non-existent
20016 SRV record is sought. Similar problems have in the past been reported for
20017 MX records. The global &%dns_again_means_nonexist%& option can help with this
20018 problem, but it is heavy-handed because it is a global option.
20019
20020 For this reason, there are two options, &%srv_fail_domains%& and
20021 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20022 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20023 an attempt to look up an SRV or MX record causes one of these results, and the
20024 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20025 such record"&. In the case of an SRV lookup, this means that the router
20026 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20027 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20028 case routing fails.
20029
20030
20031 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20032 .cindex "&(dnslookup)& router" "declines"
20033 There are a few cases where a &(dnslookup)& router will decline to accept
20034 an address; if such a router is expected to handle "all remaining non-local
20035 domains", then it is important to set &%no_more%&.
20036
20037 The router will defer rather than decline if the domain
20038 is found in the &%fail_defer_domains%& router option.
20039
20040 Reasons for a &(dnslookup)& router to decline currently include:
20041 .ilist
20042 The domain does not exist in DNS
20043 .next
20044 The domain exists but the MX record's host part is just "."; this is a common
20045 convention (borrowed from SRV) used to indicate that there is no such service
20046 for this domain and to not fall back to trying A/AAAA records.
20047 .next
20048 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20049 .next
20050 MX record points to a non-existent host.
20051 .next
20052 MX record points to an IP address and the main section option
20053 &%allow_mx_to_ip%& is not set.
20054 .next
20055 MX records exist and point to valid hosts, but all hosts resolve only to
20056 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20057 .next
20058 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20059 &%dns_check_names_pattern%& for handling one variant of this)
20060 .next
20061 &%check_secondary_mx%& is set on this router but the local host can
20062 not be found in the MX records (see below)
20063 .endlist
20064
20065
20066
20067
20068 .section "Private options for dnslookup" "SECID118"
20069 .cindex "options" "&(dnslookup)& router"
20070 The private options for the &(dnslookup)& router are as follows:
20071
20072 .option check_secondary_mx dnslookup boolean false
20073 .cindex "MX record" "checking for secondary"
20074 If this option is set, the router declines unless the local host is found in
20075 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20076 process domains for which the local host is a secondary mail exchanger
20077 differently to other domains. The way in which Exim decides whether a host is
20078 the local host is described in section &<<SECTreclocipadd>>&.
20079
20080
20081 .option check_srv dnslookup string&!! unset
20082 .cindex "SRV record" "enabling use of"
20083 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20084 addition to MX and address records. The support is disabled by default. To
20085 enable SRV support, set the &%check_srv%& option to the name of the service
20086 required. For example,
20087 .code
20088 check_srv = smtp
20089 .endd
20090 looks for SRV records that refer to the normal smtp service. The option is
20091 expanded, so the service name can vary from message to message or address
20092 to address. This might be helpful if SRV records are being used for a
20093 submission service. If the expansion is forced to fail, the &%check_srv%&
20094 option is ignored, and the router proceeds to look for MX records in the
20095 normal way.
20096
20097 When the expansion succeeds, the router searches first for SRV records for
20098 the given service (it assumes TCP protocol). A single SRV record with a
20099 host name that consists of just a single dot indicates &"no such service for
20100 this domain"&; if this is encountered, the router declines. If other kinds of
20101 SRV record are found, they are used to construct a host list for delivery
20102 according to the rules of RFC 2782. MX records are not sought in this case.
20103
20104 When no SRV records are found, MX records (and address records) are sought in
20105 the traditional way. In other words, SRV records take precedence over MX
20106 records, just as MX records take precedence over address records. Note that
20107 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20108 defined it. It is apparently believed that MX records are sufficient for email
20109 and that SRV records should not be used for this purpose. However, SRV records
20110 have an additional &"weight"& feature which some people might find useful when
20111 trying to split an SMTP load between hosts of different power.
20112
20113 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20114 when there is a DNS lookup error.
20115
20116
20117
20118
20119 .option fail_defer_domains dnslookup "domain list&!!" unset
20120 .cindex "MX record" "not found"
20121 DNS lookups for domains matching &%fail_defer_domains%&
20122 which find no matching record will cause the router to defer
20123 rather than the default behaviour of decline.
20124 This maybe be useful for queueing messages for a newly created
20125 domain while the DNS configuration is not ready.
20126 However, it will result in any message with mistyped domains
20127 also being queued.
20128
20129
20130 .option ipv4_only "string&!!" unset
20131 .cindex IPv6 disabling
20132 .cindex DNS "IPv6 disabling"
20133 The string is expanded, and if the result is anything but a forced failure,
20134 or an empty string, or one of the strings “0” or “no” or “false”
20135 (checked without regard to the case of the letters),
20136 only A records are used.
20137
20138 .option ipv4_prefer "string&!!" unset
20139 .cindex IPv4 preference
20140 .cindex DNS "IPv4 preference"
20141 The string is expanded, and if the result is anything but a forced failure,
20142 or an empty string, or one of the strings “0” or “no” or “false”
20143 (checked without regard to the case of the letters),
20144 A records are sorted before AAAA records (inverting the default).
20145
20146 .option mx_domains dnslookup "domain list&!!" unset
20147 .cindex "MX record" "required to exist"
20148 .cindex "SRV record" "required to exist"
20149 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20150 record in order to be recognized. (The name of this option could be improved.)
20151 For example, if all the mail hosts in &'fict.example'& are known to have MX
20152 records, except for those in &'discworld.fict.example'&, you could use this
20153 setting:
20154 .code
20155 mx_domains = ! *.discworld.fict.example : *.fict.example
20156 .endd
20157 This specifies that messages addressed to a domain that matches the list but
20158 has no MX record should be bounced immediately instead of being routed using
20159 the address record.
20160
20161
20162 .option mx_fail_domains dnslookup "domain list&!!" unset
20163 If the DNS lookup for MX records for one of the domains in this list causes a
20164 DNS lookup error, Exim behaves as if no MX records were found. See section
20165 &<<SECTprowitdnsloo>>& for more discussion.
20166
20167
20168
20169
20170 .option qualify_single dnslookup boolean true
20171 .cindex "DNS" "resolver options"
20172 .cindex "DNS" "qualifying single-component names"
20173 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20174 lookups. Typically, but not standardly, this causes the resolver to qualify
20175 single-component names with the default domain. For example, on a machine
20176 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20177 &'thesaurus.ref.example'& inside the resolver. For details of what your
20178 resolver actually does, consult your man pages for &'resolver'& and
20179 &'resolv.conf'&.
20180
20181
20182
20183 .option rewrite_headers dnslookup boolean true
20184 .cindex "rewriting" "header lines"
20185 .cindex "header lines" "rewriting"
20186 If the domain name in the address that is being processed is not fully
20187 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20188 an address is specified as &'dormouse@teaparty'&, the domain might be
20189 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20190 occur as a result of setting the &%widen_domains%& option. If
20191 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20192 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20193 header lines of the message are rewritten with the full domain name.
20194
20195 This option should be turned off only when it is known that no message is
20196 ever going to be sent outside an environment where the abbreviation makes
20197 sense.
20198
20199 When an MX record is looked up in the DNS and matches a wildcard record, name
20200 servers normally return a record containing the name that has been looked up,
20201 making it impossible to detect whether a wildcard was present or not. However,
20202 some name servers have recently been seen to return the wildcard entry. If the
20203 name returned by a DNS lookup begins with an asterisk, it is not used for
20204 header rewriting.
20205
20206
20207 .option same_domain_copy_routing dnslookup boolean false
20208 .cindex "address" "copying routing"
20209 Addresses with the same domain are normally routed by the &(dnslookup)& router
20210 to the same list of hosts. However, this cannot be presumed, because the router
20211 options and preconditions may refer to the local part of the address. By
20212 default, therefore, Exim routes each address in a message independently. DNS
20213 servers run caches, so repeated DNS lookups are not normally expensive, and in
20214 any case, personal messages rarely have more than a few recipients.
20215
20216 If you are running mailing lists with large numbers of subscribers at the same
20217 domain, and you are using a &(dnslookup)& router which is independent of the
20218 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20219 lookups for identical domains in one message. In this case, when &(dnslookup)&
20220 routes an address to a remote transport, any other unrouted addresses in the
20221 message that have the same domain are automatically given the same routing
20222 without processing them independently,
20223 provided the following conditions are met:
20224
20225 .ilist
20226 No router that processed the address specified &%headers_add%& or
20227 &%headers_remove%&.
20228 .next
20229 The router did not change the address in any way, for example, by &"widening"&
20230 the domain.
20231 .endlist
20232
20233
20234
20235
20236 .option search_parents dnslookup boolean false
20237 .cindex "DNS" "resolver options"
20238 When this option is true, the resolver option RES_DNSRCH is set for DNS
20239 lookups. This is different from the &%qualify_single%& option in that it
20240 applies to domains containing dots. Typically, but not standardly, it causes
20241 the resolver to search for the name in the current domain and in parent
20242 domains. For example, on a machine in the &'fict.example'& domain, if looking
20243 up &'teaparty.wonderland'& failed, the resolver would try
20244 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20245 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20246
20247 Setting this option true can cause problems in domains that have a wildcard MX
20248 record, because any domain that does not have its own MX record matches the
20249 local wildcard.
20250
20251
20252
20253 .option srv_fail_domains dnslookup "domain list&!!" unset
20254 If the DNS lookup for SRV records for one of the domains in this list causes a
20255 DNS lookup error, Exim behaves as if no SRV records were found. See section
20256 &<<SECTprowitdnsloo>>& for more discussion.
20257
20258
20259
20260
20261 .option widen_domains dnslookup "string list" unset
20262 .cindex "domain" "partial; widening"
20263 If a DNS lookup fails and this option is set, each of its strings in turn is
20264 added onto the end of the domain, and the lookup is tried again. For example,
20265 if
20266 .code
20267 widen_domains = fict.example:ref.example
20268 .endd
20269 is set and a lookup of &'klingon.dictionary'& fails,
20270 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20271 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20272 and &%search_parents%& options can cause some widening to be undertaken inside
20273 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20274 when verifying, unless &%rewrite_headers%& is false (not the default).
20275
20276
20277 .section "Effect of qualify_single and search_parents" "SECID119"
20278 When a domain from an envelope recipient is changed by the resolver as a result
20279 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20280 corresponding address in the message's header lines unless &%rewrite_headers%&
20281 is set false. Exim then re-routes the address, using the full domain.
20282
20283 These two options affect only the DNS lookup that takes place inside the router
20284 for the domain of the address that is being routed. They do not affect lookups
20285 such as that implied by
20286 .code
20287 domains = @mx_any
20288 .endd
20289 that may happen while processing a router precondition before the router is
20290 entered. No widening ever takes place for these lookups.
20291 .ecindex IIDdnsrou1
20292 .ecindex IIDdnsrou2
20293
20294
20295
20296
20297
20298
20299
20300
20301
20302 . ////////////////////////////////////////////////////////////////////////////
20303 . ////////////////////////////////////////////////////////////////////////////
20304
20305 .chapter "The ipliteral router" "CHID5"
20306 .cindex "&(ipliteral)& router"
20307 .cindex "domain literal" "routing"
20308 .cindex "routers" "&(ipliteral)&"
20309 This router has no private options. Unless it is being used purely for
20310 verification (see &%verify_only%&) a transport is required to be defined by the
20311 generic &%transport%& option. The router accepts the address if its domain part
20312 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20313 router handles the address
20314 .code
20315 root@[192.168.1.1]
20316 .endd
20317 by setting up delivery to the host with that IP address. IPv4 domain literals
20318 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20319 are similar, but the address is preceded by &`ipv6:`&. For example:
20320 .code
20321 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20322 .endd
20323 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20324 grounds that sooner or later somebody will try it.
20325
20326 .oindex "&%self%&" "in &(ipliteral)& router"
20327 If the IP address matches something in &%ignore_target_hosts%&, the router
20328 declines. If an IP literal turns out to refer to the local host, the generic
20329 &%self%& option determines what happens.
20330
20331 The RFCs require support for domain literals; however, their use is
20332 controversial in today's Internet. If you want to use this router, you must
20333 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20334 Exim will not recognize the domain literal syntax in addresses.
20335
20336
20337
20338 . ////////////////////////////////////////////////////////////////////////////
20339 . ////////////////////////////////////////////////////////////////////////////
20340
20341 .chapter "The iplookup router" "CHID6"
20342 .cindex "&(iplookup)& router"
20343 .cindex "routers" "&(iplookup)&"
20344 The &(iplookup)& router was written to fulfil a specific requirement in
20345 Cambridge University (which in fact no longer exists). For this reason, it is
20346 not included in the binary of Exim by default. If you want to include it, you
20347 must set
20348 .code
20349 ROUTER_IPLOOKUP=yes
20350 .endd
20351 in your &_Local/Makefile_& configuration file.
20352
20353 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20354 connection to one or more specific hosts. The host can then return the same or
20355 a different address &-- in effect rewriting the recipient address in the
20356 message's envelope. The new address is then passed on to subsequent routers. If
20357 this process fails, the address can be passed on to other routers, or delivery
20358 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20359 must not be specified for it.
20360
20361 .cindex "options" "&(iplookup)& router"
20362 .option hosts iplookup string unset
20363 This option must be supplied. Its value is a colon-separated list of host
20364 names. The hosts are looked up using &[gethostbyname()]&
20365 (or &[getipnodebyname()]& when available)
20366 and are tried in order until one responds to the query. If none respond, what
20367 happens is controlled by &%optional%&.
20368
20369
20370 .option optional iplookup boolean false
20371 If &%optional%& is true, if no response is obtained from any host, the address
20372 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20373 delivery to the address is deferred.
20374
20375
20376 .option port iplookup integer 0
20377 .cindex "port" "&(iplookup)& router"
20378 This option must be supplied. It specifies the port number for the TCP or UDP
20379 call.
20380
20381
20382 .option protocol iplookup string udp
20383 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20384 protocols is to be used.
20385
20386
20387 .option query iplookup string&!! "see below"
20388 This defines the content of the query that is sent to the remote hosts. The
20389 default value is:
20390 .code
20391 $local_part@$domain $local_part@$domain
20392 .endd
20393 The repetition serves as a way of checking that a response is to the correct
20394 query in the default case (see &%response_pattern%& below).
20395
20396
20397 .option reroute iplookup string&!! unset
20398 If this option is not set, the rerouted address is precisely the byte string
20399 returned by the remote host, up to the first white space, if any. If set, the
20400 string is expanded to form the rerouted address. It can include parts matched
20401 in the response by &%response_pattern%& by means of numeric variables such as
20402 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20403 whether or not a pattern is in use. In all cases, the rerouted address must end
20404 up in the form &'local_part@domain'&.
20405
20406
20407 .option response_pattern iplookup string unset
20408 This option can be set to a regular expression that is applied to the string
20409 returned from the remote host. If the pattern does not match the response, the
20410 router declines. If &%response_pattern%& is not set, no checking of the
20411 response is done, unless the query was defaulted, in which case there is a
20412 check that the text returned after the first white space is the original
20413 address. This checks that the answer that has been received is in response to
20414 the correct question. For example, if the response is just a new domain, the
20415 following could be used:
20416 .code
20417 response_pattern = ^([^@]+)$
20418 reroute = $local_part@$1
20419 .endd
20420
20421 .option timeout iplookup time 5s
20422 This specifies the amount of time to wait for a response from the remote
20423 machine. The same timeout is used for the &[connect()]& function for a TCP
20424 call. It does not apply to UDP.
20425
20426
20427
20428
20429 . ////////////////////////////////////////////////////////////////////////////
20430 . ////////////////////////////////////////////////////////////////////////////
20431
20432 .chapter "The manualroute router" "CHID7"
20433 .scindex IIDmanrou1 "&(manualroute)& router"
20434 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20435 .cindex "domain" "manually routing"
20436 The &(manualroute)& router is so-called because it provides a way of manually
20437 routing an address according to its domain. It is mainly used when you want to
20438 route addresses to remote hosts according to your own rules, bypassing the
20439 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20440 route to local transports, a facility that may be useful if you want to save
20441 messages for dial-in hosts in local files.
20442
20443 The &(manualroute)& router compares a list of domain patterns with the domain
20444 it is trying to route. If there is no match, the router declines. Each pattern
20445 has associated with it a list of hosts and some other optional data, which may
20446 include a transport. The combination of a pattern and its data is called a
20447 &"routing rule"&. For patterns that do not have an associated transport, the
20448 generic &%transport%& option must specify a transport, unless the router is
20449 being used purely for verification (see &%verify_only%&).
20450
20451 .vindex "&$host$&"
20452 In the case of verification, matching the domain pattern is sufficient for the
20453 router to accept the address. When actually routing an address for delivery,
20454 an address that matches a domain pattern is queued for the associated
20455 transport. If the transport is not a local one, a host list must be associated
20456 with the pattern; IP addresses are looked up for the hosts, and these are
20457 passed to the transport along with the mail address. For local transports, a
20458 host list is optional. If it is present, it is passed in &$host$& as a single
20459 text string.
20460
20461 The list of routing rules can be provided as an inline string in
20462 &%route_list%&, or the data can be obtained by looking up the domain in a file
20463 or database by setting &%route_data%&. Only one of these settings may appear in
20464 any one instance of &(manualroute)&. The format of routing rules is described
20465 below, following the list of private options.
20466
20467
20468 .section "Private options for manualroute" "SECTprioptman"
20469
20470 .cindex "options" "&(manualroute)& router"
20471 The private options for the &(manualroute)& router are as follows:
20472
20473 .option host_all_ignored manualroute string defer
20474 See &%host_find_failed%&.
20475
20476 .option host_find_failed manualroute string freeze
20477 This option controls what happens when &(manualroute)& tries to find an IP
20478 address for a host, and the host does not exist. The option can be set to one
20479 of the following values:
20480 .code
20481 decline
20482 defer
20483 fail
20484 freeze
20485 ignore
20486 pass
20487 .endd
20488 The default (&"freeze"&) assumes that this state is a serious configuration
20489 error. The difference between &"pass"& and &"decline"& is that the former
20490 forces the address to be passed to the next router (or the router defined by
20491 &%pass_router%&),
20492 .oindex "&%more%&"
20493 overriding &%no_more%&, whereas the latter passes the address to the next
20494 router only if &%more%& is true.
20495
20496 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20497 cannot be found. If all the hosts in the list are ignored, the behaviour is
20498 controlled by the &%host_all_ignored%& option. This takes the same values
20499 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20500
20501 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20502 state; if a host lookup gets a temporary error, delivery is deferred unless the
20503 generic &%pass_on_timeout%& option is set.
20504
20505
20506 .option hosts_randomize manualroute boolean false
20507 .cindex "randomized host list"
20508 .cindex "host" "list of; randomized"
20509 If this option is set, the order of the items in a host list in a routing rule
20510 is randomized each time the list is used, unless an option in the routing rule
20511 overrides (see below). Randomizing the order of a host list can be used to do
20512 crude load sharing. However, if more than one mail address is routed by the
20513 same router to the same host list, the host lists are considered to be the same
20514 (even though they may be randomized into different orders) for the purpose of
20515 deciding whether to batch the deliveries into a single SMTP transaction.
20516
20517 When &%hosts_randomize%& is true, a host list may be split
20518 into groups whose order is separately randomized. This makes it possible to
20519 set up MX-like behaviour. The boundaries between groups are indicated by an
20520 item that is just &`+`& in the host list. For example:
20521 .code
20522 route_list = * host1:host2:host3:+:host4:host5
20523 .endd
20524 The order of the first three hosts and the order of the last two hosts is
20525 randomized for each use, but the first three always end up before the last two.
20526 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20527 randomized host list is passed to an &(smtp)& transport that also has
20528 &%hosts_randomize set%&, the list is not re-randomized.
20529
20530
20531 .option route_data manualroute string&!! unset
20532 If this option is set, it must expand to yield the data part of a routing rule.
20533 Typically, the expansion string includes a lookup based on the domain. For
20534 example:
20535 .code
20536 route_data = ${lookup{$domain}dbm{/etc/routes}}
20537 .endd
20538 If the expansion is forced to fail, or the result is an empty string, the
20539 router declines. Other kinds of expansion failure cause delivery to be
20540 deferred.
20541
20542
20543 .option route_list manualroute "string list" unset
20544 This string is a list of routing rules, in the form defined below. Note that,
20545 unlike most string lists, the items are separated by semicolons. This is so
20546 that they may contain colon-separated host lists.
20547
20548
20549 .option same_domain_copy_routing manualroute boolean false
20550 .cindex "address" "copying routing"
20551 Addresses with the same domain are normally routed by the &(manualroute)&
20552 router to the same list of hosts. However, this cannot be presumed, because the
20553 router options and preconditions may refer to the local part of the address. By
20554 default, therefore, Exim routes each address in a message independently. DNS
20555 servers run caches, so repeated DNS lookups are not normally expensive, and in
20556 any case, personal messages rarely have more than a few recipients.
20557
20558 If you are running mailing lists with large numbers of subscribers at the same
20559 domain, and you are using a &(manualroute)& router which is independent of the
20560 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20561 lookups for identical domains in one message. In this case, when
20562 &(manualroute)& routes an address to a remote transport, any other unrouted
20563 addresses in the message that have the same domain are automatically given the
20564 same routing without processing them independently. However, this is only done
20565 if &%headers_add%& and &%headers_remove%& are unset.
20566
20567
20568
20569
20570 .section "Routing rules in route_list" "SECID120"
20571 The value of &%route_list%& is a string consisting of a sequence of routing
20572 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20573 entered as two semicolons. Alternatively, the list separator can be changed as
20574 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20575 Empty rules are ignored. The format of each rule is
20576 .display
20577 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20578 .endd
20579 The following example contains two rules, each with a simple domain pattern and
20580 no options:
20581 .code
20582 route_list = \
20583   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20584   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20585 .endd
20586 The three parts of a rule are separated by white space. The pattern and the
20587 list of hosts can be enclosed in quotes if necessary, and if they are, the
20588 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20589 single domain pattern, which is the only mandatory item in the rule. The
20590 pattern is in the same format as one item in a domain list (see section
20591 &<<SECTdomainlist>>&),
20592 except that it may not be the name of an interpolated file.
20593 That is, it may be wildcarded, or a regular expression, or a file or database
20594 lookup (with semicolons doubled, because of the use of semicolon as a separator
20595 in a &%route_list%&).
20596
20597 The rules in &%route_list%& are searched in order until one of the patterns
20598 matches the domain that is being routed. The list of hosts and then options are
20599 then used as described below. If there is no match, the router declines. When
20600 &%route_list%& is set, &%route_data%& must not be set.
20601
20602
20603
20604 .section "Routing rules in route_data" "SECID121"
20605 The use of &%route_list%& is convenient when there are only a small number of
20606 routing rules. For larger numbers, it is easier to use a file or database to
20607 hold the routing information, and use the &%route_data%& option instead.
20608 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20609 Most commonly, &%route_data%& is set as a string that contains an
20610 expansion lookup. For example, suppose we place two routing rules in a file
20611 like this:
20612 .code
20613 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20614 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20615 .endd
20616 This data can be accessed by setting
20617 .code
20618 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20619 .endd
20620 Failure of the lookup results in an empty string, causing the router to
20621 decline. However, you do not have to use a lookup in &%route_data%&. The only
20622 requirement is that the result of expanding the string is a list of hosts,
20623 possibly followed by options, separated by white space. The list of hosts must
20624 be enclosed in quotes if it contains white space.
20625
20626
20627
20628
20629 .section "Format of the list of hosts" "SECID122"
20630 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20631 always separately expanded before use. If the expansion fails, the router
20632 declines. The result of the expansion must be a colon-separated list of names
20633 and/or IP addresses, optionally also including ports.
20634 If the list is written with spaces, it must be protected with quotes.
20635 The format of each item
20636 in the list is described in the next section. The list separator can be changed
20637 as described in section &<<SECTlistsepchange>>&.
20638
20639 If the list of hosts was obtained from a &%route_list%& item, the following
20640 variables are set during its expansion:
20641
20642 .ilist
20643 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20644 If the domain was matched against a regular expression, the numeric variables
20645 &$1$&, &$2$&, etc. may be set. For example:
20646 .code
20647 route_list = ^domain(\d+)   host-$1.text.example
20648 .endd
20649 .next
20650 &$0$& is always set to the entire domain.
20651 .next
20652 &$1$& is also set when partial matching is done in a file lookup.
20653
20654 .next
20655 .vindex "&$value$&"
20656 If the pattern that matched the domain was a lookup item, the data that was
20657 looked up is available in the expansion variable &$value$&. For example:
20658 .code
20659 route_list = lsearch;;/some/file.routes  $value
20660 .endd
20661 .endlist
20662
20663 Note the doubling of the semicolon in the pattern that is necessary because
20664 semicolon is the default route list separator.
20665
20666
20667
20668 .section "Format of one host item" "SECTformatonehostitem"
20669 Each item in the list of hosts can be either a host name or an IP address,
20670 optionally with an attached port number, or it can be a single "+"
20671 (see &%hosts_randomize%&).
20672 When no port is given, an IP address
20673 is not enclosed in brackets. When a port is specified, it overrides the port
20674 specification on the transport. The port is separated from the name or address
20675 by a colon. This leads to some complications:
20676
20677 .ilist
20678 Because colon is the default separator for the list of hosts, either
20679 the colon that specifies a port must be doubled, or the list separator must
20680 be changed. The following two examples have the same effect:
20681 .code
20682 route_list = * "host1.tld::1225 : host2.tld::1226"
20683 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20684 .endd
20685 .next
20686 When IPv6 addresses are involved, it gets worse, because they contain
20687 colons of their own. To make this case easier, it is permitted to
20688 enclose an IP address (either v4 or v6) in square brackets if a port
20689 number follows. For example:
20690 .code
20691 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20692 .endd
20693 .endlist
20694
20695 .section "How the list of hosts is used" "SECThostshowused"
20696 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20697 the hosts is tried, in the order specified, when carrying out the SMTP
20698 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20699 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20700 transport.
20701
20702 Hosts may be listed by name or by IP address. An unadorned name in the list of
20703 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20704 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20705 records in the DNS. For example:
20706 .code
20707 route_list = *  x.y.z:p.q.r/MX:e.f.g
20708 .endd
20709 If this feature is used with a port specifier, the port must come last. For
20710 example:
20711 .code
20712 route_list = *  dom1.tld/mx::1225
20713 .endd
20714 If the &%hosts_randomize%& option is set, the order of the items in the list is
20715 randomized before any lookups are done. Exim then scans the list; for any name
20716 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20717 be an interface on the local host and the item is not the first in the list,
20718 Exim discards it and any subsequent items. If it is the first item, what
20719 happens is controlled by the
20720 .oindex "&%self%&" "in &(manualroute)& router"
20721 &%self%& option of the router.
20722
20723 A name on the list that is followed by &`/MX`& is replaced with the list of
20724 hosts obtained by looking up MX records for the name. This is always a DNS
20725 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20726 below) are not relevant here. The order of these hosts is determined by the
20727 preference values in the MX records, according to the usual rules. Because
20728 randomizing happens before the MX lookup, it does not affect the order that is
20729 defined by MX preferences.
20730
20731 If the local host is present in the sublist obtained from MX records, but is
20732 not the most preferred host in that list, it and any equally or less
20733 preferred hosts are removed before the sublist is inserted into the main list.
20734
20735 If the local host is the most preferred host in the MX list, what happens
20736 depends on where in the original list of hosts the &`/MX`& item appears. If it
20737 is not the first item (that is, there are previous hosts in the main list),
20738 Exim discards this name and any subsequent items in the main list.
20739
20740 If the MX item is first in the list of hosts, and the local host is the
20741 most preferred host, what happens is controlled by the &%self%& option of the
20742 router.
20743
20744 DNS failures when lookup up the MX records are treated in the same way as DNS
20745 failures when looking up IP addresses: &%pass_on_timeout%& and
20746 &%host_find_failed%& are used when relevant.
20747
20748 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20749 whether obtained from an MX lookup or not.
20750
20751
20752
20753 .section "How the options are used" "SECThowoptused"
20754 The options are a sequence of words, space-separated.
20755 One of the words can be the name of a transport; this overrides the
20756 &%transport%& option on the router for this particular routing rule only. The
20757 other words (if present) control randomization of the list of hosts on a
20758 per-rule basis, and how the IP addresses of the hosts are to be found when
20759 routing to a remote transport. These options are as follows:
20760
20761 .ilist
20762 &%randomize%&: randomize the order of the hosts in this list, overriding the
20763 setting of &%hosts_randomize%& for this routing rule only.
20764 .next
20765 &%no_randomize%&: do not randomize the order of the hosts in this list,
20766 overriding the setting of &%hosts_randomize%& for this routing rule only.
20767 .next
20768 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20769 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20770 also look in &_/etc/hosts_& or other sources of information.
20771 .next
20772 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20773 no address records are found. If there is a temporary DNS error (such as a
20774 timeout), delivery is deferred.
20775 .next
20776 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20777 .next
20778 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20779 .endlist
20780
20781 For example:
20782 .code
20783 route_list = domain1  host1:host2:host3  randomize bydns;\
20784              domain2  host4:host5
20785 .endd
20786 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20787 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20788 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20789 or &[gethostbyname()]&, and the result of the lookup is the result of that
20790 call.
20791
20792 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20793 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20794 instead of TRY_AGAIN. That is why the default action is to try a DNS
20795 lookup first. Only if that gives a definite &"no such host"& is the local
20796 function called.
20797
20798 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20799 inadvertent constraint that a transport name as an option had to be the last
20800 option specified.
20801
20802
20803
20804 If no IP address for a host can be found, what happens is controlled by the
20805 &%host_find_failed%& option.
20806
20807 .vindex "&$host$&"
20808 When an address is routed to a local transport, IP addresses are not looked up.
20809 The host list is passed to the transport in the &$host$& variable.
20810
20811
20812
20813 .section "Manualroute examples" "SECID123"
20814 In some of the examples that follow, the presence of the &%remote_smtp%&
20815 transport, as defined in the default configuration file, is assumed:
20816
20817 .ilist
20818 .cindex "smart host" "example router"
20819 The &(manualroute)& router can be used to forward all external mail to a
20820 &'smart host'&. If you have set up, in the main part of the configuration, a
20821 named domain list that contains your local domains, for example:
20822 .code
20823 domainlist local_domains = my.domain.example
20824 .endd
20825 You can arrange for all other domains to be routed to a smart host by making
20826 your first router something like this:
20827 .code
20828 smart_route:
20829   driver = manualroute
20830   domains = !+local_domains
20831   transport = remote_smtp
20832   route_list = * smarthost.ref.example
20833 .endd
20834 This causes all non-local addresses to be sent to the single host
20835 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20836 they are tried in order
20837 (but you can use &%hosts_randomize%& to vary the order each time).
20838 Another way of configuring the same thing is this:
20839 .code
20840 smart_route:
20841   driver = manualroute
20842   transport = remote_smtp
20843   route_list = !+local_domains  smarthost.ref.example
20844 .endd
20845 There is no difference in behaviour between these two routers as they stand.
20846 However, they behave differently if &%no_more%& is added to them. In the first
20847 example, the router is skipped if the domain does not match the &%domains%&
20848 precondition; the following router is always tried. If the router runs, it
20849 always matches the domain and so can never decline. Therefore, &%no_more%&
20850 would have no effect. In the second case, the router is never skipped; it
20851 always runs. However, if it doesn't match the domain, it declines. In this case
20852 &%no_more%& would prevent subsequent routers from running.
20853
20854 .next
20855 .cindex "mail hub example"
20856 A &'mail hub'& is a host which receives mail for a number of domains via MX
20857 records in the DNS and delivers it via its own private routing mechanism. Often
20858 the final destinations are behind a firewall, with the mail hub being the one
20859 machine that can connect to machines both inside and outside the firewall. The
20860 &(manualroute)& router is usually used on a mail hub to route incoming messages
20861 to the correct hosts. For a small number of domains, the routing can be inline,
20862 using the &%route_list%& option, but for a larger number a file or database
20863 lookup is easier to manage.
20864
20865 If the domain names are in fact the names of the machines to which the mail is
20866 to be sent by the mail hub, the configuration can be quite simple. For
20867 example:
20868 .code
20869 hub_route:
20870   driver = manualroute
20871   transport = remote_smtp
20872   route_list = *.rhodes.tvs.example  $domain
20873 .endd
20874 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20875 whose names are the same as the mail domains. A similar approach can be taken
20876 if the host name can be obtained from the domain name by a string manipulation
20877 that the expansion facilities can handle. Otherwise, a lookup based on the
20878 domain can be used to find the host:
20879 .code
20880 through_firewall:
20881   driver = manualroute
20882   transport = remote_smtp
20883   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20884 .endd
20885 The result of the lookup must be the name or IP address of the host (or
20886 hosts) to which the address is to be routed. If the lookup fails, the route
20887 data is empty, causing the router to decline. The address then passes to the
20888 next router.
20889
20890 .next
20891 .cindex "batched SMTP output example"
20892 .cindex "SMTP" "batched outgoing; example"
20893 You can use &(manualroute)& to deliver messages to pipes or files in batched
20894 SMTP format for onward transportation by some other means. This is one way of
20895 storing mail for a dial-up host when it is not connected. The route list entry
20896 can be as simple as a single domain name in a configuration like this:
20897 .code
20898 save_in_file:
20899   driver = manualroute
20900   transport = batchsmtp_appendfile
20901   route_list = saved.domain.example
20902 .endd
20903 though often a pattern is used to pick up more than one domain. If there are
20904 several domains or groups of domains with different transport requirements,
20905 different transports can be listed in the routing information:
20906 .code
20907 save_in_file:
20908   driver = manualroute
20909   route_list = \
20910     *.saved.domain1.example  $domain  batch_appendfile; \
20911     *.saved.domain2.example  \
20912       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20913       batch_pipe
20914 .endd
20915 .vindex "&$domain$&"
20916 .vindex "&$host$&"
20917 The first of these just passes the domain in the &$host$& variable, which
20918 doesn't achieve much (since it is also in &$domain$&), but the second does a
20919 file lookup to find a value to pass, causing the router to decline to handle
20920 the address if the lookup fails.
20921
20922 .next
20923 .cindex "UUCP" "example of router for"
20924 Routing mail directly to UUCP software is a specific case of the use of
20925 &(manualroute)& in a gateway to another mail environment. This is an example of
20926 one way it can be done:
20927 .code
20928 # Transport
20929 uucp:
20930   driver = pipe
20931   user = nobody
20932   command = /usr/local/bin/uux -r - \
20933     ${substr_-5:$host}!rmail ${local_part}
20934   return_fail_output = true
20935
20936 # Router
20937 uucphost:
20938   transport = uucp
20939   driver = manualroute
20940   route_data = \
20941     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20942 .endd
20943 The file &_/usr/local/exim/uucphosts_& contains entries like
20944 .code
20945 darksite.ethereal.example:           darksite.UUCP
20946 .endd
20947 It can be set up more simply without adding and removing &".UUCP"& but this way
20948 makes clear the distinction between the domain name
20949 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20950 .endlist
20951 .ecindex IIDmanrou1
20952 .ecindex IIDmanrou2
20953
20954
20955
20956
20957
20958
20959
20960
20961 . ////////////////////////////////////////////////////////////////////////////
20962 . ////////////////////////////////////////////////////////////////////////////
20963
20964 .chapter "The queryprogram router" "CHAPdriverlast"
20965 .scindex IIDquerou1 "&(queryprogram)& router"
20966 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20967 .cindex "routing" "by external program"
20968 The &(queryprogram)& router routes an address by running an external command
20969 and acting on its output. This is an expensive way to route, and is intended
20970 mainly for use in lightly-loaded systems, or for performing experiments.
20971 However, if it is possible to use the precondition options (&%domains%&,
20972 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20973 be used in special cases, even on a busy host. There are the following private
20974 options:
20975 .cindex "options" "&(queryprogram)& router"
20976
20977 .option command queryprogram string&!! unset
20978 This option must be set. It specifies the command that is to be run. The
20979 command is split up into a command name and arguments, and then each is
20980 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20981 &<<CHAPpipetransport>>&).
20982
20983
20984 .option command_group queryprogram string unset
20985 .cindex "gid (group id)" "in &(queryprogram)& router"
20986 This option specifies a gid to be set when running the command while routing an
20987 address for deliver. It must be set if &%command_user%& specifies a numerical
20988 uid. If it begins with a digit, it is interpreted as the numerical value of the
20989 gid. Otherwise it is looked up using &[getgrnam()]&.
20990
20991
20992 .option command_user queryprogram string unset
20993 .cindex "uid (user id)" "for &(queryprogram)&"
20994 This option must be set. It specifies the uid which is set when running the
20995 command while routing an address for delivery. If the value begins with a digit,
20996 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20997 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20998 not set, a value for the gid also.
20999
21000 &*Warning:*& Changing uid and gid is possible only when Exim is running as
21001 root, which it does during a normal delivery in a conventional configuration.
21002 However, when an address is being verified during message reception, Exim is
21003 usually running as the Exim user, not as root. If the &(queryprogram)& router
21004 is called from a non-root process, Exim cannot change uid or gid before running
21005 the command. In this circumstance the command runs under the current uid and
21006 gid.
21007
21008
21009 .option current_directory queryprogram string /
21010 This option specifies an absolute path which is made the current directory
21011 before running the command.
21012
21013
21014 .option timeout queryprogram time 1h
21015 If the command does not complete within the timeout period, its process group
21016 is killed and the message is frozen. A value of zero time specifies no
21017 timeout.
21018
21019
21020 The standard output of the command is connected to a pipe, which is read when
21021 the command terminates. It should consist of a single line of output,
21022 containing up to five fields, separated by white space. The maximum length of
21023 the line is 1023 characters. Longer lines are silently truncated. The first
21024 field is one of the following words (case-insensitive):
21025
21026 .ilist
21027 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21028 below).
21029 .next
21030 &'Decline'&: the router declines; pass the address to the next router, unless
21031 &%no_more%& is set.
21032 .next
21033 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21034 subsequent text on the line is an error message. If the router is run as part
21035 of address verification during an incoming SMTP message, the message is
21036 included in the SMTP response.
21037 .next
21038 &'Defer'&: routing could not be completed at this time; try again later. Any
21039 subsequent text on the line is an error message which is logged. It is not
21040 included in any SMTP response.
21041 .next
21042 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21043 .next
21044 &'Pass'&: pass the address to the next router (or the router specified by
21045 &%pass_router%&), overriding &%no_more%&.
21046 .next
21047 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21048 new addresses, which are routed independently, starting with the first router,
21049 or the router specified by &%redirect_router%&, if set.
21050 .endlist
21051
21052 When the first word is &'accept'&, the remainder of the line consists of a
21053 number of keyed data values, as follows (split into two lines here, to fit on
21054 the page):
21055 .code
21056 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21057 LOOKUP=byname|bydns DATA=<text>
21058 .endd
21059 The data items can be given in any order, and all are optional. If no transport
21060 is included, the transport specified by the generic &%transport%& option is
21061 used. The list of hosts and the lookup type are needed only if the transport is
21062 an &(smtp)& transport that does not itself supply a list of hosts.
21063
21064 The format of the list of hosts is the same as for the &(manualroute)& router.
21065 As well as host names and IP addresses with optional port numbers, as described
21066 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21067 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21068 (see section &<<SECThostshowused>>&).
21069
21070 If the lookup type is not specified, Exim behaves as follows when trying to
21071 find an IP address for each host: First, a DNS lookup is done. If this yields
21072 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21073 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21074 result of the lookup is the result of that call.
21075
21076 .vindex "&$address_data$&"
21077 If the DATA field is set, its value is placed in the &$address_data$&
21078 variable. For example, this return line
21079 .code
21080 accept hosts=x1.y.example:x2.y.example data="rule1"
21081 .endd
21082 routes the address to the default transport, passing a list of two hosts. When
21083 the transport runs, the string &"rule1"& is in &$address_data$&.
21084 .ecindex IIDquerou1
21085 .ecindex IIDquerou2
21086
21087
21088
21089
21090 . ////////////////////////////////////////////////////////////////////////////
21091 . ////////////////////////////////////////////////////////////////////////////
21092
21093 .chapter "The redirect router" "CHAPredirect"
21094 .scindex IIDredrou1 "&(redirect)& router"
21095 .scindex IIDredrou2 "routers" "&(redirect)&"
21096 .cindex "alias file" "in a &(redirect)& router"
21097 .cindex "address redirection" "&(redirect)& router"
21098 The &(redirect)& router handles several kinds of address redirection. Its most
21099 common uses are for resolving local part aliases from a central alias file
21100 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21101 files, but it has many other potential uses. The incoming address can be
21102 redirected in several different ways:
21103
21104 .ilist
21105 It can be replaced by one or more new addresses which are themselves routed
21106 independently.
21107 .next
21108 It can be routed to be delivered to a given file or directory.
21109 .next
21110 It can be routed to be delivered to a specified pipe command.
21111 .next
21112 It can cause an automatic reply to be generated.
21113 .next
21114 It can be forced to fail, optionally with a custom error message.
21115 .next
21116 It can be temporarily deferred, optionally with a custom message.
21117 .next
21118 It can be discarded.
21119 .endlist
21120
21121 The generic &%transport%& option must not be set for &(redirect)& routers.
21122 However, there are some private options which define transports for delivery to
21123 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21124 &%pipe_transport%& and &%reply_transport%& descriptions below.
21125
21126 If success DSNs have been requested
21127 .cindex "DSN" "success"
21128 .cindex "Delivery Status Notification" "success"
21129 redirection triggers one and the DSN options are not passed any further.
21130
21131
21132
21133 .section "Redirection data" "SECID124"
21134 The router operates by interpreting a text string which it obtains either by
21135 expanding the contents of the &%data%& option, or by reading the entire
21136 contents of a file whose name is given in the &%file%& option. These two
21137 options are mutually exclusive. The first is commonly used for handling system
21138 aliases, in a configuration like this:
21139 .code
21140 system_aliases:
21141   driver = redirect
21142   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21143 .endd
21144 If the lookup fails, the expanded string in this example is empty. When the
21145 expansion of &%data%& results in an empty string, the router declines. A forced
21146 expansion failure also causes the router to decline; other expansion failures
21147 cause delivery to be deferred.
21148
21149 A configuration using &%file%& is commonly used for handling users'
21150 &_.forward_& files, like this:
21151 .code
21152 userforward:
21153   driver = redirect
21154   check_local_user
21155   file = $home/.forward
21156   no_verify
21157 .endd
21158 If the file does not exist, or causes no action to be taken (for example, it is
21159 empty or consists only of comments), the router declines. &*Warning*&: This
21160 is not the case when the file contains syntactically valid items that happen to
21161 yield empty addresses, for example, items containing only RFC 2822 address
21162 comments.
21163
21164 .cindex "tainted data" "in filenames"
21165 .cindex redirect "tainted data"
21166 Tainted data may not be used for a filename.
21167
21168 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21169 directly for redirection,
21170 as they are provided by a potential attacker.
21171 In the examples above, &$local_part$& is used for looking up data held locally
21172 on the system, and not used directly (the second example derives &$home$& via
21173 the passsword file or database, using &$local_part$&).
21174
21175
21176
21177 .section "Forward files and address verification" "SECID125"
21178 .cindex "address redirection" "while verifying"
21179 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21180 &_.forward_& files, as in the example above. There are two reasons for this:
21181
21182 .ilist
21183 When Exim is receiving an incoming SMTP message from a remote host, it is
21184 running under the Exim uid, not as root. Exim is unable to change uid to read
21185 the file as the user, and it may not be able to read it as the Exim user. So in
21186 practice the router may not be able to operate.
21187 .next
21188 However, even when the router can operate, the existence of a &_.forward_& file
21189 is unimportant when verifying an address. What should be checked is whether the
21190 local part is a valid user name or not. Cutting out the redirection processing
21191 saves some resources.
21192 .endlist
21193
21194
21195
21196
21197
21198
21199 .section "Interpreting redirection data" "SECID126"
21200 .cindex "Sieve filter" "specifying in redirection data"
21201 .cindex "filter" "specifying in redirection data"
21202 The contents of the data string, whether obtained from &%data%& or &%file%&,
21203 can be interpreted in two different ways:
21204
21205 .ilist
21206 If the &%allow_filter%& option is set true, and the data begins with the text
21207 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21208 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21209 respectively. Details of the syntax and semantics of filter files are described
21210 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21211 document is intended for use by end users.
21212 .next
21213 Otherwise, the data must be a comma-separated list of redirection items, as
21214 described in the next section.
21215 .endlist
21216
21217 When a message is redirected to a file (a &"mail folder"&), the filename given
21218 in a non-filter redirection list must always be an absolute path. A filter may
21219 generate a relative path &-- how this is handled depends on the transport's
21220 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21221 for the &(appendfile)& transport.
21222
21223
21224
21225 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21226 .cindex "address redirection" "non-filter list items"
21227 When the redirection data is not an Exim or Sieve filter, for example, if it
21228 comes from a conventional alias or forward file, it consists of a list of
21229 addresses, filenames, pipe commands, or certain special items (see section
21230 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21231 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21232 depending on their default values. The items in the list are separated by
21233 commas or newlines.
21234 If a comma is required in an item, the entire item must be enclosed in double
21235 quotes.
21236
21237 Lines starting with a # character are comments, and are ignored, and # may
21238 also appear following a comma, in which case everything between the # and the
21239 next newline character is ignored.
21240
21241 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21242 double quotes are retained because some forms of mail address require their use
21243 (but never to enclose the entire address). In the following description,
21244 &"item"& refers to what remains after any surrounding double quotes have been
21245 removed.
21246
21247 .vindex "&$local_part$&"
21248 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21249 and the expansion contains a reference to &$local_part$&, you should make use
21250 of the &%quote_local_part%& expansion operator, in case the local part contains
21251 special characters. For example, to redirect all mail for the domain
21252 &'obsolete.example'&, retaining the existing local part, you could use this
21253 setting:
21254 .code
21255 data = ${quote_local_part:$local_part}@newdomain.example
21256 .endd
21257
21258
21259 .section "Redirecting to a local mailbox" "SECTredlocmai"
21260 .cindex "routing" "loops in"
21261 .cindex "loop" "while routing, avoidance of"
21262 .cindex "address redirection" "to local mailbox"
21263 A redirection item may safely be the same as the address currently under
21264 consideration. This does not cause a routing loop, because a router is
21265 automatically skipped if any ancestor of the address that is being processed
21266 is the same as the current address and was processed by the current router.
21267 Such an address is therefore passed to the following routers, so it is handled
21268 as if there were no redirection. When making this loop-avoidance test, the
21269 complete local part, including any prefix or suffix, is used.
21270
21271 .cindex "address redirection" "local part without domain"
21272 Specifying the same local part without a domain is a common usage in personal
21273 filter files when the user wants to have messages delivered to the local
21274 mailbox and also forwarded elsewhere. For example, the user whose login is
21275 &'cleo'& might have a &_.forward_& file containing this:
21276 .code
21277 cleo, cleopatra@egypt.example
21278 .endd
21279 .cindex "backslash in alias file"
21280 .cindex "alias file" "backslash in"
21281 For compatibility with other MTAs, such unqualified local parts may be
21282 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21283 it does make a difference if more than one domain is being handled
21284 synonymously.
21285
21286 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21287 2822 address that does not include a domain, the item is qualified using the
21288 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21289 addresses are qualified using the value in &%qualify_recipient%&, but you can
21290 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21291
21292 Care must be taken if there are alias names for local users.
21293 Consider an MTA handling a single local domain where the system alias file
21294 contains:
21295 .code
21296 Sam.Reman: spqr
21297 .endd
21298 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21299 messages in the local mailbox, and also forward copies elsewhere. He creates
21300 this forward file:
21301 .code
21302 Sam.Reman, spqr@reme.elsewhere.example
21303 .endd
21304 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21305 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21306 second time round, because it has previously routed it,
21307 and the following routers presumably cannot handle the alias. The forward file
21308 should really contain
21309 .code
21310 spqr, spqr@reme.elsewhere.example
21311 .endd
21312 but because this is such a common error, the &%check_ancestor%& option (see
21313 below) exists to provide a way to get round it. This is normally set on a
21314 &(redirect)& router that is handling users' &_.forward_& files.
21315
21316
21317
21318 .section "Special items in redirection lists" "SECTspecitredli"
21319 In addition to addresses, the following types of item may appear in redirection
21320 lists (that is, in non-filter redirection data):
21321
21322 .ilist
21323 .cindex "pipe" "in redirection list"
21324 .cindex "address redirection" "to pipe"
21325 An item is treated as a pipe command if it begins with &"|"& and does not parse
21326 as a valid RFC 2822 address that includes a domain. A transport for running the
21327 command must be specified by the &%pipe_transport%& option.
21328 Normally, either the router or the transport specifies a user and a group under
21329 which to run the delivery. The default is to use the Exim user and group.
21330
21331 Single or double quotes can be used for enclosing the individual arguments of
21332 the pipe command; no interpretation of escapes is done for single quotes. If
21333 the command contains a comma character, it is necessary to put the whole item
21334 in double quotes, for example:
21335 .code
21336 "|/some/command ready,steady,go"
21337 .endd
21338 since items in redirection lists are terminated by commas. Do not, however,
21339 quote just the command. An item such as
21340 .code
21341 |"/some/command ready,steady,go"
21342 .endd
21343 is interpreted as a pipe with a rather strange command name, and no arguments.
21344
21345 Note that the above example assumes that the text comes from a lookup source
21346 of some sort, so that the quotes are part of the data.  If composing a
21347 redirect router with a &%data%& option directly specifying this command, the
21348 quotes will be used by the configuration parser to define the extent of one
21349 string, but will not be passed down into the redirect router itself.  There
21350 are two main approaches to get around this: escape quotes to be part of the
21351 data itself, or avoid using this mechanism and instead create a custom
21352 transport with the &%command%& option set and reference that transport from
21353 an &%accept%& router.
21354
21355 .next
21356 .cindex "file" "in redirection list"
21357 .cindex "address redirection" "to file"
21358 An item is interpreted as a path name if it begins with &"/"& and does not
21359 parse as a valid RFC 2822 address that includes a domain. For example,
21360 .code
21361 /home/world/minbari
21362 .endd
21363 is treated as a filename, but
21364 .code
21365 /s=molari/o=babylon/@x400gate.way
21366 .endd
21367 is treated as an address. For a filename, a transport must be specified using
21368 the &%file_transport%& option. However, if the generated path name ends with a
21369 forward slash character, it is interpreted as a directory name rather than a
21370 filename, and &%directory_transport%& is used instead.
21371
21372 Normally, either the router or the transport specifies a user and a group under
21373 which to run the delivery. The default is to use the Exim user and group.
21374
21375 .cindex "&_/dev/null_&"
21376 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21377 bypassed at a high level, and the log entry shows &"**bypassed**"&
21378 instead of a transport name. In this case the user and group are not used.
21379
21380 .next
21381 .cindex "included address list"
21382 .cindex "address redirection" "included external list"
21383 If an item is of the form
21384 .code
21385 :include:<path name>
21386 .endd
21387 a list of further items is taken from the given file and included at that
21388 point. &*Note*&: Such a file can not be a filter file; it is just an
21389 out-of-line addition to the list. The items in the included list are separated
21390 by commas or newlines and are not subject to expansion. If this is the first
21391 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21392 the alias name. This example is incorrect:
21393 .code
21394 list1    :include:/opt/lists/list1
21395 .endd
21396 It must be given as
21397 .code
21398 list1:   :include:/opt/lists/list1
21399 .endd
21400 .cindex "tainted data" "in filenames"
21401 .cindex redirect "tainted data"
21402 Tainted data may not be used for a filename.
21403 .next
21404 .cindex "address redirection" "to black hole"
21405 .cindex "delivery" "discard"
21406 .cindex "delivery" "blackhole"
21407 .cindex "black hole"
21408 .cindex "abandoning mail"
21409 Sometimes you want to throw away mail to a particular local part.  Making the
21410 &%data%& option expand to an empty string does not work, because that causes
21411 the router to decline. Instead, the alias item
21412 .code
21413 :blackhole:
21414 .endd
21415 can be used. It does what its name implies. No delivery is
21416 done, and no error message is generated. This has the same effect as specifying
21417 &_/dev/null_& as a destination, but it can be independently disabled.
21418
21419 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21420 delivery is done for the original local part, even if other redirection items
21421 are present. If you are generating a multi-item list (for example, by reading a
21422 database) and need the ability to provide a no-op item, you must use
21423 &_/dev/null_&.
21424
21425 .next
21426 .cindex "delivery" "forcing failure"
21427 .cindex "delivery" "forcing deferral"
21428 .cindex "failing delivery" "forcing"
21429 .cindex "deferred delivery, forcing"
21430 .cindex "customizing" "failure message"
21431 An attempt to deliver a particular address can be deferred or forced to fail by
21432 redirection items of the form
21433 .code
21434 :defer:
21435 :fail:
21436 .endd
21437 respectively. When a redirection list contains such an item, it applies
21438 to the entire redirection; any other items in the list are ignored. Any
21439 text following &':fail:'& or &':defer:'& is placed in the error text
21440 associated with the failure. For example, an alias file might contain:
21441 .code
21442 X.Employee:  :fail: Gone away, no forwarding address
21443 .endd
21444 In the case of an address that is being verified from an ACL or as the subject
21445 of a
21446 .cindex "VRFY" "error text, display of"
21447 VRFY command, the text is included in the SMTP error response by
21448 default.
21449 .cindex "EXPN" "error text, display of"
21450 The text is not included in the response to an EXPN command. In non-SMTP cases
21451 the text is included in the error message that Exim generates.
21452
21453 .cindex "SMTP" "error codes"
21454 By default for verify, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21455 &':fail:'&. However, if the message starts with three digits followed by a
21456 space, optionally followed by an extended code of the form &'n.n.n'&, also
21457 followed by a space, and the very first digit is the same as the default error
21458 code, the code from the message is used instead. If the very first digit is
21459 incorrect, a panic error is logged, and the default code is used. You can
21460 suppress the use of the supplied code in a redirect router by setting the
21461 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21462 ignored.
21463
21464 .vindex "&$acl_verify_message$&"
21465 In an ACL, an explicitly provided message overrides the default, but the
21466 default message is available in the variable &$acl_verify_message$& and can
21467 therefore be included in a custom message if this is desired.
21468
21469 Normally the error text is the rest of the redirection list &-- a comma does
21470 not terminate it &-- but a newline does act as a terminator. Newlines are not
21471 normally present in alias expansions. In &(lsearch)& lookups they are removed
21472 as part of the continuation process, but they may exist in other kinds of
21473 lookup and in &':include:'& files.
21474
21475 During routing for message delivery (as opposed to verification), a redirection
21476 containing &':fail:'& causes an immediate failure of the incoming address,
21477 whereas &':defer:'& causes the message to remain in the queue so that a
21478 subsequent delivery attempt can happen at a later time. If an address is
21479 deferred for too long, it will ultimately fail, because the normal retry
21480 rules still apply.
21481
21482 .next
21483 .cindex "alias file" "exception to default"
21484 Sometimes it is useful to use a single-key search type with a default (see
21485 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21486 for exceptions to the default. These can be handled by aliasing them to
21487 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21488 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21489 results in an empty redirection list has the same effect.
21490 .endlist
21491
21492
21493 .section "Duplicate addresses" "SECTdupaddr"
21494 .cindex "duplicate addresses"
21495 .cindex "address duplicate, discarding"
21496 .cindex "pipe" "duplicated"
21497 Exim removes duplicate addresses from the list to which it is delivering, so as
21498 to deliver just one copy to each address. This does not apply to deliveries
21499 routed to pipes by different immediate parent addresses, but an indirect
21500 aliasing scheme of the type
21501 .code
21502 pipe:       |/some/command $local_part
21503 localpart1: pipe
21504 localpart2: pipe
21505 .endd
21506 does not work with a message that is addressed to both local parts, because
21507 when the second is aliased to the intermediate local part &"pipe"& it gets
21508 discarded as being the same as a previously handled address. However, a scheme
21509 such as
21510 .code
21511 localpart1: |/some/command $local_part
21512 localpart2: |/some/command $local_part
21513 .endd
21514 does result in two different pipe deliveries, because the immediate parents of
21515 the pipes are distinct.
21516
21517
21518
21519 .section "Repeated redirection expansion" "SECID128"
21520 .cindex "repeated redirection expansion"
21521 .cindex "address redirection" "repeated for each delivery attempt"
21522 When a message cannot be delivered to all of its recipients immediately,
21523 leading to two or more delivery attempts, redirection expansion is carried out
21524 afresh each time for those addresses whose children were not all previously
21525 delivered. If redirection is being used as a mailing list, this can lead to new
21526 members of the list receiving copies of old messages. The &%one_time%& option
21527 can be used to avoid this.
21528
21529
21530 .section "Errors in redirection lists" "SECID129"
21531 .cindex "address redirection" "errors"
21532 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21533 error is skipped, and an entry is written to the main log. This may be useful
21534 for mailing lists that are automatically managed. Otherwise, if an error is
21535 detected while generating the list of new addresses, the original address is
21536 deferred. See also &%syntax_errors_to%&.
21537
21538
21539
21540 .section "Private options for the redirect router" "SECID130"
21541
21542 .cindex "options" "&(redirect)& router"
21543 The private options for the &(redirect)& router are as follows:
21544
21545
21546 .option allow_defer redirect boolean false
21547 Setting this option allows the use of &':defer:'& in non-filter redirection
21548 data, or the &%defer%& command in an Exim filter file.
21549
21550
21551 .option allow_fail redirect boolean false
21552 .cindex "failing delivery" "from filter"
21553 If this option is true, the &':fail:'& item can be used in a redirection list,
21554 and the &%fail%& command may be used in an Exim filter file.
21555
21556
21557 .option allow_filter redirect boolean false
21558 .cindex "filter" "enabling use of"
21559 .cindex "Sieve filter" "enabling use of"
21560 Setting this option allows Exim to interpret redirection data that starts with
21561 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21562 are some features of Exim filter files that some administrators may wish to
21563 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21564
21565 It is also possible to lock out Exim filters or Sieve filters while allowing
21566 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21567
21568
21569 The filter is run using the uid and gid set by the generic &%user%& and
21570 &%group%& options. These take their defaults from the password data if
21571 &%check_local_user%& is set, so in the normal case of users' personal filter
21572 files, the filter is run as the relevant user. When &%allow_filter%& is set
21573 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21574
21575
21576
21577 .option allow_freeze redirect boolean false
21578 .cindex "freezing messages" "allowing in filter"
21579 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21580 This command is more normally encountered in system filters, and is disabled by
21581 default for redirection filters because it isn't something you usually want to
21582 let ordinary users do.
21583
21584
21585
21586 .option check_ancestor redirect boolean false
21587 This option is concerned with handling generated addresses that are the same
21588 as some address in the list of redirection ancestors of the current address.
21589 Although it is turned off by default in the code, it is set in the default
21590 configuration file for handling users' &_.forward_& files. It is recommended
21591 for this use of the &(redirect)& router.
21592
21593 When &%check_ancestor%& is set, if a generated address (including the domain)
21594 is the same as any ancestor of the current address, it is replaced by a copy of
21595 the current address. This helps in the case where local part A is aliased to B,
21596 and B has a &_.forward_& file pointing back to A. For example, within a single
21597 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21598 &_&~jb/.forward_& contains:
21599 .code
21600 \Joe.Bloggs, <other item(s)>
21601 .endd
21602 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21603 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21604 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21605 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21606 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21607 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21608 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21609 original address. See also the &%repeat_use%& option below.
21610
21611
21612 .option check_group redirect boolean "see below"
21613 When the &%file%& option is used, the group owner of the file is checked only
21614 when this option is set. The permitted groups are those listed in the
21615 &%owngroups%& option, together with the user's default group if
21616 &%check_local_user%& is set. If the file has the wrong group, routing is
21617 deferred. The default setting for this option is true if &%check_local_user%&
21618 is set and the &%modemask%& option permits the group write bit, or if the
21619 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21620
21621
21622
21623 .option check_owner redirect boolean "see below"
21624 When the &%file%& option is used, the owner of the file is checked only when
21625 this option is set. If &%check_local_user%& is set, the local user is
21626 permitted; otherwise the owner must be one of those listed in the &%owners%&
21627 option. The default value for this option is true if &%check_local_user%& or
21628 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21629
21630
21631 .option data redirect string&!! unset
21632 This option is mutually exclusive with &%file%&. One or other of them must be
21633 set, but not both. The contents of &%data%& are expanded, and then used as the
21634 list of forwarding items, or as a set of filtering instructions. If the
21635 expansion is forced to fail, or the result is an empty string or a string that
21636 has no effect (consists entirely of comments), the router declines.
21637
21638 When filtering instructions are used, the string must begin with &"#Exim
21639 filter"&, and all comments in the string, including this initial one, must be
21640 terminated with newline characters. For example:
21641 .code
21642 data = #Exim filter\n\
21643        if $h_to: contains Exim then save $home/mail/exim endif
21644 .endd
21645 If you are reading the data from a database where newlines cannot be included,
21646 you can use the &${sg}$& expansion item to turn the escape string of your
21647 choice into a newline.
21648
21649
21650 .option directory_transport redirect string&!! unset
21651 A &(redirect)& router sets up a direct delivery to a directory when a path name
21652 ending with a slash is specified as a new &"address"&. The transport used is
21653 specified by this option, which, after expansion, must be the name of a
21654 configured transport. This should normally be an &(appendfile)& transport.
21655
21656
21657 .option file redirect string&!! unset
21658 This option specifies the name of a file that contains the redirection data. It
21659 is mutually exclusive with the &%data%& option. The string is expanded before
21660 use; if the expansion is forced to fail, the router declines. Other expansion
21661 failures cause delivery to be deferred. The result of a successful expansion
21662 must be an absolute path. The entire file is read and used as the redirection
21663 data. If the data is an empty string or a string that has no effect (consists
21664 entirely of comments), the router declines.
21665
21666 .cindex "NFS" "checking for file existence"
21667 If the attempt to open the file fails with a &"does not exist"& error, Exim
21668 runs a check on the containing directory,
21669 unless &%ignore_enotdir%& is true (see below).
21670 If the directory does not appear to exist, delivery is deferred. This can
21671 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21672 is a mount problem. If the containing directory does exist, but the file does
21673 not, the router declines.
21674
21675
21676 .option file_transport redirect string&!! unset
21677 .vindex "&$address_file$&"
21678 A &(redirect)& router sets up a direct delivery to a file when a path name not
21679 ending in a slash is specified as a new &"address"&. The transport used is
21680 specified by this option, which, after expansion, must be the name of a
21681 configured transport. This should normally be an &(appendfile)& transport. When
21682 it is running, the filename is in &$address_file$&.
21683
21684
21685 .option filter_prepend_home redirect boolean true
21686 When this option is true, if a &(save)& command in an Exim filter specifies a
21687 relative path, and &$home$& is defined, it is automatically prepended to the
21688 relative path. If this option is set false, this action does not happen. The
21689 relative path is then passed to the transport unmodified.
21690
21691
21692 .option forbid_blackhole redirect boolean false
21693 .cindex "restricting access to features"
21694 .cindex "filter" "locking out certain features"
21695 If this option is true, the &':blackhole:'& item may not appear in a
21696 redirection list.
21697
21698
21699 .option forbid_exim_filter redirect boolean false
21700 .cindex "restricting access to features"
21701 .cindex "filter" "locking out certain features"
21702 If this option is set true, only Sieve filters are permitted when
21703 &%allow_filter%& is true.
21704
21705
21706
21707
21708 .option forbid_file redirect boolean false
21709 .cindex "restricting access to features"
21710 .cindex "delivery" "to file; forbidding"
21711 .cindex "filter" "locking out certain features"
21712 .cindex "Sieve filter" "forbidding delivery to a file"
21713 .cindex "Sieve filter" "&""keep""& facility; disabling"
21714 If this option is true, this router may not generate a new address that
21715 specifies delivery to a local file or directory, either from a filter or from a
21716 conventional forward file. This option is forced to be true if &%one_time%& is
21717 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21718 locks out the Sieve's &"keep"& facility.
21719
21720
21721 .option forbid_filter_dlfunc redirect boolean false
21722 .cindex "restricting access to features"
21723 .cindex "filter" "locking out certain features"
21724 If this option is true, string expansions in Exim filters are not allowed to
21725 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21726 functions.
21727
21728 .option forbid_filter_existstest redirect boolean false
21729 .cindex "restricting access to features"
21730 .cindex "filter" "locking out certain features"
21731 .cindex "expansion" "statting a file"
21732 If this option is true, string expansions in Exim filters are not allowed to
21733 make use of the &%exists%& condition or the &%stat%& expansion item.
21734
21735 .option forbid_filter_logwrite redirect boolean false
21736 .cindex "restricting access to features"
21737 .cindex "filter" "locking out certain features"
21738 If this option is true, use of the logging facility in Exim filters is not
21739 permitted. Logging is in any case available only if the filter is being run
21740 under some unprivileged uid (which is normally the case for ordinary users'
21741 &_.forward_& files).
21742
21743
21744 .option forbid_filter_lookup redirect boolean false
21745 .cindex "restricting access to features"
21746 .cindex "filter" "locking out certain features"
21747 If this option is true, string expansions in Exim filter files are not allowed
21748 to make use of &%lookup%& items.
21749
21750
21751 .option forbid_filter_perl redirect boolean false
21752 .cindex "restricting access to features"
21753 .cindex "filter" "locking out certain features"
21754 This option has an effect only if Exim is built with embedded Perl support. If
21755 it is true, string expansions in Exim filter files are not allowed to make use
21756 of the embedded Perl support.
21757
21758
21759 .option forbid_filter_readfile redirect boolean false
21760 .cindex "restricting access to features"
21761 .cindex "filter" "locking out certain features"
21762 If this option is true, string expansions in Exim filter files are not allowed
21763 to make use of &%readfile%& items.
21764
21765
21766 .option forbid_filter_readsocket redirect boolean false
21767 .cindex "restricting access to features"
21768 .cindex "filter" "locking out certain features"
21769 If this option is true, string expansions in Exim filter files are not allowed
21770 to make use of &%readsocket%& items.
21771
21772
21773 .option forbid_filter_reply redirect boolean false
21774 .cindex "restricting access to features"
21775 .cindex "filter" "locking out certain features"
21776 If this option is true, this router may not generate an automatic reply
21777 message. Automatic replies can be generated only from Exim or Sieve filter
21778 files, not from traditional forward files. This option is forced to be true if
21779 &%one_time%& is set.
21780
21781
21782 .option forbid_filter_run redirect boolean false
21783 .cindex "restricting access to features"
21784 .cindex "filter" "locking out certain features"
21785 If this option is true, string expansions in Exim filter files are not allowed
21786 to make use of &%run%& items.
21787
21788
21789 .option forbid_include redirect boolean false
21790 .cindex "restricting access to features"
21791 .cindex "filter" "locking out certain features"
21792 If this option is true, items of the form
21793 .code
21794 :include:<path name>
21795 .endd
21796 are not permitted in non-filter redirection lists.
21797
21798
21799 .option forbid_pipe redirect boolean false
21800 .cindex "restricting access to features"
21801 .cindex "filter" "locking out certain features"
21802 .cindex "delivery" "to pipe; forbidding"
21803 If this option is true, this router may not generate a new address which
21804 specifies delivery to a pipe, either from an Exim filter or from a conventional
21805 forward file. This option is forced to be true if &%one_time%& is set.
21806
21807
21808 .option forbid_sieve_filter redirect boolean false
21809 .cindex "restricting access to features"
21810 .cindex "filter" "locking out certain features"
21811 If this option is set true, only Exim filters are permitted when
21812 &%allow_filter%& is true.
21813
21814
21815 .cindex "SMTP" "error codes"
21816 .option forbid_smtp_code redirect boolean false
21817 If this option is set true, any SMTP error codes that are present at the start
21818 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21819 the default codes (451 and 550, respectively) are always used.
21820
21821
21822
21823
21824 .option hide_child_in_errmsg redirect boolean false
21825 .cindex "bounce message" "redirection details; suppressing"
21826 If this option is true, it prevents Exim from quoting a child address if it
21827 generates a bounce or delay message for it. Instead it says &"an address
21828 generated from <&'the top level address'&>"&. Of course, this applies only to
21829 bounces generated locally. If a message is forwarded to another host, &'its'&
21830 bounce may well quote the generated address.
21831
21832
21833 .option ignore_eacces redirect boolean false
21834 .cindex "EACCES"
21835 If this option is set and an attempt to open a redirection file yields the
21836 EACCES error (permission denied), the &(redirect)& router behaves as if the
21837 file did not exist.
21838
21839
21840 .option ignore_enotdir redirect boolean false
21841 .cindex "ENOTDIR"
21842 If this option is set and an attempt to open a redirection file yields the
21843 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21844 router behaves as if the file did not exist.
21845
21846 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21847 router that has the &%file%& option set discovers that the file does not exist
21848 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21849 against unmounted NFS directories. If the parent can not be statted, delivery
21850 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21851 is set, because that option tells Exim to ignore &"something on the path is not
21852 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21853 that some operating systems give ENOENT where others give ENOTDIR.
21854
21855
21856
21857 .option include_directory redirect string unset
21858 If this option is set, the path names of any &':include:'& items in a
21859 redirection list must start with this directory.
21860
21861
21862 .option modemask redirect "octal integer" 022
21863 This specifies mode bits which must not be set for a file specified by the
21864 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21865
21866
21867 .option one_time redirect boolean false
21868 .cindex "one-time aliasing/forwarding expansion"
21869 .cindex "alias file" "one-time expansion"
21870 .cindex "forward file" "one-time expansion"
21871 .cindex "mailing lists" "one-time expansion"
21872 .cindex "address redirection" "one-time expansion"
21873 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21874 files each time it tries to deliver a message causes a problem when one or more
21875 of the generated addresses fails be delivered at the first attempt. The problem
21876 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21877 but of what happens when the redirection list changes during the time that the
21878 message is on Exim's queue. This is particularly true in the case of mailing
21879 lists, where new subscribers might receive copies of messages that were posted
21880 before they subscribed.
21881
21882 If &%one_time%& is set and any addresses generated by the router fail to
21883 deliver at the first attempt, the failing addresses are added to the message as
21884 &"top level"& addresses, and the parent address that generated them is marked
21885 &"delivered"&. Thus, redirection does not happen again at the next delivery
21886 attempt.
21887
21888 &*Warning 1*&: Any header line addition or removal that is specified by this
21889 router would be lost if delivery did not succeed at the first attempt. For this
21890 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21891 permitted when &%one_time%& is set.
21892
21893 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21894 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21895 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21896
21897 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21898 &%one_time%&.
21899
21900 The original top-level address is remembered with each of the generated
21901 addresses, and is output in any log messages. However, any intermediate parent
21902 addresses are not recorded. This makes a difference to the log only if
21903 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21904 typically be used for mailing lists, where there is normally just one level of
21905 expansion.
21906
21907
21908 .option owners redirect "string list" unset
21909 .cindex "ownership" "alias file"
21910 .cindex "ownership" "forward file"
21911 .cindex "alias file" "ownership"
21912 .cindex "forward file" "ownership"
21913 This specifies a list of permitted owners for the file specified by &%file%&.
21914 This list is in addition to the local user when &%check_local_user%& is set.
21915 See &%check_owner%& above.
21916
21917
21918 .option owngroups redirect "string list" unset
21919 This specifies a list of permitted groups for the file specified by &%file%&.
21920 The list is in addition to the local user's primary group when
21921 &%check_local_user%& is set. See &%check_group%& above.
21922
21923
21924 .option pipe_transport redirect string&!! unset
21925 .vindex "&$address_pipe$&"
21926 A &(redirect)& router sets up a direct delivery to a pipe when a string
21927 starting with a vertical bar character is specified as a new &"address"&. The
21928 transport used is specified by this option, which, after expansion, must be the
21929 name of a configured transport. This should normally be a &(pipe)& transport.
21930 When the transport is run, the pipe command is in &$address_pipe$&.
21931
21932
21933 .option qualify_domain redirect string&!! unset
21934 .vindex "&$qualify_recipient$&"
21935 If this option is set, and an unqualified address (one without a domain) is
21936 generated, and that address would normally be qualified by the global setting
21937 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21938 expanding this string. If the expansion fails, the router declines. If you want
21939 to revert to the default, you can have the expansion generate
21940 &$qualify_recipient$&.
21941
21942 This option applies to all unqualified addresses generated by Exim filters,
21943 but for traditional &_.forward_& files, it applies only to addresses that are
21944 not preceded by a backslash. Sieve filters cannot generate unqualified
21945 addresses.
21946
21947 .option qualify_preserve_domain redirect boolean false
21948 .cindex "domain" "in redirection; preserving"
21949 .cindex "preserving domain in redirection"
21950 .cindex "address redirection" "domain; preserving"
21951 If this option is set, the router's local &%qualify_domain%& option must not be
21952 set (a configuration error occurs if it is). If an unqualified address (one
21953 without a domain) is generated, it is qualified with the domain of the parent
21954 address (the immediately preceding ancestor) instead of the global
21955 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21956 this applies whether or not the address is preceded by a backslash.
21957
21958
21959 .option repeat_use redirect boolean true
21960 If this option is set false, the router is skipped for a child address that has
21961 any ancestor that was routed by this router. This test happens before any of
21962 the other preconditions are tested. Exim's default anti-looping rules skip
21963 only when the ancestor is the same as the current address. See also
21964 &%check_ancestor%& above and the generic &%redirect_router%& option.
21965
21966
21967 .option reply_transport redirect string&!! unset
21968 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21969 &%vacation%& command is used in a filter file. The transport used is specified
21970 by this option, which, after expansion, must be the name of a configured
21971 transport. This should normally be an &(autoreply)& transport. Other transports
21972 are unlikely to do anything sensible or useful.
21973
21974
21975 .option rewrite redirect boolean true
21976 .cindex "address redirection" "disabling rewriting"
21977 If this option is set false, addresses generated by the router are not
21978 subject to address rewriting. Otherwise, they are treated like new addresses
21979 and are rewritten according to the global rewriting rules.
21980
21981
21982 .option sieve_subaddress redirect string&!! unset
21983 The value of this option is passed to a Sieve filter to specify the
21984 :subaddress part of an address.
21985
21986 .option sieve_useraddress redirect string&!! unset
21987 The value of this option is passed to a Sieve filter to specify the :user part
21988 of an address. However, if it is unset, the entire original local part
21989 (including any prefix or suffix) is used for :user.
21990
21991
21992 .option sieve_vacation_directory redirect string&!! unset
21993 .cindex "Sieve filter" "vacation directory"
21994 To enable the &"vacation"& extension for Sieve filters, you must set
21995 &%sieve_vacation_directory%& to the directory where vacation databases are held
21996 (do not put anything else in that directory), and ensure that the
21997 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21998 needs their own directory; Exim will create it if necessary.
21999
22000
22001
22002 .option skip_syntax_errors redirect boolean false
22003 .cindex "forward file" "broken"
22004 .cindex "address redirection" "broken files"
22005 .cindex "alias file" "broken"
22006 .cindex "broken alias or forward files"
22007 .cindex "ignoring faulty addresses"
22008 .cindex "skipping faulty addresses"
22009 .cindex "error" "skipping bad syntax"
22010 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22011 non-filter redirection data are skipped, and each failing address is logged. If
22012 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22013 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22014 are expanded and placed at the head of the error message generated by
22015 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22016 be the same address as the generic &%errors_to%& option. The
22017 &%skip_syntax_errors%& option is often used when handling mailing lists.
22018
22019 If all the addresses in a redirection list are skipped because of syntax
22020 errors, the router declines to handle the original address, and it is passed to
22021 the following routers.
22022
22023 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22024 error in the filter causes filtering to be abandoned without any action being
22025 taken. The incident is logged, and the router declines to handle the address,
22026 so it is passed to the following routers.
22027
22028 .cindex "Sieve filter" "syntax errors in"
22029 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22030 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22031 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22032
22033 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22034 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22035 option, used with an address that does not get redirected, can be used to
22036 notify users of these errors, by means of a router like this:
22037 .code
22038 userforward:
22039   driver = redirect
22040   allow_filter
22041   check_local_user
22042   file = $home/.forward
22043   file_transport = address_file
22044   pipe_transport = address_pipe
22045   reply_transport = address_reply
22046   no_verify
22047   skip_syntax_errors
22048   syntax_errors_to = real-$local_part@$domain
22049   syntax_errors_text = \
22050    This is an automatically generated message. An error has\n\
22051    been found in your .forward file. Details of the error are\n\
22052    reported below. While this error persists, you will receive\n\
22053    a copy of this message for every message that is addressed\n\
22054    to you. If your .forward file is a filter file, or if it is\n\
22055    a non-filter file containing no valid forwarding addresses,\n\
22056    a copy of each incoming message will be put in your normal\n\
22057    mailbox. If a non-filter file contains at least one valid\n\
22058    forwarding address, forwarding to the valid addresses will\n\
22059    happen, and those will be the only deliveries that occur.
22060 .endd
22061 You also need a router to ensure that local addresses that are prefixed by
22062 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22063 put this immediately before the &(userforward)& router:
22064 .code
22065 real_localuser:
22066   driver = accept
22067   check_local_user
22068   local_part_prefix = real-
22069   transport = local_delivery
22070 .endd
22071 For security, it would probably be a good idea to restrict the use of this
22072 router to locally-generated messages, using a condition such as this:
22073 .code
22074   condition = ${if match {$sender_host_address}\
22075                          {\N^(|127\.0\.0\.1)$\N}}
22076 .endd
22077
22078
22079 .option syntax_errors_text redirect string&!! unset
22080 See &%skip_syntax_errors%& above.
22081
22082
22083 .option syntax_errors_to redirect string unset
22084 See &%skip_syntax_errors%& above.
22085 .ecindex IIDredrou1
22086 .ecindex IIDredrou2
22087
22088
22089
22090
22091
22092
22093 . ////////////////////////////////////////////////////////////////////////////
22094 . ////////////////////////////////////////////////////////////////////////////
22095
22096 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22097          "Environment for local transports"
22098 .scindex IIDenvlotra1 "local transports" "environment for"
22099 .scindex IIDenvlotra2 "environment" "local transports"
22100 .scindex IIDenvlotra3 "transport" "local; environment for"
22101 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22102 transport can be thought of as similar to a pipe.) Exim always runs transports
22103 in subprocesses, under specified uids and gids. Typical deliveries to local
22104 mailboxes run under the uid and gid of the local user.
22105
22106 Exim also sets a specific current directory while running the transport; for
22107 some transports a home directory setting is also relevant. The &(pipe)&
22108 transport is the only one that sets up environment variables; see section
22109 &<<SECTpipeenv>>& for details.
22110
22111 The values used for the uid, gid, and the directories may come from several
22112 different places. In many cases, the router that handles the address associates
22113 settings with that address as a result of its &%check_local_user%&, &%group%&,
22114 or &%user%& options. However, values may also be given in the transport's own
22115 configuration, and these override anything that comes from the router.
22116
22117
22118
22119 .section "Concurrent deliveries" "SECID131"
22120 .cindex "concurrent deliveries"
22121 .cindex "simultaneous deliveries"
22122 If two different messages for the same local recipient arrive more or less
22123 simultaneously, the two delivery processes are likely to run concurrently. When
22124 the &(appendfile)& transport is used to write to a file, Exim applies locking
22125 rules to stop concurrent processes from writing to the same file at the same
22126 time.
22127
22128 However, when you use a &(pipe)& transport, it is up to you to arrange any
22129 locking that is needed. Here is a silly example:
22130 .code
22131 my_transport:
22132   driver = pipe
22133   command = /bin/sh -c 'cat >>/some/file'
22134 .endd
22135 This is supposed to write the message at the end of the file. However, if two
22136 messages arrive at the same time, the file will be scrambled. You can use the
22137 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22138 file using the same algorithm that Exim itself uses.
22139
22140
22141
22142
22143 .section "Uids and gids" "SECTenvuidgid"
22144 .cindex "local transports" "uid and gid"
22145 .cindex "transport" "local; uid and gid"
22146 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22147 overrides any group that the router set in the address, even if &%user%& is not
22148 set for the transport. This makes it possible, for example, to run local mail
22149 delivery under the uid of the recipient (set by the router), but in a special
22150 group (set by the transport). For example:
22151 .code
22152 # Routers ...
22153 # User/group are set by check_local_user in this router
22154 local_users:
22155   driver = accept
22156   check_local_user
22157   transport = group_delivery
22158
22159 # Transports ...
22160 # This transport overrides the group
22161 group_delivery:
22162   driver = appendfile
22163   file = /var/spool/mail/$local_part_data
22164   group = mail
22165 .endd
22166 If &%user%& is set for a transport, its value overrides what is set in the
22167 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22168 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22169 set.
22170
22171 .oindex "&%initgroups%&"
22172 When the uid is taken from the transport's configuration, the &[initgroups()]&
22173 function is called for the groups associated with that uid if the
22174 &%initgroups%& option is set for the transport. When the uid is not specified
22175 by the transport, but is associated with the address by a router, the option
22176 for calling &[initgroups()]& is taken from the router configuration.
22177
22178 .cindex "&(pipe)& transport" "uid for"
22179 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22180 is set and &%user%& is not set, the uid of the process that called Exim to
22181 receive the message is used, and if &%group%& is not set, the corresponding
22182 original gid is also used.
22183
22184 This is the detailed preference order for obtaining a gid; the first of the
22185 following that is set is used:
22186
22187 .ilist
22188 A &%group%& setting of the transport;
22189 .next
22190 A &%group%& setting of the router;
22191 .next
22192 A gid associated with a user setting of the router, either as a result of
22193 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22194 .next
22195 The group associated with a non-numeric &%user%& setting of the transport;
22196 .next
22197 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22198 the uid is the creator's uid;
22199 .next
22200 The Exim gid if the Exim uid is being used as a default.
22201 .endlist
22202
22203 If, for example, the user is specified numerically on the router and there are
22204 no group settings, no gid is available. In this situation, an error occurs.
22205 This is different for the uid, for which there always is an ultimate default.
22206 The first of the following that is set is used:
22207
22208 .ilist
22209 A &%user%& setting of the transport;
22210 .next
22211 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22212 .next
22213 A &%user%& setting of the router;
22214 .next
22215 A &%check_local_user%& setting of the router;
22216 .next
22217 The Exim uid.
22218 .endlist
22219
22220 Of course, an error will still occur if the uid that is chosen is on the
22221 &%never_users%& list.
22222
22223
22224
22225
22226
22227 .section "Current and home directories" "SECID132"
22228 .cindex "current directory for local transport"
22229 .cindex "home directory" "for local transport"
22230 .cindex "transport" "local; home directory for"
22231 .cindex "transport" "local; current directory for"
22232 Routers may set current and home directories for local transports by means of
22233 the &%transport_current_directory%& and &%transport_home_directory%& options.
22234 However, if the transport's &%current_directory%& or &%home_directory%& options
22235 are set, they override the router's values. In detail, the home directory
22236 for a local transport is taken from the first of these values that is set:
22237
22238 .ilist
22239 The &%home_directory%& option on the transport;
22240 .next
22241 The &%transport_home_directory%& option on the router;
22242 .next
22243 The password data if &%check_local_user%& is set on the router;
22244 .next
22245 The &%router_home_directory%& option on the router.
22246 .endlist
22247
22248 The current directory is taken from the first of these values that is set:
22249
22250 .ilist
22251 The &%current_directory%& option on the transport;
22252 .next
22253 The &%transport_current_directory%& option on the router.
22254 .endlist
22255
22256
22257 If neither the router nor the transport sets a current directory, Exim uses the
22258 value of the home directory, if it is set. Otherwise it sets the current
22259 directory to &_/_& before running a local transport.
22260
22261
22262
22263 .section "Expansion variables derived from the address" "SECID133"
22264 .vindex "&$domain$&"
22265 .vindex "&$local_part$&"
22266 .vindex "&$original_domain$&"
22267 Normally a local delivery is handling a single address, and in that case the
22268 variables such as &$domain$& and &$local_part$& are set during local
22269 deliveries. However, in some circumstances more than one address may be handled
22270 at once (for example, while writing batch SMTP for onward transmission by some
22271 other means). In this case, the variables associated with the local part are
22272 never set, &$domain$& is set only if all the addresses have the same domain,
22273 and &$original_domain$& is never set.
22274 .ecindex IIDenvlotra1
22275 .ecindex IIDenvlotra2
22276 .ecindex IIDenvlotra3
22277
22278
22279
22280
22281
22282
22283
22284 . ////////////////////////////////////////////////////////////////////////////
22285 . ////////////////////////////////////////////////////////////////////////////
22286
22287 .chapter "Generic options for transports" "CHAPtransportgeneric"
22288 .scindex IIDgenoptra1 "generic options" "transport"
22289 .scindex IIDgenoptra2 "options" "generic; for transports"
22290 .scindex IIDgenoptra3 "transport" "generic options for"
22291 The name of a transport is limited to be &drivernamemax; ASCII characters long;
22292 prior to Exim 4.95 names would be silently truncated at this length, but now
22293 it is enforced.
22294
22295 The following generic options apply to all transports:
22296
22297
22298 .option body_only transports boolean false
22299 .cindex "transport" "body only"
22300 .cindex "message" "transporting body only"
22301 .cindex "body of message" "transporting"
22302 If this option is set, the message's headers are not transported. It is
22303 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22304 or &(pipe)& transports, the settings of &%message_prefix%& and
22305 &%message_suffix%& should be checked, because this option does not
22306 automatically suppress them.
22307
22308
22309 .option current_directory transports string&!! unset
22310 .cindex "transport" "current directory for"
22311 This specifies the current directory that is to be set while running the
22312 transport, overriding any value that may have been set by the router.
22313 If the expansion fails for any reason, including forced failure, an error is
22314 logged, and delivery is deferred.
22315
22316
22317 .option disable_logging transports boolean false
22318 If this option is set true, nothing is logged for any
22319 deliveries by the transport or for any
22320 transport errors. You should not set this option unless you really, really know
22321 what you are doing.
22322
22323
22324 .option debug_print transports string&!! unset
22325 .cindex "testing" "variables in drivers"
22326 If this option is set and debugging is enabled (see the &%-d%& command line
22327 option), the string is expanded and included in the debugging output when the
22328 transport is run.
22329 If expansion of the string fails, the error message is written to the debugging
22330 output, and Exim carries on processing.
22331 This facility is provided to help with checking out the values of variables and
22332 so on when debugging driver configurations. For example, if a &%headers_add%&
22333 option is not working properly, &%debug_print%& could be used to output the
22334 variables it references. A newline is added to the text if it does not end with
22335 one.
22336 The variables &$transport_name$& and &$router_name$& contain the name of the
22337 transport and the router that called it.
22338
22339 .option delivery_date_add transports boolean false
22340 .cindex "&'Delivery-date:'& header line"
22341 If this option is true, a &'Delivery-date:'& header is added to the message.
22342 This gives the actual time the delivery was made. As this is not a standard
22343 header, Exim has a configuration option (&%delivery_date_remove%&) which
22344 requests its removal from incoming messages, so that delivered messages can
22345 safely be resent to other recipients.
22346
22347
22348 .option driver transports string unset
22349 This specifies which of the available transport drivers is to be used.
22350 There is no default, and this option must be set for every transport.
22351
22352
22353 .option envelope_to_add transports boolean false
22354 .cindex "&'Envelope-to:'& header line"
22355 If this option is true, an &'Envelope-to:'& header is added to the message.
22356 This gives the original address(es) in the incoming envelope that caused this
22357 delivery to happen. More than one address may be present if the transport is
22358 configured to handle several addresses at once, or if more than one original
22359 address was redirected to the same final address. As this is not a standard
22360 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22361 its removal from incoming messages, so that delivered messages can safely be
22362 resent to other recipients.
22363
22364 &*Note:*& If used on a transport handling multiple recipients
22365 (the smtp transport unless &%rcpt_max%& is 1, the appendfile, pipe or lmtp
22366 transport if &%batch_max%& is greater than 1)
22367 then information about Bcc recipients will be leaked.
22368 Doing so is generally not advised.
22369
22370
22371 .option event_action transports string&!! unset
22372 .cindex events
22373 This option declares a string to be expanded for Exim's events mechanism.
22374 For details see chapter &<<CHAPevents>>&.
22375
22376
22377 .option group transports string&!! "Exim group"
22378 .cindex "transport" "group; specifying"
22379 This option specifies a gid for running the transport process, overriding any
22380 value that the router supplies, and also overriding any value associated with
22381 &%user%& (see below).
22382
22383
22384 .option headers_add transports list&!! unset
22385 .cindex "header lines" "adding in transport"
22386 .cindex "transport" "header lines; adding"
22387 This option specifies a list of text headers,
22388 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22389 which are (separately) expanded and added to the header
22390 portion of a message as it is transported, as described in section
22391 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22392 routers. If the result of the expansion is an empty string, or if the expansion
22393 is forced to fail, no action is taken. Other expansion failures are treated as
22394 errors and cause the delivery to be deferred.
22395
22396 Unlike most options, &%headers_add%& can be specified multiple times
22397 for a transport; all listed headers are added.
22398
22399
22400 .option headers_only transports boolean false
22401 .cindex "transport" "header lines only"
22402 .cindex "message" "transporting headers only"
22403 .cindex "header lines" "transporting"
22404 If this option is set, the message's body is not transported. It is mutually
22405 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22406 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22407 checked, since this option does not automatically suppress them.
22408
22409
22410 .option headers_remove transports list&!! unset
22411 .cindex "header lines" "removing"
22412 .cindex "transport" "header lines; removing"
22413 This option specifies a list of text headers,
22414 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22415 to be removed from the message.
22416 However, the option has no effect when an address is just being verified.
22417 Each list item is separately expanded.
22418 If the result of the expansion is an empty string, or if the expansion
22419 is forced to fail, no action is taken. Other expansion failures are treated as
22420 errors and cause the delivery to be deferred.
22421 If an item ends in *, it will match any header with the given prefix.
22422
22423 Matching headers are omitted from the message as it is transported, as described
22424 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22425 routers.
22426
22427 Unlike most options, &%headers_remove%& can be specified multiple times
22428 for a transport; all listed headers are removed.
22429
22430 &*Warning*&: Because of the separate expansion of the list items,
22431 items that contain a list separator must have it doubled.
22432 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22433
22434
22435
22436 .option headers_rewrite transports string unset
22437 .cindex "transport" "header lines; rewriting"
22438 .cindex "rewriting" "at transport time"
22439 This option allows addresses in header lines to be rewritten at transport time,
22440 that is, as the message is being copied to its destination. The contents of the
22441 option are a colon-separated list of rewriting rules. Each rule is in exactly
22442 the same form as one of the general rewriting rules that are applied when a
22443 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22444 example,
22445 .code
22446 headers_rewrite = a@b c@d f : \
22447                   x@y w@z
22448 .endd
22449 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22450 &'w@z'& in all address-bearing header lines. The rules are applied to the
22451 header lines just before they are written out at transport time, so they affect
22452 only those copies of the message that pass through the transport. However, only
22453 the message's original header lines, and any that were added by a system
22454 filter, are rewritten. If a router or transport adds header lines, they are not
22455 affected by this option. These rewriting rules are &'not'& applied to the
22456 envelope. You can change the return path using &%return_path%&, but you cannot
22457 change envelope recipients at this time.
22458
22459
22460 .option home_directory transports string&!! unset
22461 .cindex "transport" "home directory for"
22462 .vindex "&$home$&"
22463 This option specifies a home directory setting for a local transport,
22464 overriding any value that may be set by the router. The home directory is
22465 placed in &$home$& while expanding the transport's private options. It is also
22466 used as the current directory if no current directory is set by the
22467 &%current_directory%& option on the transport or the
22468 &%transport_current_directory%& option on the router. If the expansion fails
22469 for any reason, including forced failure, an error is logged, and delivery is
22470 deferred.
22471
22472
22473 .option initgroups transports boolean false
22474 .cindex "additional groups"
22475 .cindex "groups" "additional"
22476 .cindex "transport" "group; additional"
22477 If this option is true and the uid for the delivery process is provided by the
22478 transport, the &[initgroups()]& function is called when running the transport
22479 to ensure that any additional groups associated with the uid are set up.
22480
22481
22482 .option max_parallel transports integer&!! unset
22483 .cindex limit "transport parallelism"
22484 .cindex transport "parallel processes"
22485 .cindex transport "concurrency limit"
22486 .cindex "delivery" "parallelism for transport"
22487 If this option is set and expands to an integer greater than zero
22488 it limits the number of concurrent runs of the transport.
22489 The control does not apply to shadow transports.
22490
22491 .cindex "hints database" "transport concurrency control"
22492 Exim implements this control by means of a hints database in which a record is
22493 incremented whenever a transport process is being created. The record
22494 is decremented and possibly removed when the process terminates.
22495 Obviously there is scope for
22496 records to get left lying around if there is a system or program crash. To
22497 guard against this, Exim ignores any records that are more than six hours old.
22498
22499 If you use this option, you should also arrange to delete the
22500 relevant hints database whenever your system reboots. The names of the files
22501 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22502 may be one or two files, depending on the type of DBM in use. The same files
22503 are used for ETRN and smtp transport serialization.
22504
22505
22506 .option message_size_limit transports string&!! 0
22507 .cindex "limit" "message size per transport"
22508 .cindex "size" "of message, limit"
22509 .cindex "transport" "message size; limiting"
22510 This option controls the size of messages passed through the transport. It is
22511 expanded before use; the result of the expansion must be a sequence of decimal
22512 digits, optionally followed by K or M. If the expansion fails for any reason,
22513 including forced failure, or if the result is not of the required form,
22514 delivery is deferred. If the value is greater than zero and the size of a
22515 message exceeds this limit, the address is failed. If there is any chance that
22516 the resulting bounce message could be routed to the same transport, you should
22517 ensure that &%return_size_limit%& is less than the transport's
22518 &%message_size_limit%&, as otherwise the bounce message will fail to get
22519 delivered.
22520
22521
22522
22523 .option rcpt_include_affixes transports boolean false
22524 .cindex "prefix" "for local part, including in envelope"
22525 .cindex "suffix for local part" "including in envelope"
22526 .cindex "local part" "prefix"
22527 .cindex "local part" "suffix"
22528 When this option is false (the default), and an address that has had any
22529 affixes (prefixes or suffixes) removed from the local part is delivered by any
22530 form of SMTP or LMTP, the affixes are not included. For example, if a router
22531 that contains
22532 .code
22533 local_part_prefix = *-
22534 .endd
22535 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22536 is delivered with
22537 .code
22538 RCPT TO:<xyz@some.domain>
22539 .endd
22540 This is also the case when an ACL-time callout is being used to verify a
22541 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22542 whole local part is included in the RCPT command. This option applies to BSMTP
22543 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22544 &(lmtp)& and &(smtp)& transports.
22545
22546
22547 .option retry_use_local_part transports boolean "see below"
22548 .cindex "hints database" "retry keys"
22549 When a delivery suffers a temporary failure, a retry record is created
22550 in Exim's hints database. For remote deliveries, the key for the retry record
22551 is based on the name and/or IP address of the failing remote host. For local
22552 deliveries, the key is normally the entire address, including both the local
22553 part and the domain. This is suitable for most common cases of local delivery
22554 temporary failure &-- for example, exceeding a mailbox quota should delay only
22555 deliveries to that mailbox, not to the whole domain.
22556
22557 However, in some special cases you may want to treat a temporary local delivery
22558 as a failure associated with the domain, and not with a particular local part.
22559 (For example, if you are storing all mail for some domain in files.) You can do
22560 this by setting &%retry_use_local_part%& false.
22561
22562 For all the local transports, its default value is true. For remote transports,
22563 the default value is false for tidiness, but changing the value has no effect
22564 on a remote transport in the current implementation.
22565
22566
22567 .option return_path transports string&!! unset
22568 .cindex "envelope sender"
22569 .cindex "envelope from"
22570 .cindex "transport" "return path; changing"
22571 .cindex "return path" "changing in transport"
22572 If this option is set, the string is expanded at transport time and replaces
22573 the existing return path (envelope sender) value in the copy of the message
22574 that is being delivered. An empty return path is permitted. This feature is
22575 designed for remote deliveries, where the value of this option is used in the
22576 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22577 only effect is to change the address that is placed in the &'Return-path:'&
22578 header line, if one is added to the message (see the next option).
22579
22580 &*Note:*& A changed return path is not logged unless you add
22581 &%return_path_on_delivery%& to the log selector.
22582
22583 .vindex "&$return_path$&"
22584 The expansion can refer to the existing value via &$return_path$&. This is
22585 either the message's envelope sender, or an address set by the
22586 &%errors_to%& option on a router. If the expansion is forced to fail, no
22587 replacement occurs; if it fails for another reason, delivery is deferred. This
22588 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22589 section &<<SECTverp>>&.
22590
22591 &*Note*&: If a delivery error is detected locally, including the case when a
22592 remote server rejects a message at SMTP time, the bounce message is not sent to
22593 the value of this option. It is sent to the previously set errors address.
22594 This defaults to the incoming sender address, but can be changed by setting
22595 &%errors_to%& in a router.
22596
22597
22598
22599 .option return_path_add transports boolean false
22600 .chindex Return-path:
22601 If this option is true, a &'Return-path:'& header is added to the message.
22602 Although the return path is normally available in the prefix line of BSD
22603 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22604 have easy access to it.
22605
22606 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22607 the delivery SMTP server makes the final delivery"&. This implies that this
22608 header should not be present in incoming messages. Exim has a configuration
22609 option, &%return_path_remove%&, which requests removal of this header from
22610 incoming messages, so that delivered messages can safely be resent to other
22611 recipients.
22612
22613
22614 .option shadow_condition transports string&!! unset
22615 See &%shadow_transport%& below.
22616
22617
22618 .option shadow_transport transports string unset
22619 .cindex "shadow transport"
22620 .cindex "transport" "shadow"
22621 A local transport may set the &%shadow_transport%& option to the name of
22622 another local transport. Shadow remote transports are not supported.
22623
22624 Whenever a delivery to the main transport succeeds, and either
22625 &%shadow_condition%& is unset, or its expansion does not result in the empty
22626 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22627 passed to the shadow transport, with the same delivery address or addresses. If
22628 expansion fails, no action is taken except that non-forced expansion failures
22629 cause a log line to be written.
22630
22631 The result of the shadow transport is discarded and does not affect the
22632 subsequent processing of the message. Only a single level of shadowing is
22633 provided; the &%shadow_transport%& option is ignored on any transport when it
22634 is running as a shadow. Options concerned with output from pipes are also
22635 ignored. The log line for the successful delivery has an item added on the end,
22636 of the form
22637 .code
22638 ST=<shadow transport name>
22639 .endd
22640 If the shadow transport did not succeed, the error message is put in
22641 parentheses afterwards. Shadow transports can be used for a number of different
22642 purposes, including keeping more detailed log information than Exim normally
22643 provides, and implementing automatic acknowledgment policies based on message
22644 headers that some sites insist on.
22645
22646
22647 .option transport_filter transports string&!! unset
22648 .cindex "transport" "filter"
22649 .cindex "filter" "transport filter"
22650 This option sets up a filtering (in the Unix shell sense) process for messages
22651 at transport time. It should not be confused with mail filtering as set up by
22652 individual users or via a system filter.
22653 If unset, or expanding to an empty string, no filtering is done.
22654
22655 When the message is about to be written out, the command specified by
22656 &%transport_filter%& is started up in a separate, parallel process, and
22657 the entire message, including the header lines, is passed to it on its standard
22658 input (this in fact is done from a third process, to avoid deadlock). The
22659 command must be specified as an absolute path.
22660
22661 The lines of the message that are written to the transport filter are
22662 terminated by newline (&"\n"&). The message is passed to the filter before any
22663 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22664 lines beginning with a dot, and also before any processing implied by the
22665 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22666 &(pipe)& transports.
22667
22668 The standard error for the filter process is set to the same destination as its
22669 standard output; this is read and written to the message's ultimate
22670 destination. The process that writes the message to the filter, the
22671 filter itself, and the original process that reads the result and delivers it
22672 are all run in parallel, like a shell pipeline.
22673
22674 The filter can perform any transformations it likes, but of course should take
22675 care not to break RFC 2822 syntax. Exim does not check the result, except to
22676 test for a final newline when SMTP is in use. All messages transmitted over
22677 SMTP must end with a newline, so Exim supplies one if it is missing.
22678
22679 .cindex "content scanning" "per user"
22680 A transport filter can be used to provide content-scanning on a per-user basis
22681 at delivery time if the only required effect of the scan is to modify the
22682 message. For example, a content scan could insert a new header line containing
22683 a spam score. This could be interpreted by a filter in the user's MUA. It is
22684 not possible to discard a message at this stage.
22685
22686 .cindex "SIZE" "ESMTP extension"
22687 A problem might arise if the filter increases the size of a message that is
22688 being sent down an SMTP connection. If the receiving SMTP server has indicated
22689 support for the SIZE parameter, Exim will have sent the size of the message
22690 at the start of the SMTP session. If what is actually sent is substantially
22691 more, the server might reject the message. This can be worked round by setting
22692 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22693 additions to the message, or to disable the use of SIZE altogether.
22694
22695 .vindex "&$pipe_addresses$&"
22696 The value of the &%transport_filter%& option is the command string for starting
22697 the filter, which is run directly from Exim, not under a shell. The string is
22698 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22699 Exim breaks it up into arguments and then expands each argument separately (see
22700 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22701 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22702 of arguments, one for each address that applies to this delivery. (This isn't
22703 an ideal name for this feature here, but as it was already implemented for the
22704 &(pipe)& transport, it seemed sensible not to change it.)
22705
22706 .vindex "&$host$&"
22707 .vindex "&$host_address$&"
22708 The expansion variables &$host$& and &$host_address$& are available when the
22709 transport is a remote one. They contain the name and IP address of the host to
22710 which the message is being sent. For example:
22711 . used to have $sender_address in this cmdline, but it's tainted
22712 .code
22713 transport_filter = /some/directory/transport-filter.pl \
22714   $host $host_address $pipe_addresses
22715 .endd
22716
22717 Two problems arise if you want to use more complicated expansion items to
22718 generate transport filter commands, both of which due to the fact that the
22719 command is split up &'before'& expansion.
22720 .ilist
22721 If an expansion item contains white space, you must quote it, so that it is all
22722 part of the same command item. If the entire option setting is one such
22723 expansion item, you have to take care what kind of quoting you use. For
22724 example:
22725 .code
22726 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22727 .endd
22728 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22729 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22730 stripped by Exim when it read the option's value. When the value is used, if
22731 the single quotes were missing, the line would be split into two items,
22732 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22733 Exim tried to expand the first one.
22734 .next
22735 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22736 expansion cannot generate multiple arguments, or a command name followed by
22737 arguments. Consider this example:
22738 .code
22739 transport_filter = ${lookup{$host}lsearch{/a/file}\
22740                     {$value}{/bin/cat}}
22741 .endd
22742 The result of the lookup is interpreted as the name of the command, even
22743 if it contains white space. The simplest way round this is to use a shell:
22744 .code
22745 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22746                                {$value}{/bin/cat}}
22747 .endd
22748 .endlist
22749
22750 The filter process is run under the same uid and gid as the normal delivery.
22751 For remote deliveries this is the Exim uid/gid by default. The command should
22752 normally yield a zero return code. Transport filters are not supposed to fail.
22753 A non-zero code is taken to mean that the transport filter encountered some
22754 serious problem. Delivery of the message is deferred; the message remains on
22755 the queue and is tried again later. It is not possible to cause a message to be
22756 bounced from a transport filter.
22757
22758 If a transport filter is set on an autoreply transport, the original message is
22759 passed through the filter as it is being copied into the newly generated
22760 message, which happens if the &%return_message%& option is set.
22761
22762
22763 .option transport_filter_timeout transports time 5m
22764 .cindex "transport" "filter, timeout"
22765 When Exim is reading the output of a transport filter, it applies a timeout
22766 that can be set by this option. Exceeding the timeout is normally treated as a
22767 temporary delivery failure. However, if a transport filter is used with a
22768 &(pipe)& transport, a timeout in the transport filter is treated in the same
22769 way as a timeout in the pipe command itself. By default, a timeout is a hard
22770 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22771 becomes a temporary error.
22772
22773
22774 .option user transports string&!! "Exim user"
22775 .cindex "uid (user id)" "local delivery"
22776 .cindex "transport" "user, specifying"
22777 This option specifies the user under whose uid the delivery process is to be
22778 run, overriding any uid that may have been set by the router. If the user is
22779 given as a name, the uid is looked up from the password data, and the
22780 associated group is taken as the value of the gid to be used if the &%group%&
22781 option is not set.
22782
22783 For deliveries that use local transports, a user and group are normally
22784 specified explicitly or implicitly (for example, as a result of
22785 &%check_local_user%&) by the router or transport.
22786
22787 .cindex "hints database" "access by remote transport"
22788 For remote transports, you should leave this option unset unless you really are
22789 sure you know what you are doing. When a remote transport is running, it needs
22790 to be able to access Exim's hints databases, because each host may have its own
22791 retry data.
22792 .ecindex IIDgenoptra1
22793 .ecindex IIDgenoptra2
22794 .ecindex IIDgenoptra3
22795
22796
22797
22798
22799
22800
22801 . ////////////////////////////////////////////////////////////////////////////
22802 . ////////////////////////////////////////////////////////////////////////////
22803
22804 .chapter "Address batching in local transports" "CHAPbatching" &&&
22805          "Address batching"
22806 .cindex "transport" "local; address batching in"
22807 The only remote transport (&(smtp)&) is normally configured to handle more than
22808 one address at a time, so that when several addresses are routed to the same
22809 remote host, just one copy of the message is sent. Local transports, however,
22810 normally handle one address at a time. That is, a separate instance of the
22811 transport is run for each address that is routed to the transport. A separate
22812 copy of the message is delivered each time.
22813
22814 .cindex "batched local delivery"
22815 .oindex "&%batch_max%&"
22816 .oindex "&%batch_id%&"
22817 In special cases, it may be desirable to handle several addresses at once in a
22818 local transport, for example:
22819
22820 .ilist
22821 In an &(appendfile)& transport, when storing messages in files for later
22822 delivery by some other means, a single copy of the message with multiple
22823 recipients saves space.
22824 .next
22825 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22826 a single copy saves time, and is the normal way LMTP is expected to work.
22827 .next
22828 In a &(pipe)& transport, when passing the message
22829 to a scanner program or
22830 to some other delivery mechanism such as UUCP, multiple recipients may be
22831 acceptable.
22832 .endlist
22833
22834 These three local transports all have the same options for controlling multiple
22835 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22836 repeating the information for each transport, these options are described here.
22837
22838 The &%batch_max%& option specifies the maximum number of addresses that can be
22839 delivered together in a single run of the transport. Its default value is one
22840 (no batching). When more than one address is routed to a transport that has a
22841 &%batch_max%& value greater than one, the addresses are delivered in a batch
22842 (that is, in a single run of the transport with multiple recipients), subject
22843 to certain conditions:
22844
22845 .ilist
22846 .vindex "&$local_part$&"
22847 If any of the transport's options contain a reference to &$local_part$&, no
22848 batching is possible.
22849 .next
22850 .vindex "&$domain$&"
22851 If any of the transport's options contain a reference to &$domain$&, only
22852 addresses with the same domain are batched.
22853 .next
22854 .cindex "customizing" "batching condition"
22855 If &%batch_id%& is set, it is expanded for each address, and only those
22856 addresses with the same expanded value are batched. This allows you to specify
22857 customized batching conditions. Failure of the expansion for any reason,
22858 including forced failure, disables batching, but it does not stop the delivery
22859 from taking place.
22860 .next
22861 Batched addresses must also have the same errors address (where to send
22862 delivery errors), the same header additions and removals, the same user and
22863 group for the transport, and if a host list is present, the first host must
22864 be the same.
22865 .endlist
22866
22867 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22868 both when the file or pipe command is specified in the transport, and when it
22869 is specified by a &(redirect)& router, but all the batched addresses must of
22870 course be routed to the same file or pipe command. These two transports have an
22871 option called &%use_bsmtp%&, which causes them to deliver the message in
22872 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22873 &%check_string%& and &%escape_string%& options are forced to the values
22874 .code
22875 check_string = "."
22876 escape_string = ".."
22877 .endd
22878 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22879 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22880 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22881
22882 .cindex "&'Envelope-to:'& header line"
22883 If the generic &%envelope_to_add%& option is set for a batching transport, the
22884 &'Envelope-to:'& header that is added to the message contains all the addresses
22885 that are being processed together. If you are using a batching &(appendfile)&
22886 transport without &%use_bsmtp%&, the only way to preserve the recipient
22887 addresses is to set the &%envelope_to_add%& option.
22888
22889 .cindex "&(pipe)& transport" "with multiple addresses"
22890 .vindex "&$pipe_addresses$&"
22891 If you are using a &(pipe)& transport without BSMTP, and setting the
22892 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22893 the command. This is not a true variable; it is a bit of magic that causes each
22894 of the recipient addresses to be inserted into the command as a separate
22895 argument. This provides a way of accessing all the addresses that are being
22896 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22897 are specified by a &(redirect)& router.
22898
22899
22900
22901
22902 . ////////////////////////////////////////////////////////////////////////////
22903 . ////////////////////////////////////////////////////////////////////////////
22904
22905 .chapter "The appendfile transport" "CHAPappendfile"
22906 .scindex IIDapptra1 "&(appendfile)& transport"
22907 .scindex IIDapptra2 "transports" "&(appendfile)&"
22908 .cindex "directory creation"
22909 .cindex "creating directories"
22910 The &(appendfile)& transport delivers a message by appending it to an existing
22911 file, or by creating an entirely new file in a specified directory. Single
22912 files to which messages are appended can be in the traditional Unix mailbox
22913 format, or optionally in the MBX format supported by the Pine MUA and
22914 University of Washington IMAP daemon, &'inter alia'&. When each message is
22915 being delivered as a separate file, &"maildir"& format can optionally be used
22916 to give added protection against failures that happen part-way through the
22917 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22918 supported. For all file formats, Exim attempts to create as many levels of
22919 directory as necessary, provided that &%create_directory%& is set.
22920
22921 The code for the optional formats is not included in the Exim binary by
22922 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22923 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22924 included.
22925
22926 .cindex "quota" "system"
22927 Exim recognizes system quota errors, and generates an appropriate message. Exim
22928 also supports its own quota control within the transport, for use when the
22929 system facility is unavailable or cannot be used for some reason.
22930
22931 If there is an error while appending to a file (for example, quota exceeded or
22932 partition filled), Exim attempts to reset the file's length and last
22933 modification time back to what they were before. If there is an error while
22934 creating an entirely new file, the new file is removed.
22935
22936 Before appending to a file, a number of security checks are made, and the
22937 file is locked. A detailed description is given below, after the list of
22938 private options.
22939
22940 The &(appendfile)& transport is most commonly used for local deliveries to
22941 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22942 putting messages into files for remote delivery by some means other than Exim.
22943 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22944 option).
22945
22946
22947
22948 .section "The file and directory options" "SECTfildiropt"
22949 The &%file%& option specifies a single file, to which the message is appended;
22950 the &%directory%& option specifies a directory, in which a new file containing
22951 the message is created. Only one of these two options can be set, and for
22952 normal deliveries to mailboxes, one of them &'must'& be set.
22953
22954 .vindex "&$address_file$&"
22955 .vindex "&$local_part$&"
22956 However, &(appendfile)& is also used for delivering messages to files or
22957 directories whose names (or parts of names) are obtained from alias,
22958 forwarding, or filtering operations (for example, a &%save%& command in a
22959 user's Exim filter). When such a transport is running, &$local_part$& contains
22960 the local part that was aliased or forwarded, and &$address_file$& contains the
22961 name (or partial name) of the file or directory generated by the redirection
22962 operation. There are two cases:
22963
22964 .ilist
22965 If neither &%file%& nor &%directory%& is set, the redirection operation
22966 must specify an absolute path (one that begins with &`/`&). This is the most
22967 common case when users with local accounts use filtering to sort mail into
22968 different folders. See for example, the &(address_file)& transport in the
22969 default configuration. If the path ends with a slash, it is assumed to be the
22970 name of a directory. A delivery to a directory can also be forced by setting
22971 &%maildir_format%& or &%mailstore_format%&.
22972 .next
22973 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22974 used to determine the file or directory name for the delivery. Normally, the
22975 contents of &$address_file$& are used in some way in the string expansion.
22976 .endlist
22977 If the &%create_file%& option is set to a path which
22978 matches (see the option definition below for details)
22979 a file or directory name
22980 for the delivery, that name becomes de-tainted.
22981
22982 .cindex "tainted data" "in filenames"
22983 .cindex appendfile "tainted data"
22984 Tainted data may not be used for a file or directory name.
22985 This means that, for instance, &$local_part$& cannot be used directly
22986 as a component of a path.  It can however be used as the key for a lookup
22987 which returns a path (or component).
22988
22989
22990 .cindex "Sieve filter" "configuring &(appendfile)&"
22991 .cindex "Sieve filter" "relative mailbox path handling"
22992 As an example of the second case, consider an environment where users do not
22993 have home directories. They may be permitted to use Exim filter commands of the
22994 form:
22995 .code
22996 save folder23
22997 .endd
22998 or Sieve filter commands of the form:
22999 .code
23000 require "fileinto";
23001 fileinto "folder23";
23002 .endd
23003 In this situation, the expansion of &%file%& or &%directory%& in the transport
23004 must transform the relative path into an appropriate absolute filename. In the
23005 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
23006 is used as a result of a &"keep"& action in the filter. This example shows one
23007 way of handling this requirement:
23008 .code
23009 file = ${if eq{$address_file}{inbox} \
23010             {/var/mail/$local_part_data} \
23011             {${if eq{${substr_0_1:$address_file}}{/} \
23012                   {$address_file} \
23013                   {$home/mail/$address_file} \
23014             }} \
23015        }
23016 .endd
23017 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
23018 location, absolute paths are used without change, and other folders are in the
23019 &_mail_& directory within the home directory.
23020
23021 &*Note 1*&: While processing an Exim filter, a relative path such as
23022 &_folder23_& is turned into an absolute path if a home directory is known to
23023 the router. In particular, this is the case if &%check_local_user%& is set. If
23024 you want to prevent this happening at routing time, you can set
23025 &%router_home_directory%& empty. This forces the router to pass the relative
23026 path to the transport.
23027
23028 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23029 the &%file%& or &%directory%& option is still used if it is set.
23030
23031
23032
23033
23034 .section "Private options for appendfile" "SECID134"
23035 .cindex "options" "&(appendfile)& transport"
23036
23037
23038
23039 .option allow_fifo appendfile boolean false
23040 .cindex "fifo (named pipe)"
23041 .cindex "named pipe (fifo)"
23042 .cindex "pipe" "named (fifo)"
23043 Setting this option permits delivery to named pipes (FIFOs) as well as to
23044 regular files. If no process is reading the named pipe at delivery time, the
23045 delivery is deferred.
23046
23047
23048 .option allow_symlink appendfile boolean false
23049 .cindex "symbolic link" "to mailbox"
23050 .cindex "mailbox" "symbolic link"
23051 By default, &(appendfile)& will not deliver if the path name for the file is
23052 that of a symbolic link. Setting this option relaxes that constraint, but there
23053 are security issues involved in the use of symbolic links. Be sure you know
23054 what you are doing if you set this. Details of exactly what this option affects
23055 are included in the discussion which follows this list of options.
23056
23057
23058 .option batch_id appendfile string&!! unset
23059 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23060 However, batching is automatically disabled for &(appendfile)& deliveries that
23061 happen as a result of forwarding or aliasing or other redirection directly to a
23062 file.
23063
23064
23065 .option batch_max appendfile integer 1
23066 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23067
23068
23069 .option check_group appendfile boolean false
23070 When this option is set, the group owner of the file defined by the &%file%&
23071 option is checked to see that it is the same as the group under which the
23072 delivery process is running. The default setting is false because the default
23073 file mode is 0600, which means that the group is irrelevant.
23074
23075
23076 .option check_owner appendfile boolean true
23077 When this option is set, the owner of the file defined by the &%file%& option
23078 is checked to ensure that it is the same as the user under which the delivery
23079 process is running.
23080
23081
23082 .option check_string appendfile string "see below"
23083 .cindex "&""From""& line"
23084 As &(appendfile)& writes the message, the start of each line is tested for
23085 matching &%check_string%&, and if it does, the initial matching characters are
23086 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23087 a literal string, not a regular expression, and the case of any letters it
23088 contains is significant.
23089
23090 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23091 are forced to &"."& and &".."& respectively, and any settings in the
23092 configuration are ignored. Otherwise, they default to &"From&~"& and
23093 &">From&~"& when the &%file%& option is set, and unset when any of the
23094 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23095
23096 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23097 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23098 &"From&~"& indicates the start of a new message. All four options need changing
23099 if another format is used. For example, to deliver to mailboxes in MMDF format:
23100 .cindex "MMDF format mailbox"
23101 .cindex "mailbox" "MMDF format"
23102 .code
23103 check_string = "\1\1\1\1\n"
23104 escape_string = "\1\1\1\1 \n"
23105 message_prefix = "\1\1\1\1\n"
23106 message_suffix = "\1\1\1\1\n"
23107 .endd
23108 .option create_directory appendfile boolean true
23109 .cindex "directory creation"
23110 When this option is true, Exim attempts to create any missing superior
23111 directories for the file that it is about to write. A created directory's mode
23112 is given by the &%directory_mode%& option.
23113
23114 The group ownership of a newly created directory is highly dependent on the
23115 operating system (and possibly the file system) that is being used. For
23116 example, in Solaris, if the parent directory has the setgid bit set, its group
23117 is propagated to the child; if not, the currently set group is used. However,
23118 in FreeBSD, the parent's group is always used.
23119
23120
23121
23122 .option create_file appendfile string anywhere
23123 This option constrains the location of files and directories that are created
23124 by this transport. It applies to files defined by the &%file%& option and
23125 directories defined by the &%directory%& option. In the case of maildir
23126 delivery, it applies to the top level directory, not the maildir directories
23127 beneath.
23128
23129 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23130 &"belowhome"&, or to an absolute path.
23131
23132 In the second and third cases, a home directory must have been
23133 set for the transport, and the file or directory being created must
23134 reside within it.
23135 The "belowhome" checking additionally checks for attempts to use "../"
23136 to evade the testing.
23137 This option is not useful when an explicit filename is
23138 given for normal mailbox deliveries. It is intended for the case when filenames
23139 are generated from users' &_.forward_& files. These are usually handled
23140 by an &(appendfile)& transport called &%address_file%&. See also
23141 &%file_must_exist%&.
23142
23143 In the fourth case,
23144 the value given for this option must be an absolute path for an
23145 existing directory.
23146 The value is used for checking instead of a home directory;
23147 checking is done in "belowhome" mode.
23148
23149 .cindex "tainted data" "de-tainting"
23150 .cindex "de-tainting" "using appendfile create_file option"
23151 If "belowhome" checking is used, the file or directory path
23152 becomes de-tainted.
23153
23154
23155 .option directory appendfile string&!! unset
23156 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23157 or &%directory%& must be set, unless the delivery is the direct result of a
23158 redirection (see section &<<SECTfildiropt>>&).
23159
23160 When &%directory%& is set, the string is expanded, and the message is delivered
23161 into a new file or files in or below the given directory, instead of being
23162 appended to a single mailbox file. A number of different formats are provided
23163 (see &%maildir_format%& and &%mailstore_format%&), and see section
23164 &<<SECTopdir>>& for further details of this form of delivery.
23165
23166 The result of expansion must not be tainted, unless the &%create_file%& option
23167 specifies a path.
23168
23169
23170 .option directory_file appendfile string&!! "see below"
23171 .cindex "base62"
23172 .vindex "&$inode$&"
23173 When &%directory%& is set, but neither &%maildir_format%& nor
23174 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23175 whose name is obtained by expanding this string. The default value is:
23176 .code
23177 q${base62:$tod_epoch}-$inode
23178 .endd
23179 This generates a unique name from the current time, in base 62 form, and the
23180 inode of the file. The variable &$inode$& is available only when expanding this
23181 option.
23182
23183
23184 .option directory_mode appendfile "octal integer" 0700
23185 If &(appendfile)& creates any directories as a result of the
23186 &%create_directory%& option, their mode is specified by this option.
23187
23188
23189 .option escape_string appendfile string "see description"
23190 See &%check_string%& above.
23191
23192
23193 .option file appendfile string&!! unset
23194 This option is mutually exclusive with the &%directory%& option, but one of
23195 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23196 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23197 specifies a single file, to which the message is appended. One or more of
23198 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23199 &%file%&.
23200
23201 The result of expansion must not be tainted, unless the &%create_file%& option
23202 specifies a path.
23203
23204 .cindex "NFS" "lock file"
23205 .cindex "locking files"
23206 .cindex "lock files"
23207 If you are using more than one host to deliver over NFS into the same
23208 mailboxes, you should always use lock files.
23209
23210 The string value is expanded for each delivery, and must yield an absolute
23211 path. The most common settings of this option are variations on one of these
23212 examples:
23213 .code
23214 file = /var/spool/mail/$local_part_data
23215 file = /home/$local_part_data/inbox
23216 file = $home/inbox
23217 .endd
23218 .cindex "&""sticky""& bit"
23219 In the first example, all deliveries are done into the same directory. If Exim
23220 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23221 create a file in the directory, so the &"sticky"& bit must be turned on for
23222 deliveries to be possible, or alternatively the &%group%& option can be used to
23223 run the delivery under a group id which has write access to the directory.
23224
23225
23226
23227 .option file_format appendfile string unset
23228 .cindex "file" "mailbox; checking existing format"
23229 This option requests the transport to check the format of an existing file
23230 before adding to it. The check consists of matching a specific string at the
23231 start of the file. The value of the option consists of an even number of
23232 colon-separated strings. The first of each pair is the test string, and the
23233 second is the name of a transport. If the transport associated with a matched
23234 string is not the current transport, control is passed over to the other
23235 transport. For example, suppose the standard &(local_delivery)& transport has
23236 this added to it:
23237 .code
23238 file_format = "From       : local_delivery :\
23239                \1\1\1\1\n : local_mmdf_delivery"
23240 .endd
23241 Mailboxes that begin with &"From"& are still handled by this transport, but if
23242 a mailbox begins with four binary ones followed by a newline, control is passed
23243 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23244 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23245 is assumed to match the current transport. If the start of a mailbox doesn't
23246 match any string, or if the transport named for a given string is not defined,
23247 delivery is deferred.
23248
23249
23250 .option file_must_exist appendfile boolean false
23251 If this option is true, the file specified by the &%file%& option must exist.
23252 A temporary error occurs if it does not, causing delivery to be deferred.
23253 If this option is false, the file is created if it does not exist.
23254
23255
23256 .option lock_fcntl_timeout appendfile time 0s
23257 .cindex "timeout" "mailbox locking"
23258 .cindex "mailbox" "locking, blocking and non-blocking"
23259 .cindex "locking files"
23260 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23261 when locking an open mailbox file. If the call fails, the delivery process
23262 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23263 Non-blocking calls are used so that the file is not kept open during the wait
23264 for the lock; the reason for this is to make it as safe as possible for
23265 deliveries over NFS in the case when processes might be accessing an NFS
23266 mailbox without using a lock file. This should not be done, but
23267 misunderstandings and hence misconfigurations are not unknown.
23268
23269 On a busy system, however, the performance of a non-blocking lock approach is
23270 not as good as using a blocking lock with a timeout. In this case, the waiting
23271 is done inside the system call, and Exim's delivery process acquires the lock
23272 and can proceed as soon as the previous lock holder releases it.
23273
23274 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23275 timeout, are used. There may still be some retrying: the maximum number of
23276 retries is
23277 .code
23278 (lock_retries * lock_interval) / lock_fcntl_timeout
23279 .endd
23280 rounded up to the next whole number. In other words, the total time during
23281 which &(appendfile)& is trying to get a lock is roughly the same, unless
23282 &%lock_fcntl_timeout%& is set very large.
23283
23284 You should consider setting this option if you are getting a lot of delayed
23285 local deliveries because of errors of the form
23286 .code
23287 failed to lock mailbox /some/file (fcntl)
23288 .endd
23289
23290 .option lock_flock_timeout appendfile time 0s
23291 This timeout applies to file locking when using &[flock()]& (see
23292 &%use_flock%&); the timeout operates in a similar manner to
23293 &%lock_fcntl_timeout%&.
23294
23295
23296 .option lock_interval appendfile time 3s
23297 This specifies the time to wait between attempts to lock the file. See below
23298 for details of locking.
23299
23300
23301 .option lock_retries appendfile integer 10
23302 This specifies the maximum number of attempts to lock the file. A value of zero
23303 is treated as 1. See below for details of locking.
23304
23305
23306 .option lockfile_mode appendfile "octal integer" 0600
23307 This specifies the mode of the created lock file, when a lock file is being
23308 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23309
23310
23311 .option lockfile_timeout appendfile time 30m
23312 .cindex "timeout" "mailbox locking"
23313 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23314 exists and is older than this value, it is assumed to have been left behind by
23315 accident, and Exim attempts to remove it.
23316
23317
23318 .option mailbox_filecount appendfile string&!! unset
23319 .cindex "mailbox" "specifying size of"
23320 .cindex "size" "of mailbox"
23321 If this option is set, it is expanded, and the result is taken as the current
23322 number of files in the mailbox. It must be a decimal number, optionally
23323 followed by K or M. This provides a way of obtaining this information from an
23324 external source that maintains the data.
23325
23326
23327 .option mailbox_size appendfile string&!! unset
23328 .cindex "mailbox" "specifying size of"
23329 .cindex "size" "of mailbox"
23330 If this option is set, it is expanded, and the result is taken as the current
23331 size the mailbox. It must be a decimal number, optionally followed by K or M.
23332 This provides a way of obtaining this information from an external source that
23333 maintains the data. This is likely to be helpful for maildir deliveries where
23334 it is computationally expensive to compute the size of a mailbox.
23335
23336
23337
23338 .option maildir_format appendfile boolean false
23339 .cindex "maildir format" "specifying"
23340 If this option is set with the &%directory%& option, the delivery is into a new
23341 file, in the &"maildir"& format that is used by other mail software. When the
23342 transport is activated directly from a &(redirect)& router (for example, the
23343 &(address_file)& transport in the default configuration), setting
23344 &%maildir_format%& causes the path received from the router to be treated as a
23345 directory, whether or not it ends with &`/`&. This option is available only if
23346 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23347 &<<SECTmaildirdelivery>>& below for further details.
23348
23349
23350 .option maildir_quota_directory_regex appendfile string "See below"
23351 .cindex "maildir format" "quota; directories included in"
23352 .cindex "quota" "maildir; directories included in"
23353 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23354 a regular expression for specifying directories, relative to the quota
23355 directory (see &%quota_directory%&), that should be included in the quota
23356 calculation. The default value is:
23357 .code
23358 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23359 .endd
23360 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23361 (directories whose names begin with a dot). If you want to exclude the
23362 &_Trash_&
23363 folder from the count (as some sites do), you need to change this setting to
23364 .code
23365 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23366 .endd
23367 This uses a negative lookahead in the regular expression to exclude the
23368 directory whose name is &_.Trash_&. When a directory is excluded from quota
23369 calculations, quota processing is bypassed for any messages that are delivered
23370 directly into that directory.
23371
23372
23373 .option maildir_retries appendfile integer 10
23374 This option specifies the number of times to retry when writing a file in
23375 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23376
23377
23378 .option maildir_tag appendfile string&!! unset
23379 This option applies only to deliveries in maildir format, and is described in
23380 section &<<SECTmaildirdelivery>>& below.
23381
23382
23383 .option maildir_use_size_file appendfile&!! boolean false
23384 .cindex "maildir format" "&_maildirsize_& file"
23385 The result of string expansion for this option must be a valid boolean value.
23386 If it is true, it enables support for &_maildirsize_& files. Exim
23387 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23388 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23389 value is zero. See &%maildir_quota_directory_regex%& above and section
23390 &<<SECTmaildirdelivery>>& below for further details.
23391
23392 .option maildirfolder_create_regex appendfile string unset
23393 .cindex "maildir format" "&_maildirfolder_& file"
23394 .cindex "&_maildirfolder_&, creating"
23395 The value of this option is a regular expression. If it is unset, it has no
23396 effect. Otherwise, before a maildir delivery takes place, the pattern is
23397 matched against the name of the maildir directory, that is, the directory
23398 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23399 delivery. If there is a match, Exim checks for the existence of a file called
23400 &_maildirfolder_& in the directory, and creates it if it does not exist.
23401 See section &<<SECTmaildirdelivery>>& for more details.
23402
23403
23404 .option mailstore_format appendfile boolean false
23405 .cindex "mailstore format" "specifying"
23406 If this option is set with the &%directory%& option, the delivery is into two
23407 new files in  &"mailstore"& format. The option is available only if
23408 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23409 below for further details.
23410
23411
23412 .option mailstore_prefix appendfile string&!! unset
23413 This option applies only to deliveries in mailstore format, and is described in
23414 section &<<SECTopdir>>& below.
23415
23416
23417 .option mailstore_suffix appendfile string&!! unset
23418 This option applies only to deliveries in mailstore format, and is described in
23419 section &<<SECTopdir>>& below.
23420
23421
23422 .option mbx_format appendfile boolean false
23423 .cindex "locking files"
23424 .cindex "file" "locking"
23425 .cindex "file" "MBX format"
23426 .cindex "MBX format, specifying"
23427 This option is available only if Exim has been compiled with SUPPORT_MBX
23428 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23429 the message is appended to the mailbox file in MBX format instead of
23430 traditional Unix format. This format is supported by Pine4 and its associated
23431 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23432
23433 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23434 automatically changed by the use of &%mbx_format%&. They should normally be set
23435 empty when using MBX format, so this option almost always appears in this
23436 combination:
23437 .code
23438 mbx_format = true
23439 message_prefix =
23440 message_suffix =
23441 .endd
23442 If none of the locking options are mentioned in the configuration,
23443 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23444 is possible to specify the other kinds of locking with &%mbx_format%&, but
23445 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23446 interworks with &'c-client'&, providing for shared access to the mailbox. It
23447 should not be used if any program that does not use this form of locking is
23448 going to access the mailbox, nor should it be used if the mailbox file is NFS
23449 mounted, because it works only when the mailbox is accessed from a single host.
23450
23451 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23452 the standard version of &'c-client'&, because as long as it has a mailbox open
23453 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23454 append messages to it.
23455
23456
23457 .option message_prefix appendfile string&!! "see below"
23458 .cindex "&""From""& line"
23459 The string specified here is expanded and output at the start of every message.
23460 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23461 in which case it is:
23462 .code
23463 message_prefix = "From ${if def:return_path{$return_path}\
23464   {MAILER-DAEMON}} $tod_bsdinbox\n"
23465 .endd
23466 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23467 &`\n`& to &`\r\n`& in &%message_prefix%&.
23468
23469 .option message_suffix appendfile string&!! "see below"
23470 The string specified here is expanded and output at the end of every message.
23471 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23472 in which case it is a single newline character. The suffix can be suppressed by
23473 setting
23474 .code
23475 message_suffix =
23476 .endd
23477 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23478 &`\n`& to &`\r\n`& in &%message_suffix%&.
23479
23480 .option mode appendfile "octal integer" 0600
23481 If the output file is created, it is given this mode. If it already exists and
23482 has wider permissions, they are reduced to this mode. If it has narrower
23483 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23484 if the delivery is the result of a &%save%& command in a filter file specifying
23485 a particular mode, the mode of the output file is always forced to take that
23486 value, and this option is ignored.
23487
23488
23489 .option mode_fail_narrower appendfile boolean true
23490 This option applies in the case when an existing mailbox file has a narrower
23491 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23492 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23493 continues with the delivery attempt, using the existing mode of the file.
23494
23495
23496 .option notify_comsat appendfile boolean false
23497 If this option is true, the &'comsat'& daemon is notified after every
23498 successful delivery to a user mailbox. This is the daemon that notifies logged
23499 on users about incoming mail.
23500
23501
23502 .option quota appendfile string&!! unset
23503 .cindex "quota" "imposed by Exim"
23504 This option imposes a limit on the size of the file to which Exim is appending,
23505 or to the total space used in the directory tree when the &%directory%& option
23506 is set. In the latter case, computation of the space used is expensive, because
23507 all the files in the directory (and any sub-directories) have to be
23508 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23509 &%maildir_use_size_file%& for ways to avoid this in environments where users
23510 have no shell access to their mailboxes).
23511
23512 As there is no interlock against two simultaneous deliveries into a
23513 multi-file mailbox, it is possible for the quota to be overrun in this case.
23514 For single-file mailboxes, of course, an interlock is a necessity.
23515
23516 A file's size is taken as its &'used'& value. Because of blocking effects, this
23517 may be a lot less than the actual amount of disk space allocated to the file.
23518 If the sizes of a number of files are being added up, the rounding effect can
23519 become quite noticeable, especially on systems that have large block sizes.
23520 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23521 the obvious value which users understand most easily.
23522
23523 The value of the option is expanded, and must then be a numerical value
23524 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23525 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23526 and further option modifiers. If Exim is running on a system with
23527 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23528 be handled.
23529
23530 The option modifier &%no_check%& can be used to force delivery even if the over
23531 quota condition is met. The quota gets updated as usual.
23532
23533 &*Note*&: A value of zero is interpreted as &"no quota"&.
23534
23535 The expansion happens while Exim is running as root, before it changes uid for
23536 the delivery. This means that files that are inaccessible to the end user can
23537 be used to hold quota values that are looked up in the expansion. When delivery
23538 fails because this quota is exceeded, the handling of the error is as for
23539 system quota failures.
23540
23541 By default, Exim's quota checking mimics system quotas, and restricts the
23542 mailbox to the specified maximum size, though the value is not accurate to the
23543 last byte, owing to separator lines and additional headers that may get added
23544 during message delivery. When a mailbox is nearly full, large messages may get
23545 refused even though small ones are accepted, because the size of the current
23546 message is added to the quota when the check is made. This behaviour can be
23547 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23548 for exceeding the quota does not include the current message. Thus, deliveries
23549 continue until the quota has been exceeded; thereafter, no further messages are
23550 delivered. See also &%quota_warn_threshold%&.
23551
23552
23553 .option quota_directory appendfile string&!! unset
23554 This option defines the directory to check for quota purposes when delivering
23555 into individual files. The default is the delivery directory, or, if a file
23556 called &_maildirfolder_& exists in a maildir directory, the parent of the
23557 delivery directory.
23558
23559
23560 .option quota_filecount appendfile string&!! 0
23561 This option applies when the &%directory%& option is set. It limits the total
23562 number of files in the directory (compare the inode limit in system quotas). It
23563 can only be used if &%quota%& is also set. The value is expanded; an expansion
23564 failure causes delivery to be deferred. A value of zero is interpreted as
23565 &"no quota"&.
23566
23567 The option modifier &%no_check%& can be used to force delivery even if the over
23568 quota condition is met. The quota gets updated as usual.
23569
23570 .option quota_is_inclusive appendfile boolean true
23571 See &%quota%& above.
23572
23573
23574 .option quota_size_regex appendfile string unset
23575 This option applies when one of the delivery modes that writes a separate file
23576 for each message is being used. When Exim wants to find the size of one of
23577 these files in order to test the quota, it first checks &%quota_size_regex%&.
23578 If this is set to a regular expression that matches the filename, and it
23579 captures one string, that string is interpreted as a representation of the
23580 file's size. The value of &%quota_size_regex%& is not expanded.
23581
23582 This feature is useful only when users have no shell access to their mailboxes
23583 &-- otherwise they could defeat the quota simply by renaming the files. This
23584 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23585 the file length to the filename. For example:
23586 .code
23587 maildir_tag = ,S=$message_size
23588 quota_size_regex = ,S=(\d+)
23589 .endd
23590 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23591 number of lines in the message.
23592
23593 The regular expression should not assume that the length is at the end of the
23594 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23595 sometimes add other information onto the ends of message filenames.
23596
23597 Section &<<SECID136>>& contains further information.
23598
23599 This option should not be used when other message-handling software
23600 may duplicate messages by making hardlinks to the files.  When that is done Exim
23601 will count the message size once for each filename, in contrast with the actual
23602 disk usage.  When the option is not set, calculating total usage requires
23603 a system-call per file to get the size; the number of links is then available also
23604 as is used to adjust the effective size.
23605
23606
23607 .option quota_warn_message appendfile string&!! "see below"
23608 See below for the use of this option. If it is not set when
23609 &%quota_warn_threshold%& is set, it defaults to
23610 .code
23611 quota_warn_message = "\
23612   To: $local_part@$domain\n\
23613   Subject: Your mailbox\n\n\
23614   This message is automatically created \
23615   by mail delivery software.\n\n\
23616   The size of your mailbox has exceeded \
23617   a warning threshold that is\n\
23618   set by the system administrator.\n"
23619 .endd
23620
23621
23622 .option quota_warn_threshold appendfile string&!! 0
23623 .cindex "quota" "warning threshold"
23624 .cindex "mailbox" "size warning"
23625 .cindex "size" "of mailbox"
23626 This option is expanded in the same way as &%quota%& (see above). If the
23627 resulting value is greater than zero, and delivery of the message causes the
23628 size of the file or total space in the directory tree to cross the given
23629 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23630 may be specified as a percentage of it by following the value with a percent
23631 sign. For example:
23632 .code
23633 quota = 10M
23634 quota_warn_threshold = 75%
23635 .endd
23636 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23637 percent sign is ignored.
23638
23639 The warning message itself is specified by the &%quota_warn_message%& option,
23640 and it must start with a &'To:'& header line containing the recipient(s) of the
23641 warning message. These do not necessarily have to include the recipient(s) of
23642 the original message. A &'Subject:'& line should also normally be supplied. You
23643 can include any other header lines that you want. If you do not include a
23644 &'From:'& line, the default is:
23645 .code
23646 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23647 .endd
23648 .oindex &%errors_reply_to%&
23649 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23650 option.
23651
23652 The &%quota%& option does not have to be set in order to use this option; they
23653 are independent of one another except when the threshold is specified as a
23654 percentage.
23655
23656
23657 .option use_bsmtp appendfile boolean false
23658 .cindex "envelope from"
23659 .cindex "envelope sender"
23660 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23661 format, with the envelope sender and recipient(s) included as SMTP commands. If
23662 you want to include a leading HELO command with such messages, you can do
23663 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23664 for details of batch SMTP.
23665
23666
23667 .option use_crlf appendfile boolean false
23668 .cindex "carriage return"
23669 .cindex "linefeed"
23670 This option causes lines to be terminated with the two-character CRLF sequence
23671 (carriage return, linefeed) instead of just a linefeed character. In the case
23672 of batched SMTP, the byte sequence written to the file is then an exact image
23673 of what would be sent down a real SMTP connection.
23674
23675 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23676 (which are used to supply the traditional &"From&~"& and blank line separators
23677 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23678 carriage return characters if these are needed. In cases where these options
23679 have non-empty defaults, the values end with a single linefeed, so they must be
23680 changed to end with &`\r\n`& if &%use_crlf%& is set.
23681
23682
23683 .option use_fcntl_lock appendfile boolean "see below"
23684 This option controls the use of the &[fcntl()]& function to lock a file for
23685 exclusive use when a message is being appended. It is set by default unless
23686 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23687 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23688 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23689
23690
23691 .option use_flock_lock appendfile boolean false
23692 This option is provided to support the use of &[flock()]& for file locking, for
23693 the few situations where it is needed. Most modern operating systems support
23694 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23695 each other. Exim uses &[fcntl()]& locking by default.
23696
23697 This option is required only if you are using an operating system where
23698 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23699 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23700 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23701
23702 .cindex "Solaris" "&[flock()]& support"
23703 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23704 have it (and some, I think, provide a not quite right version built on top of
23705 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23706 the ability to use it, and any attempt to do so will cause a configuration
23707 error.
23708
23709 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23710 is just being mapped onto &[fcntl()]& by the OS).
23711
23712
23713 .option use_lockfile appendfile boolean "see below"
23714 If this option is turned off, Exim does not attempt to create a lock file when
23715 appending to a mailbox file. In this situation, the only locking is by
23716 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23717 sure that every MUA that is ever going to look at your users' mailboxes uses
23718 &[fcntl()]& rather than a lock file, and even then only when you are not
23719 delivering over NFS from more than one host.
23720
23721 .cindex "NFS" "lock file"
23722 In order to append to an NFS file safely from more than one host, it is
23723 necessary to take out a lock &'before'& opening the file, and the lock file
23724 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23725 file corruption.
23726
23727 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23728 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23729 except when &%mbx_format%& is set.
23730
23731
23732 .option use_mbx_lock appendfile boolean "see below"
23733 This option is available only if Exim has been compiled with SUPPORT_MBX
23734 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23735 locking rules be used. It is set by default if &%mbx_format%& is set and none
23736 of the locking options are mentioned in the configuration. The locking rules
23737 are the same as are used by the &'c-client'& library that underlies Pine and
23738 the IMAP4 and POP daemons that come with it (see the discussion below). The
23739 rules allow for shared access to the mailbox. However, this kind of locking
23740 does not work when the mailbox is NFS mounted.
23741
23742 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23743 &%use_flock_lock%& to control what kind of locking is used in implementing the
23744 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23745 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23746
23747
23748
23749
23750 .section "Operational details for appending" "SECTopappend"
23751 .cindex "appending to a file"
23752 .cindex "file" "appending"
23753 Before appending to a file, the following preparations are made:
23754
23755 .ilist
23756 If the name of the file is &_/dev/null_&, no action is taken, and a success
23757 return is given.
23758
23759 .next
23760 .cindex "directory creation"
23761 If any directories on the file's path are missing, Exim creates them if the
23762 &%create_directory%& option is set. A created directory's mode is given by the
23763 &%directory_mode%& option.
23764
23765 .next
23766 If &%file_format%& is set, the format of an existing file is checked. If this
23767 indicates that a different transport should be used, control is passed to that
23768 transport.
23769
23770 .next
23771 .cindex "file" "locking"
23772 .cindex "locking files"
23773 .cindex "NFS" "lock file"
23774 If &%use_lockfile%& is set, a lock file is built in a way that will work
23775 reliably over NFS, as follows:
23776
23777 .olist
23778 Create a &"hitching post"& file whose name is that of the lock file with the
23779 current time, primary host name, and process id added, by opening for writing
23780 as a new file. If this fails with an access error, delivery is deferred.
23781 .next
23782 Close the hitching post file, and hard link it to the lock filename.
23783 .next
23784 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23785 Unlink the hitching post name.
23786 .next
23787 Otherwise, use &[stat()]& to get information about the hitching post file, and
23788 then unlink hitching post name. If the number of links is exactly two, creation
23789 of the lock file succeeded but something (for example, an NFS server crash and
23790 restart) caused this fact not to be communicated to the &[link()]& call.
23791 .next
23792 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23793 up to &%lock_retries%& times. However, since any program that writes to a
23794 mailbox should complete its task very quickly, it is reasonable to time out old
23795 lock files that are normally the result of user agent and system crashes. If an
23796 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23797 it before trying again.
23798 .endlist olist
23799
23800 .next
23801 A call is made to &[lstat()]& to discover whether the main file exists, and if
23802 so, what its characteristics are. If &[lstat()]& fails for any reason other
23803 than non-existence, delivery is deferred.
23804
23805 .next
23806 .cindex "symbolic link" "to mailbox"
23807 .cindex "mailbox" "symbolic link"
23808 If the file does exist and is a symbolic link, delivery is deferred, unless the
23809 &%allow_symlink%& option is set, in which case the ownership of the link is
23810 checked, and then &[stat()]& is called to find out about the real file, which
23811 is then subjected to the checks below. The check on the top-level link
23812 ownership prevents one user creating a link for another's mailbox in a sticky
23813 directory, though allowing symbolic links in this case is definitely not a good
23814 idea. If there is a chain of symbolic links, the intermediate ones are not
23815 checked.
23816
23817 .next
23818 If the file already exists but is not a regular file, or if the file's owner
23819 and group (if the group is being checked &-- see &%check_group%& above) are
23820 different from the user and group under which the delivery is running,
23821 delivery is deferred.
23822
23823 .next
23824 If the file's permissions are more generous than specified, they are reduced.
23825 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23826 is set false, in which case the delivery is tried using the existing
23827 permissions.
23828
23829 .next
23830 The file's inode number is saved, and the file is then opened for appending.
23831 If this fails because the file has vanished, &(appendfile)& behaves as if it
23832 hadn't existed (see below). For any other failures, delivery is deferred.
23833
23834 .next
23835 If the file is opened successfully, check that the inode number hasn't
23836 changed, that it is still a regular file, and that the owner and permissions
23837 have not changed. If anything is wrong, defer delivery and freeze the message.
23838
23839 .next
23840 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23841 option is set. Otherwise, check that the file is being created in a permitted
23842 directory if the &%create_file%& option is set (deferring on failure), and then
23843 open for writing as a new file, with the O_EXCL and O_CREAT options,
23844 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23845 set). In this case, which can happen if the link points to a non-existent file,
23846 the file is opened for writing using O_CREAT but not O_EXCL, because
23847 that prevents link following.
23848
23849 .next
23850 .cindex "loop" "while file testing"
23851 If opening fails because the file exists, obey the tests given above for
23852 existing files. However, to avoid looping in a situation where the file is
23853 being continuously created and destroyed, the exists/not-exists loop is broken
23854 after 10 repetitions, and the message is then frozen.
23855
23856 .next
23857 If opening fails with any other error, defer delivery.
23858
23859 .next
23860 .cindex "file" "locking"
23861 .cindex "locking files"
23862 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23863 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23864 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23865 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23866 file, and an exclusive lock on the file whose name is
23867 .code
23868 /tmp/.<device-number>.<inode-number>
23869 .endd
23870 using the device and inode numbers of the open mailbox file, in accordance with
23871 the MBX locking rules. This file is created with a mode that is specified by
23872 the &%lockfile_mode%& option.
23873
23874 If Exim fails to lock the file, there are two possible courses of action,
23875 depending on the value of the locking timeout. This is obtained from
23876 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23877
23878 If the timeout value is zero, the file is closed, Exim waits for
23879 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23880 to lock it again. This happens up to &%lock_retries%& times, after which the
23881 delivery is deferred.
23882
23883 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23884 &[flock()]& are used (with the given timeout), so there has already been some
23885 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23886 immediately. It retries up to
23887 .code
23888 (lock_retries * lock_interval) / <timeout>
23889 .endd
23890 times (rounded up).
23891 .endlist
23892
23893 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23894 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23895
23896
23897 .section "Operational details for delivery to a new file" "SECTopdir"
23898 .cindex "delivery" "to single file"
23899 .cindex "&""From""& line"
23900 When the &%directory%& option is set instead of &%file%&, each message is
23901 delivered into a newly-created file or set of files. When &(appendfile)& is
23902 activated directly from a &(redirect)& router, neither &%file%& nor
23903 &%directory%& is normally set, because the path for delivery is supplied by the
23904 router. (See for example, the &(address_file)& transport in the default
23905 configuration.) In this case, delivery is to a new file if either the path name
23906 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23907
23908 No locking is required while writing the message to a new file, so the various
23909 locking options of the transport are ignored. The &"From"& line that by default
23910 separates messages in a single file is not normally needed, nor is the escaping
23911 of message lines that start with &"From"&, and there is no need to ensure a
23912 newline at the end of each message. Consequently, the default values for
23913 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23914 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23915
23916 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23917 the files in the delivery directory by default. However, you can specify a
23918 different directory by setting &%quota_directory%&. Also, for maildir
23919 deliveries (see below) the &_maildirfolder_& convention is honoured.
23920
23921
23922 .cindex "maildir format"
23923 .cindex "mailstore format"
23924 There are three different ways in which delivery to individual files can be
23925 done, controlled by the settings of the &%maildir_format%& and
23926 &%mailstore_format%& options. Note that code to support maildir or mailstore
23927 formats is not included in the binary unless SUPPORT_MAILDIR or
23928 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23929
23930 .cindex "directory creation"
23931 In all three cases an attempt is made to create the directory and any necessary
23932 sub-directories if they do not exist, provided that the &%create_directory%&
23933 option is set (the default). The location of a created directory can be
23934 constrained by setting &%create_file%&. A created directory's mode is given by
23935 the &%directory_mode%& option. If creation fails, or if the
23936 &%create_directory%& option is not set when creation is required, delivery is
23937 deferred.
23938
23939
23940
23941 .section "Maildir delivery" "SECTmaildirdelivery"
23942 .cindex "maildir format" "description of"
23943 If the &%maildir_format%& option is true, Exim delivers each message by writing
23944 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23945 directory that is defined by the &%directory%& option (the &"delivery
23946 directory"&). If the delivery is successful, the file is renamed into the
23947 &_new_& subdirectory.
23948
23949 In the filename, <&'stime'&> is the current time of day in seconds, and
23950 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23951 Exim checks that the time-of-day clock has moved on by at least one microsecond
23952 before terminating the delivery process. This guarantees uniqueness for the
23953 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23954 opening it. If any response other than ENOENT (does not exist) is given,
23955 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23956
23957 Before Exim carries out a maildir delivery, it ensures that subdirectories
23958 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23959 do not exist, Exim tries to create them and any superior directories in their
23960 path, subject to the &%create_directory%& and &%create_file%& options. If the
23961 &%maildirfolder_create_regex%& option is set, and the regular expression it
23962 contains matches the delivery directory, Exim also ensures that a file called
23963 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23964 &_maildirfolder_& file cannot be created, delivery is deferred.
23965
23966 These features make it possible to use Exim to create all the necessary files
23967 and directories in a maildir mailbox, including subdirectories for maildir++
23968 folders. Consider this example:
23969 .code
23970 maildir_format = true
23971 directory = /var/mail/$local_part_data\
23972            ${if eq{$local_part_suffix}{}{}\
23973            {/.${substr_1:$local_part_suffix}}}
23974 maildirfolder_create_regex = /\.[^/]+$
23975 .endd
23976 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23977 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23978 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23979 not match this name, so Exim will not look for or create the file
23980 &_/var/mail/pimbo/maildirfolder_&, though it will create
23981 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23982
23983 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23984 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23985 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23986 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23987 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23988
23989 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23990 not inadvertently match the toplevel maildir directory, because a
23991 &_maildirfolder_& file at top level would completely break quota calculations.
23992
23993 .cindex "quota" "in maildir delivery"
23994 .cindex "maildir++"
23995 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23996 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23997 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23998 Exim assumes the directory is a maildir++ folder directory, which is one level
23999 down from the user's top level mailbox directory. This causes it to start at
24000 the parent directory instead of the current directory when calculating the
24001 amount of space used.
24002
24003 One problem with delivering into a multi-file mailbox is that it is
24004 computationally expensive to compute the size of the mailbox for quota
24005 checking. Various approaches have been taken to reduce the amount of work
24006 needed. The next two sections describe two of them. A third alternative is to
24007 use some external process for maintaining the size data, and use the expansion
24008 of the &%mailbox_size%& option as a way of importing it into Exim.
24009
24010
24011
24012
24013 .section "Using tags to record message sizes" "SECID135"
24014 If &%maildir_tag%& is set, the string is expanded for each delivery.
24015 When the maildir file is renamed into the &_new_& sub-directory, the
24016 tag is added to its name. However, if adding the tag takes the length of the
24017 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
24018 the tag is dropped and the maildir file is created with no tag.
24019
24020
24021 .vindex "&$message_size$&"
24022 Tags can be used to encode the size of files in their names; see
24023 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
24024 happens after the message has been written. The value of the &$message_size$&
24025 variable is set to the number of bytes actually written. If the expansion is
24026 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
24027 be deferred. The expanded tag may contain any printing characters except &"/"&.
24028 Non-printing characters in the string are ignored; if the resulting string is
24029 empty, it is ignored. If it starts with an alphanumeric character, a leading
24030 colon is inserted; this default has not proven to be the path that popular
24031 maildir implementations have chosen (but changing it in Exim would break
24032 backwards compatibility).
24033
24034 For one common implementation, you might set:
24035 .code
24036 maildir_tag = ,S=${message_size}
24037 .endd
24038 but you should check the documentation of the other software to be sure.
24039
24040 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
24041 as this allows Exim to extract the size from your tag, instead of having to
24042 &[stat()]& each message file.
24043
24044
24045 .section "Using a maildirsize file" "SECID136"
24046 .cindex "quota" "in maildir delivery"
24047 .cindex "maildir format" "&_maildirsize_& file"
24048 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24049 storing quota and message size information in a file called &_maildirsize_&
24050 within the toplevel maildir directory. If this file does not exist, Exim
24051 creates it, setting the quota from the &%quota%& option of the transport. If
24052 the maildir directory itself does not exist, it is created before any attempt
24053 to write a &_maildirsize_& file.
24054
24055 The &_maildirsize_& file is used to hold information about the sizes of
24056 messages in the maildir, thus speeding up quota calculations. The quota value
24057 in the file is just a cache; if the quota is changed in the transport, the new
24058 value overrides the cached value when the next message is delivered. The cache
24059 is maintained for the benefit of other programs that access the maildir and
24060 need to know the quota.
24061
24062 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24063 file is maintained (with a zero quota setting), but no quota is imposed.
24064
24065 A regular expression is available for controlling which directories in the
24066 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24067 See the description of the &%maildir_quota_directory_regex%& option above for
24068 details.
24069
24070
24071 .section "Mailstore delivery" "SECID137"
24072 .cindex "mailstore format" "description of"
24073 If the &%mailstore_format%& option is true, each message is written as two
24074 files in the given directory. A unique base name is constructed from the
24075 message id and the current delivery process, and the files that are written use
24076 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24077 contains the message's envelope, and the &_.msg_& file contains the message
24078 itself. The base name is placed in the variable &$mailstore_basename$&.
24079
24080 During delivery, the envelope is first written to a file with the suffix
24081 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24082 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24083 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24084 file before accessing either of them. An alternative approach is to wait for
24085 the absence of a &_.tmp_& file.
24086
24087 The envelope file starts with any text defined by the &%mailstore_prefix%&
24088 option, expanded and terminated by a newline if there isn't one. Then follows
24089 the sender address on one line, then all the recipient addresses, one per line.
24090 There can be more than one recipient only if the &%batch_max%& option is set
24091 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24092 appended to the file, followed by a newline if it does not end with one.
24093
24094 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24095 failure, it is ignored. Other expansion errors are treated as serious
24096 configuration errors, and delivery is deferred. The variable
24097 &$mailstore_basename$& is available for use during these expansions.
24098
24099
24100 .section "Non-special new file delivery" "SECID138"
24101 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24102 file is created directly in the named directory. For example, when delivering
24103 messages into files in batched SMTP format for later delivery to some host (see
24104 section &<<SECTbatchSMTP>>&), a setting such as
24105 .code
24106 directory = /var/bsmtp/$host
24107 .endd
24108 might be used. A message is written to a file with a temporary name, which is
24109 then renamed when the delivery is complete. The final name is obtained by
24110 expanding the contents of the &%directory_file%& option.
24111 .ecindex IIDapptra1
24112 .ecindex IIDapptra2
24113
24114
24115
24116
24117
24118
24119 . ////////////////////////////////////////////////////////////////////////////
24120 . ////////////////////////////////////////////////////////////////////////////
24121
24122 .chapter "The autoreply transport" "CHID8"
24123 .scindex IIDauttra1 "transports" "&(autoreply)&"
24124 .scindex IIDauttra2 "&(autoreply)& transport"
24125 The &(autoreply)& transport is not a true transport in that it does not cause
24126 the message to be transmitted. Instead, it generates a new mail message as an
24127 automatic reply to the incoming message. &'References:'& and
24128 &'Auto-Submitted:'& header lines are included. These are constructed according
24129 to the rules in RFCs 2822 and 3834, respectively.
24130
24131 If the router that passes the message to this transport does not have the
24132 &%unseen%& option set, the original message (for the current recipient) is not
24133 delivered anywhere. However, when the &%unseen%& option is set on the router
24134 that passes the message to this transport, routing of the address continues, so
24135 another router can set up a normal message delivery.
24136
24137
24138 The &(autoreply)& transport is usually run as the result of mail filtering, a
24139 &"vacation"& message being the standard example. However, it can also be run
24140 directly from a router like any other transport. To reduce the possibility of
24141 message cascades, messages created by the &(autoreply)& transport always have
24142 empty envelope sender addresses, like bounce messages.
24143
24144 The parameters of the message to be sent can be specified in the configuration
24145 by options described below. However, these are used only when the address
24146 passed to the transport does not contain its own reply information. When the
24147 transport is run as a consequence of a
24148 &%mail%&
24149 or &%vacation%& command in a filter file, the parameters of the message are
24150 supplied by the filter, and passed with the address. The transport's options
24151 that define the message are then ignored (so they are not usually set in this
24152 case). The message is specified entirely by the filter or by the transport; it
24153 is never built from a mixture of options. However, the &%file_optional%&,
24154 &%mode%&, and &%return_message%& options apply in all cases.
24155
24156 &(Autoreply)& is implemented as a local transport. When used as a result of a
24157 command in a user's filter file, &(autoreply)& normally runs under the uid and
24158 gid of the user, and with appropriate current and home directories (see chapter
24159 &<<CHAPenvironment>>&).
24160
24161 There is a subtle difference between routing a message to a &(pipe)& transport
24162 that generates some text to be returned to the sender, and routing it to an
24163 &(autoreply)& transport. This difference is noticeable only if more than one
24164 address from the same message is so handled. In the case of a pipe, the
24165 separate outputs from the different addresses are gathered up and returned to
24166 the sender in a single message, whereas if &(autoreply)& is used, a separate
24167 message is generated for each address that is passed to it.
24168
24169 Non-printing characters are not permitted in the header lines generated for the
24170 message that &(autoreply)& creates, with the exception of newlines that are
24171 immediately followed by white space. If any non-printing characters are found,
24172 the transport defers.
24173 Whether characters with the top bit set count as printing characters or not is
24174 controlled by the &%print_topbitchars%& global option.
24175
24176 If any of the generic options for manipulating headers (for example,
24177 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24178 of the original message that is included in the generated message when
24179 &%return_message%& is set. They do not apply to the generated message itself.
24180
24181 .vindex "&$sender_address$&"
24182 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24183 the message, indicating that there were no recipients, it does not treat this
24184 as an error. This means that autoreplies sent to &$sender_address$& when this
24185 is empty (because the incoming message is a bounce message) do not cause
24186 problems. They are just discarded.
24187
24188
24189
24190 .section "Private options for autoreply" "SECID139"
24191 .cindex "options" "&(autoreply)& transport"
24192
24193 .option bcc autoreply string&!! unset
24194 This specifies the addresses that are to receive &"blind carbon copies"& of the
24195 message when the message is specified by the transport.
24196
24197
24198 .option cc autoreply string&!! unset
24199 This specifies recipients of the message and the contents of the &'Cc:'& header
24200 when the message is specified by the transport.
24201
24202
24203 .option file autoreply string&!! unset
24204 The contents of the file are sent as the body of the message when the message
24205 is specified by the transport. If both &%file%& and &%text%& are set, the text
24206 string comes first.
24207
24208
24209 .option file_expand autoreply boolean false
24210 If this is set, the contents of the file named by the &%file%& option are
24211 subjected to string expansion as they are added to the message.
24212
24213
24214 .option file_optional autoreply boolean false
24215 If this option is true, no error is generated if the file named by the &%file%&
24216 option or passed with the address does not exist or cannot be read.
24217
24218
24219 .option from autoreply string&!! unset
24220 This specifies the contents of the &'From:'& header when the message is
24221 specified by the transport.
24222
24223
24224 .option headers autoreply string&!! unset
24225 This specifies additional RFC 2822 headers that are to be added to the message
24226 when the message is specified by the transport. Several can be given by using
24227 &"\n"& to separate them. There is no check on the format.
24228
24229
24230 .option log autoreply string&!! unset
24231 This option names a file in which a record of every message sent is logged when
24232 the message is specified by the transport.
24233
24234
24235 .option mode autoreply "octal integer" 0600
24236 If either the log file or the &"once"& file has to be created, this mode is
24237 used.
24238
24239
24240 .option never_mail autoreply "address list&!!" unset
24241 If any run of the transport creates a message with a recipient that matches any
24242 item in the list, that recipient is quietly discarded. If all recipients are
24243 discarded, no message is created. This applies both when the recipients are
24244 generated by a filter and when they are specified in the transport.
24245
24246
24247
24248 .option once autoreply string&!! unset
24249 This option names a file or DBM database in which a record of each &'To:'&
24250 recipient is kept when the message is specified by the transport. &*Note*&:
24251 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24252
24253 If &%once%& is unset, or is set to an empty string, the message is always sent.
24254 By default, if &%once%& is set to a non-empty filename, the message
24255 is not sent if a potential recipient is already listed in the database.
24256 However, if the &%once_repeat%& option specifies a time greater than zero, the
24257 message is sent if that much time has elapsed since a message was last sent to
24258 this recipient. A setting of zero time for &%once_repeat%& (the default)
24259 prevents a message from being sent a second time &-- in this case, zero means
24260 infinity.
24261
24262 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24263 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24264 greater than zero, it changes the way Exim implements the &%once%& option.
24265 Instead of using a DBM file to record every recipient it sends to, it uses a
24266 regular file, whose size will never get larger than the given value.
24267
24268 In the file, Exim keeps a linear list of recipient addresses and the times at
24269 which they were sent messages. If the file is full when a new address needs to
24270 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24271 means that a given recipient may receive multiple messages, but at
24272 unpredictable intervals that depend on the rate of turnover of addresses in the
24273 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24274
24275
24276 .option once_file_size autoreply integer 0
24277 See &%once%& above.
24278
24279
24280 .option once_repeat autoreply time&!! 0s
24281 See &%once%& above.
24282 After expansion, the value of this option must be a valid time value.
24283
24284
24285 .option reply_to autoreply string&!! unset
24286 This specifies the contents of the &'Reply-To:'& header when the message is
24287 specified by the transport.
24288
24289
24290 .option return_message autoreply boolean false
24291 If this is set, a copy of the original message is returned with the new
24292 message, subject to the maximum size set in the &%return_size_limit%& global
24293 configuration option.
24294
24295
24296 .option subject autoreply string&!! unset
24297 This specifies the contents of the &'Subject:'& header when the message is
24298 specified by the transport. It is tempting to quote the original subject in
24299 automatic responses. For example:
24300 .code
24301 subject = Re: $h_subject:
24302 .endd
24303 There is a danger in doing this, however. It may allow a third party to
24304 subscribe your users to an opt-in mailing list, provided that the list accepts
24305 bounce messages as subscription confirmations. Well-managed lists require a
24306 non-bounce message to confirm a subscription, so the danger is relatively
24307 small.
24308
24309
24310
24311 .option text autoreply string&!! unset
24312 This specifies a single string to be used as the body of the message when the
24313 message is specified by the transport. If both &%text%& and &%file%& are set,
24314 the text comes first.
24315
24316
24317 .option to autoreply string&!! unset
24318 This specifies recipients of the message and the contents of the &'To:'& header
24319 when the message is specified by the transport.
24320 .ecindex IIDauttra1
24321 .ecindex IIDauttra2
24322
24323
24324
24325
24326 . ////////////////////////////////////////////////////////////////////////////
24327 . ////////////////////////////////////////////////////////////////////////////
24328
24329 .chapter "The lmtp transport" "CHAPLMTP"
24330 .cindex "transports" "&(lmtp)&"
24331 .cindex "&(lmtp)& transport"
24332 .cindex "LMTP" "over a pipe"
24333 .cindex "LMTP" "over a socket"
24334 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24335 specified command
24336 or by interacting with a Unix domain socket.
24337 This transport is something of a cross between the &(pipe)& and &(smtp)&
24338 transports. Exim also has support for using LMTP over TCP/IP; this is
24339 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24340 to be of minority interest, the default build-time configure in &_src/EDITME_&
24341 has it commented out. You need to ensure that
24342 .code
24343 TRANSPORT_LMTP=yes
24344 .endd
24345 .cindex "options" "&(lmtp)& transport"
24346 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24347 included in the Exim binary. The private options of the &(lmtp)& transport are
24348 as follows:
24349
24350 .option batch_id lmtp string&!! unset
24351 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24352
24353
24354 .option batch_max lmtp integer 1
24355 This limits the number of addresses that can be handled in a single delivery.
24356 Most LMTP servers can handle several addresses at once, so it is normally a
24357 good idea to increase this value. See the description of local delivery
24358 batching in chapter &<<CHAPbatching>>&.
24359
24360
24361 .option command lmtp string&!! unset
24362 This option must be set if &%socket%& is not set. The string is a command which
24363 is run in a separate process. It is split up into a command name and list of
24364 arguments, each of which is separately expanded (so expansion cannot change the
24365 number of arguments). The command is run directly, not via a shell. The message
24366 is passed to the new process using the standard input and output to operate the
24367 LMTP protocol.
24368
24369 .option ignore_quota lmtp boolean false
24370 .cindex "LMTP" "ignoring quota errors"
24371 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24372 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24373 in its response to the LHLO command.
24374
24375 .option socket lmtp string&!! unset
24376 This option must be set if &%command%& is not set. The result of expansion must
24377 be the name of a Unix domain socket. The transport connects to the socket and
24378 delivers the message to it using the LMTP protocol.
24379
24380
24381 .option timeout lmtp time 5m
24382 The transport is aborted if the created process or Unix domain socket does not
24383 respond to LMTP commands or message input within this timeout. Delivery
24384 is deferred, and will be tried again later. Here is an example of a typical
24385 LMTP transport:
24386 .code
24387 lmtp:
24388   driver = lmtp
24389   command = /some/local/lmtp/delivery/program
24390   batch_max = 20
24391   user = exim
24392 .endd
24393 This delivers up to 20 addresses at a time, in a mixture of domains if
24394 necessary, running as the user &'exim'&.
24395
24396
24397
24398 . ////////////////////////////////////////////////////////////////////////////
24399 . ////////////////////////////////////////////////////////////////////////////
24400
24401 .chapter "The pipe transport" "CHAPpipetransport"
24402 .scindex IIDpiptra1 "transports" "&(pipe)&"
24403 .scindex IIDpiptra2 "&(pipe)& transport"
24404 The &(pipe)& transport is used to deliver messages via a pipe to a command
24405 running in another process. One example is the use of &(pipe)& as a
24406 pseudo-remote transport for passing messages to some other delivery mechanism
24407 (such as UUCP). Another is the use by individual users to automatically process
24408 their incoming messages. The &(pipe)& transport can be used in one of the
24409 following ways:
24410
24411 .ilist
24412 .vindex "&$local_part$&"
24413 A router routes one address to a transport in the normal way, and the
24414 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24415 contains the local part of the address (as usual), and the command that is run
24416 is specified by the &%command%& option on the transport.
24417 .next
24418 .vindex "&$pipe_addresses$&"
24419 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24420 transport can handle more than one address in a single run. In this case, when
24421 more than one address is routed to the transport, &$local_part$& is not set
24422 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24423 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24424 that are routed to the transport.
24425 .next
24426 .vindex "&$address_pipe$&"
24427 A router redirects an address directly to a pipe command (for example, from an
24428 alias or forward file). In this case, &$address_pipe$& contains the text of the
24429 pipe command, and the &%command%& option on the transport is ignored unless
24430 &%force_command%& is set. If only one address is being transported
24431 (&%batch_max%& is not greater than one, or only one address was redirected to
24432 this pipe command), &$local_part$& contains the local part that was redirected.
24433 .endlist
24434
24435
24436 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24437 deliver messages over pipes using the LMTP interactive protocol. This is
24438 implemented by the &(lmtp)& transport.
24439
24440 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24441 &_.forward_& file, the command runs under the uid and gid of that user. In
24442 other cases, the uid and gid have to be specified explicitly, either on the
24443 transport or on the router that handles the address. Current and &"home"&
24444 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24445 details of the local delivery environment and chapter &<<CHAPbatching>>&
24446 for a discussion of local delivery batching.
24447
24448 .cindex "tainted data" "in pipe command"
24449 .cindex pipe "tainted data"
24450 Tainted data may not be used for the command name.
24451
24452
24453 .section "Concurrent delivery" "SECID140"
24454 If two messages arrive at almost the same time, and both are routed to a pipe
24455 delivery, the two pipe transports may be run concurrently. You must ensure that
24456 any pipe commands you set up are robust against this happening. If the commands
24457 write to a file, the &%exim_lock%& utility might be of use.
24458 Alternatively the &%max_parallel%& option could be used with a value
24459 of "1" to enforce serialization.
24460
24461
24462
24463
24464 .section "Returned status and data" "SECID141"
24465 .cindex "&(pipe)& transport" "returned data"
24466 If the command exits with a non-zero return code, the delivery is deemed to
24467 have failed, unless either the &%ignore_status%& option is set (in which case
24468 the return code is treated as zero), or the return code is one of those listed
24469 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24470 later"&. In this case, delivery is deferred. Details of a permanent failure are
24471 logged, but are not included in the bounce message, which merely contains
24472 &"local delivery failed"&.
24473
24474 If the command exits on a signal and the &%freeze_signal%& option is set then
24475 the message will be frozen in the queue. If that option is not set, a bounce
24476 will be sent as normal.
24477
24478 If the return code is greater than 128 and the command being run is a shell
24479 script, it normally means that the script was terminated by a signal whose
24480 value is the return code minus 128. The &%freeze_signal%& option does not
24481 apply in this case.
24482
24483 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24484 return code is set to 127. This is the value that a shell returns if it is
24485 asked to run a non-existent command. The wording for the log line suggests that
24486 a non-existent command may be the problem.
24487
24488 The &%return_output%& option can affect the result of a pipe delivery. If it is
24489 set and the command produces any output on its standard output or standard
24490 error streams, the command is considered to have failed, even if it gave a zero
24491 return code or if &%ignore_status%& is set. The output from the command is
24492 included as part of the bounce message. The &%return_fail_output%& option is
24493 similar, except that output is returned only when the command exits with a
24494 failure return code, that is, a value other than zero or a code that matches
24495 &%temp_errors%&.
24496
24497
24498
24499 .section "How the command is run" "SECThowcommandrun"
24500 .cindex "&(pipe)& transport" "path for command"
24501 The command line is (by default) broken down into a command name and arguments
24502 by the &(pipe)& transport itself. The &%allow_commands%& and
24503 &%restrict_to_path%& options can be used to restrict the commands that may be
24504 run.
24505
24506 .cindex "quoting" "in pipe command"
24507 Unquoted arguments are delimited by white space. If an argument appears in
24508 double quotes, backslash is interpreted as an escape character in the usual
24509 way. If an argument appears in single quotes, no escaping is done.
24510
24511 String expansion is applied to the command line except when it comes from a
24512 traditional &_.forward_& file (commands from a filter file are expanded). The
24513 expansion is applied to each argument in turn rather than to the whole line.
24514 For this reason, any string expansion item that contains white space must be
24515 quoted so as to be contained within a single argument. A setting such as
24516 .code
24517 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24518 .endd
24519 will not work, because the expansion item gets split between several
24520 arguments. You have to write
24521 .code
24522 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24523 .endd
24524 to ensure that it is all in one argument. The expansion is done in this way,
24525 argument by argument, so that the number of arguments cannot be changed as a
24526 result of expansion, and quotes or backslashes in inserted variables do not
24527 interact with external quoting. However, this leads to problems if you want to
24528 generate multiple arguments (or the command name plus arguments) from a single
24529 expansion. In this situation, the simplest solution is to use a shell. For
24530 example:
24531 .code
24532 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24533 .endd
24534
24535 .cindex "transport" "filter"
24536 .cindex "filter" "transport filter"
24537 .vindex "&$pipe_addresses$&"
24538 Special handling takes place when an argument consists of precisely the text
24539 &`$pipe_addresses`& (no quotes).
24540 This is not a general expansion variable; the only
24541 place this string is recognized is when it appears as an argument for a pipe or
24542 transport filter command. It causes each address that is being handled to be
24543 inserted in the argument list at that point &'as a separate argument'&. This
24544 avoids any problems with spaces or shell metacharacters, and is of use when a
24545 &(pipe)& transport is handling groups of addresses in a batch.
24546
24547 If &%force_command%& is enabled on the transport, special handling takes place
24548 for an argument that consists of precisely the text &`$address_pipe`&.  It
24549 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24550 argument is inserted in the argument list at that point
24551 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24552 the only item in the argument; in fact, if it were then &%force_command%&
24553 should behave as a no-op.  Rather, it should be used to adjust the command
24554 run while preserving the argument vector separation.
24555
24556 After splitting up into arguments and expansion, the resulting command is run
24557 in a subprocess directly from the transport, &'not'& under a shell. The
24558 message that is being delivered is supplied on the standard input, and the
24559 standard output and standard error are both connected to a single pipe that is
24560 read by Exim. The &%max_output%& option controls how much output the command
24561 may produce, and the &%return_output%& and &%return_fail_output%& options
24562 control what is done with it.
24563
24564 Not running the command under a shell (by default) lessens the security risks
24565 in cases when a command from a user's filter file is built out of data that was
24566 taken from an incoming message. If a shell is required, it can of course be
24567 explicitly specified as the command to be run. However, there are circumstances
24568 where existing commands (for example, in &_.forward_& files) expect to be run
24569 under a shell and cannot easily be modified. To allow for these cases, there is
24570 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24571 works. Instead of breaking up the command line as just described, it expands it
24572 as a single string and passes the result to &_/bin/sh_&. The
24573 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24574 with &%use_shell%&, and the whole mechanism is inherently less secure.
24575
24576
24577
24578 .section "Environment variables" "SECTpipeenv"
24579 .cindex "&(pipe)& transport" "environment for command"
24580 .cindex "environment" "&(pipe)& transport"
24581 The environment variables listed below are set up when the command is invoked.
24582 This list is a compromise for maximum compatibility with other MTAs. Note that
24583 the &%environment%& option can be used to add additional variables to this
24584 environment. The environment for the &(pipe)& transport is not subject
24585 to the &%add_environment%& and &%keep_environment%& main config options.
24586 &*Note*&: Using enviroment variables loses track of tainted data.
24587 Writers of &(pipe)& transport commands should be wary of data supplied
24588 by potential attackers.
24589 .display
24590 &`DOMAIN            `&   the domain of the address
24591 &`HOME              `&   the home directory, if set
24592 &`HOST              `&   the host name when called from a router (see below)
24593 &`LOCAL_PART        `&   see below
24594 &`LOCAL_PART_PREFIX `&   see below
24595 &`LOCAL_PART_SUFFIX `&   see below
24596 &`LOGNAME           `&   see below
24597 &`MESSAGE_ID        `&   Exim's local ID for the message
24598 &`PATH              `&   as specified by the &%path%& option below
24599 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24600 &`RECIPIENT         `&   the complete recipient address
24601 &`SENDER            `&   the sender of the message (empty if a bounce)
24602 &`SHELL             `&   &`/bin/sh`&
24603 &`TZ                `&   the value of the &%timezone%& option, if set
24604 &`USER              `&   see below
24605 .endd
24606 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24607 router, LOCAL_PART is set to the local part of the address. When it is
24608 called as a result of a forward or alias expansion, LOCAL_PART is set to
24609 the local part of the address that was expanded. In both cases, any affixes are
24610 removed from the local part, and made available in LOCAL_PART_PREFIX and
24611 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24612 same value as LOCAL_PART for compatibility with other MTAs.
24613
24614 .cindex "HOST"
24615 HOST is set only when a &(pipe)& transport is called from a router that
24616 associates hosts with an address, typically when using &(pipe)& as a
24617 pseudo-remote transport. HOST is set to the first host name specified by
24618 the router.
24619
24620 .cindex "HOME"
24621 If the transport's generic &%home_directory%& option is set, its value is used
24622 for the HOME environment variable. Otherwise, a home directory may be set
24623 by the router's &%transport_home_directory%& option, which defaults to the
24624 user's home directory if &%check_local_user%& is set.
24625
24626
24627 .section "Private options for pipe" "SECID142"
24628 .cindex "options" "&(pipe)& transport"
24629
24630
24631
24632 .option allow_commands pipe "string list&!!" unset
24633 .cindex "&(pipe)& transport" "permitted commands"
24634 The string is expanded, and is then interpreted as a colon-separated list of
24635 permitted commands. If &%restrict_to_path%& is not set, the only commands
24636 permitted are those in the &%allow_commands%& list. They need not be absolute
24637 paths; the &%path%& option is still used for relative paths. If
24638 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24639 in the &%allow_commands%& list, or a name without any slashes that is found on
24640 the path. In other words, if neither &%allow_commands%& nor
24641 &%restrict_to_path%& is set, there is no restriction on the command, but
24642 otherwise only commands that are permitted by one or the other are allowed. For
24643 example, if
24644 .code
24645 allow_commands = /usr/bin/vacation
24646 .endd
24647 and &%restrict_to_path%& is not set, the only permitted command is
24648 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24649 &%use_shell%& is set.
24650
24651
24652 .option batch_id pipe string&!! unset
24653 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24654
24655
24656 .option batch_max pipe integer 1
24657 This limits the number of addresses that can be handled in a single delivery.
24658 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24659
24660
24661 .option check_string pipe string unset
24662 As &(pipe)& writes the message, the start of each line is tested for matching
24663 &%check_string%&, and if it does, the initial matching characters are replaced
24664 by the contents of &%escape_string%&, provided both are set. The value of
24665 &%check_string%& is a literal string, not a regular expression, and the case of
24666 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24667 of &%check_string%& and &%escape_string%& are forced to values that implement
24668 the SMTP escaping protocol. Any settings made in the configuration file are
24669 ignored.
24670
24671
24672 .option command pipe string&!! unset
24673 This option need not be set when &(pipe)& is being used to deliver to pipes
24674 obtained directly from address redirections. In other cases, the option must be
24675 set, to provide a command to be run. It need not yield an absolute path (see
24676 the &%path%& option below). The command is split up into separate arguments by
24677 Exim, and each argument is separately expanded, as described in section
24678 &<<SECThowcommandrun>>& above.
24679
24680 .cindex "tainted data"
24681 No part of the resulting command may be tainted.
24682
24683
24684 .option environment pipe string&!! unset
24685 .cindex "&(pipe)& transport" "environment for command"
24686 .cindex "environment" "&(pipe)& transport"
24687 This option is used to add additional variables to the environment in which the
24688 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24689 a string which is expanded, and then interpreted as a colon-separated list of
24690 environment settings of the form <&'name'&>=<&'value'&>.
24691
24692
24693 .option escape_string pipe string unset
24694 See &%check_string%& above.
24695
24696
24697 .option freeze_exec_fail pipe boolean false
24698 .cindex "exec failure"
24699 .cindex "failure of exec"
24700 .cindex "&(pipe)& transport" "failure of exec"
24701 Failure to exec the command in a pipe transport is by default treated like
24702 any other failure while running the command. However, if &%freeze_exec_fail%&
24703 is set, failure to exec is treated specially, and causes the message to be
24704 frozen, whatever the setting of &%ignore_status%&.
24705
24706
24707 .option freeze_signal pipe boolean false
24708 .cindex "signal exit"
24709 .cindex "&(pipe)& transport", "signal exit"
24710 Normally if the process run by a command in a pipe transport exits on a signal,
24711 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24712 frozen in Exim's queue instead.
24713
24714
24715 .option force_command pipe boolean false
24716 .cindex "force command"
24717 .cindex "&(pipe)& transport", "force command"
24718 Normally when a router redirects an address directly to a pipe command
24719 the &%command%& option on the transport is ignored.  If &%force_command%&
24720 is set, the &%command%& option will used. This is especially
24721 useful for forcing a wrapper or additional argument to be added to the
24722 command. For example:
24723 .code
24724 command = /usr/bin/remote_exec myhost -- $address_pipe
24725 force_command
24726 .endd
24727
24728 Note that &$address_pipe$& is handled specially in &%command%& when
24729 &%force_command%& is set, expanding out to the original argument vector as
24730 separate items, similarly to a Unix shell &`"$@"`& construct.
24731
24732
24733 .option ignore_status pipe boolean false
24734 If this option is true, the status returned by the subprocess that is set up to
24735 run the command is ignored, and Exim behaves as if zero had been returned.
24736 Otherwise, a non-zero status or termination by signal causes an error return
24737 from the transport unless the status value is one of those listed in
24738 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24739
24740 &*Note*&: This option does not apply to timeouts, which do not return a status.
24741 See the &%timeout_defer%& option for how timeouts are handled.
24742
24743
24744 .option log_defer_output pipe boolean false
24745 .cindex "&(pipe)& transport" "logging output"
24746 If this option is set, and the status returned by the command is
24747 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24748 and any output was produced on stdout or stderr, the first line of it is
24749 written to the main log.
24750
24751
24752 .option log_fail_output pipe boolean false
24753 If this option is set, and the command returns any output on stdout or
24754 stderr, and also ends with a return code that is neither zero nor one of
24755 the return codes listed in &%temp_errors%& (that is, the delivery
24756 failed), the first line of output is written to the main log. This
24757 option and &%log_output%& are mutually exclusive.  Only one of them may
24758 be set.
24759
24760
24761 .option log_output pipe boolean false
24762 If this option is set and the command returns any output on stdout or
24763 stderr, the first line of output is written to the main log, whatever
24764 the return code. This option and &%log_fail_output%& are mutually
24765 exclusive. Only one of them may be set.
24766
24767
24768 .option max_output pipe integer 20K
24769 This specifies the maximum amount of output that the command may produce on its
24770 standard output and standard error file combined. If the limit is exceeded, the
24771 process running the command is killed. This is intended as a safety measure to
24772 catch runaway processes. The limit is applied independently of the settings of
24773 the options that control what is done with such output (for example,
24774 &%return_output%&). Because of buffering effects, the amount of output may
24775 exceed the limit by a small amount before Exim notices.
24776
24777
24778 .option message_prefix pipe string&!! "see below"
24779 The string specified here is expanded and output at the start of every message.
24780 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24781 .code
24782 message_prefix = \
24783   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24784   ${tod_bsdinbox}\n
24785 .endd
24786 .cindex "Cyrus"
24787 .cindex "&%tmail%&"
24788 .cindex "&""From""& line"
24789 This is required by the commonly used &_/usr/bin/vacation_& program.
24790 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24791 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24792 setting
24793 .code
24794 message_prefix =
24795 .endd
24796 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24797 &`\n`& to &`\r\n`& in &%message_prefix%&.
24798
24799
24800 .option message_suffix pipe string&!! "see below"
24801 The string specified here is expanded and output at the end of every message.
24802 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24803 The suffix can be suppressed by setting
24804 .code
24805 message_suffix =
24806 .endd
24807 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24808 &`\n`& to &`\r\n`& in &%message_suffix%&.
24809
24810
24811 .option path pipe string&!! "/bin:/usr/bin"
24812 This option is expanded and
24813 specifies the string that is set up in the PATH environment
24814 variable of the subprocess.
24815 If the &%command%& option does not yield an absolute path name, the command is
24816 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24817 apply to a command specified as a transport filter.
24818
24819
24820 .option permit_coredump pipe boolean false
24821 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24822 a core-dump of a pipe command, enable this command.  This enables core-dumps
24823 during delivery and affects both the Exim binary and the pipe command run.
24824 It is recommended that this option remain off unless and until you have a need
24825 for it and that this only be enabled when needed, as the risk of excessive
24826 resource consumption can be quite high.  Note also that Exim is typically
24827 installed as a setuid binary and most operating systems will inhibit coredumps
24828 of these by default, so further OS-specific action may be required.
24829
24830
24831 .option pipe_as_creator pipe boolean false
24832 .cindex "uid (user id)" "local delivery"
24833 If the generic &%user%& option is not set and this option is true, the delivery
24834 process is run under the uid that was in force when Exim was originally called
24835 to accept the message. If the group id is not otherwise set (via the generic
24836 &%group%& option), the gid that was in force when Exim was originally called to
24837 accept the message is used.
24838
24839
24840 .option restrict_to_path pipe boolean false
24841 When this option is set, any command name not listed in &%allow_commands%& must
24842 contain no slashes. The command is searched for only in the directories listed
24843 in the &%path%& option. This option is intended for use in the case when a pipe
24844 command has been generated from a user's &_.forward_& file. This is usually
24845 handled by a &(pipe)& transport called &%address_pipe%&.
24846
24847
24848 .option return_fail_output pipe boolean false
24849 If this option is true, and the command produced any output and ended with a
24850 return code other than zero or one of the codes listed in &%temp_errors%& (that
24851 is, the delivery failed), the output is returned in the bounce message.
24852 However, if the message has a null sender (that is, it is itself a bounce
24853 message), output from the command is discarded. This option and
24854 &%return_output%& are mutually exclusive. Only one of them may be set.
24855
24856
24857
24858 .option return_output pipe boolean false
24859 If this option is true, and the command produced any output, the delivery is
24860 deemed to have failed whatever the return code from the command, and the output
24861 is returned in the bounce message. Otherwise, the output is just discarded.
24862 However, if the message has a null sender (that is, it is a bounce message),
24863 output from the command is always discarded, whatever the setting of this
24864 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24865 of them may be set.
24866
24867
24868
24869 .option temp_errors pipe "string list" "see below"
24870 .cindex "&(pipe)& transport" "temporary failure"
24871 This option contains either a colon-separated list of numbers, or a single
24872 asterisk. If &%ignore_status%& is false
24873 and &%return_output%& is not set,
24874 and the command exits with a non-zero return code, the failure is treated as
24875 temporary and the delivery is deferred if the return code matches one of the
24876 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24877 codes are treated as permanent errors. The default setting contains the codes
24878 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24879 compiled on a system that does not define these macros, it assumes values of 75
24880 and 73, respectively.
24881
24882
24883 .option timeout pipe time 1h
24884 If the command fails to complete within this time, it is killed. This normally
24885 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24886 specifies no timeout. In order to ensure that any subprocesses created by the
24887 command are also killed, Exim makes the initial process a process group leader,
24888 and kills the whole process group on a timeout. However, this can be defeated
24889 if one of the processes starts a new process group.
24890
24891 .option timeout_defer pipe boolean false
24892 A timeout in a &(pipe)& transport, either in the command that the transport
24893 runs, or in a transport filter that is associated with it, is by default
24894 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24895 is set true, both kinds of timeout become temporary errors, causing the
24896 delivery to be deferred.
24897
24898 .option umask pipe "octal integer" 022
24899 This specifies the umask setting for the subprocess that runs the command.
24900
24901
24902 .option use_bsmtp pipe boolean false
24903 .cindex "envelope sender"
24904 If this option is set true, the &(pipe)& transport writes messages in &"batch
24905 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24906 commands. If you want to include a leading HELO command with such messages,
24907 you can do so by setting the &%message_prefix%& option. See section
24908 &<<SECTbatchSMTP>>& for details of batch SMTP.
24909
24910 .option use_classresources pipe boolean false
24911 .cindex "class resources (BSD)"
24912 This option is available only when Exim is running on FreeBSD, NetBSD, or
24913 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24914 resource limits when a &(pipe)& transport is run to perform a delivery. The
24915 limits for the uid under which the pipe is to run are obtained from the login
24916 class database.
24917
24918
24919 .option use_crlf pipe boolean false
24920 .cindex "carriage return"
24921 .cindex "linefeed"
24922 This option causes lines to be terminated with the two-character CRLF sequence
24923 (carriage return, linefeed) instead of just a linefeed character. In the case
24924 of batched SMTP, the byte sequence written to the pipe is then an exact image
24925 of what would be sent down a real SMTP connection.
24926
24927 The contents of the &%message_prefix%& and &%message_suffix%& options are
24928 written verbatim, so must contain their own carriage return characters if these
24929 are needed. When &%use_bsmtp%& is not set, the default values for both
24930 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24931 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24932
24933
24934 .option use_shell pipe boolean false
24935 .vindex "&$pipe_addresses$&"
24936 If this option is set, it causes the command to be passed to &_/bin/sh_&
24937 instead of being run directly from the transport, as described in section
24938 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24939 where the command is expected to be run under a shell and cannot easily be
24940 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24941 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24942 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24943 its &%-c%& option.
24944
24945
24946
24947 .section "Using an external local delivery agent" "SECID143"
24948 .cindex "local delivery" "using an external agent"
24949 .cindex "&'procmail'&"
24950 .cindex "external local delivery"
24951 .cindex "delivery" "&'procmail'&"
24952 .cindex "delivery" "by external agent"
24953 The &(pipe)& transport can be used to pass all messages that require local
24954 delivery to a separate local delivery agent such as &%procmail%&. When doing
24955 this, care must be taken to ensure that the pipe is run under an appropriate
24956 uid and gid. In some configurations one wants this to be a uid that is trusted
24957 by the delivery agent to supply the correct sender of the message. It may be
24958 necessary to recompile or reconfigure the delivery agent so that it trusts an
24959 appropriate user. The following is an example transport and router
24960 configuration for &%procmail%&:
24961 .code
24962 # transport
24963 procmail_pipe:
24964   driver = pipe
24965   command = /usr/local/bin/procmail -d $local_part_data
24966   return_path_add
24967   delivery_date_add
24968   envelope_to_add
24969   check_string = "From "
24970   escape_string = ">From "
24971   umask = 077
24972   user = $local_part_data
24973   group = mail
24974
24975 # router
24976 procmail:
24977   driver = accept
24978   check_local_user
24979   transport = procmail_pipe
24980 .endd
24981 In this example, the pipe is run as the local user, but with the group set to
24982 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24983 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24984 user to supply a correct sender address. If you do not specify either a
24985 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24986 home directory is the user's home directory by default.
24987
24988 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24989 .code
24990 IFS=" "
24991 .endd
24992 as shown in some &%procmail%& documentation, because Exim does not by default
24993 use a shell to run pipe commands.
24994
24995 .cindex "Cyrus"
24996 The next example shows a transport and a router for a system where local
24997 deliveries are handled by the Cyrus IMAP server.
24998 . Used to have R: local_part_suffix = .* +  T:   -m $local_part_suffix_v
24999 . but that suffix is tainted so cannot be used in a command arg
25000 . Really, you'd want to use a lookup for acceptable suffixes to do real detainting
25001 .code
25002 # transport
25003 local_delivery_cyrus:
25004   driver = pipe
25005   command = /usr/cyrus/bin/deliver \
25006             -- $local_part_data
25007   user = cyrus
25008   group = mail
25009   return_output
25010   log_output
25011   message_prefix =
25012   message_suffix =
25013
25014 # router
25015 local_user_cyrus:
25016   driver = accept
25017   check_local_user
25018   transport = local_delivery_cyrus
25019 .endd
25020 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
25021 &%return_output%& to cause any text written by Cyrus to be returned to the
25022 sender.
25023 .ecindex IIDpiptra1
25024 .ecindex IIDpiptra2
25025
25026
25027 . ////////////////////////////////////////////////////////////////////////////
25028 . ////////////////////////////////////////////////////////////////////////////
25029
25030 .chapter "The smtp transport" "CHAPsmtptrans"
25031 .scindex IIDsmttra1 "transports" "&(smtp)&"
25032 .scindex IIDsmttra2 "&(smtp)& transport"
25033 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
25034 or LMTP protocol. The list of hosts to try can either be taken from the address
25035 that is being processed (having been set up by the router), or specified
25036 explicitly for the transport. Timeout and retry processing (see chapter
25037 &<<CHAPretry>>&) is applied to each IP address independently.
25038
25039
25040 .section "Multiple messages on a single connection" "SECID144"
25041 The sending of multiple messages over a single TCP/IP connection can arise in
25042 two ways:
25043
25044 .ilist
25045 If a message contains more than &%max_rcpt%& (see below) addresses that are
25046 routed to the same host, more than one copy of the message has to be sent to
25047 that host. In this situation, multiple copies may be sent in a single run of
25048 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
25049 does when it has too many addresses to send in one message also depends on the
25050 value of the global &%remote_max_parallel%& option. Details are given in
25051 section &<<SECToutSMTPTCP>>&.)
25052 .next
25053 .cindex "hints database" "remembering routing"
25054 When a message has been successfully delivered over a TCP/IP connection, Exim
25055 looks in its hints database to see if there are any other messages awaiting a
25056 connection to the same host. If there are, a new delivery process is started
25057 for one of them, and the current TCP/IP connection is passed on to it. The new
25058 process may in turn send multiple copies and possibly create yet another
25059 process.
25060 .endlist
25061
25062
25063 For each copy sent over the same TCP/IP connection, a sequence counter is
25064 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25065 no further messages are sent over that connection.
25066
25067
25068
25069 .section "Use of the $host and $host_address variables" "SECID145"
25070 .vindex "&$host$&"
25071 .vindex "&$host_address$&"
25072 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25073 &$host_address$& are the name and IP address of the first host on the host list
25074 passed by the router. However, when the transport is about to connect to a
25075 specific host, and while it is connected to that host, &$host$& and
25076 &$host_address$& are set to the values for that host. These are the values
25077 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25078 &%serialize_hosts%&, and the various TLS options are expanded.
25079
25080
25081 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25082 .vindex &$tls_bits$&
25083 .vindex &$tls_cipher$&
25084 .vindex &$tls_peerdn$&
25085 .vindex &$tls_sni$&
25086 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25087 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25088 are the values that were set when the message was received.
25089 These are the values that are used for options that are expanded before any
25090 SMTP connections are made. Just before each connection is made, these four
25091 variables are emptied. If TLS is subsequently started, they are set to the
25092 appropriate values for the outgoing connection, and these are the values that
25093 are in force when any authenticators are run and when the
25094 &%authenticated_sender%& option is expanded.
25095
25096 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25097 and will be removed in a future release.
25098
25099
25100 .section "Private options for smtp" "SECID146"
25101 .cindex "options" "&(smtp)& transport"
25102 The private options of the &(smtp)& transport are as follows:
25103
25104
25105 .option address_retry_include_sender smtp boolean true
25106 .cindex "4&'xx'& responses" "retrying after"
25107 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25108 is the combination of sender and recipient that is delayed in subsequent queue
25109 runs until the retry time is reached. You can delay the recipient without
25110 reference to the sender (which is what earlier versions of Exim did), by
25111 setting &%address_retry_include_sender%& false. However, this can lead to
25112 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25113
25114 .option allow_localhost smtp boolean false
25115 .cindex "local host" "sending to"
25116 .cindex "fallback" "hosts specified on transport"
25117 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25118 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25119 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25120 the delivery anyway. This should be used only in special cases when the
25121 configuration ensures that no looping will result (for example, a differently
25122 configured Exim is listening on the port to which the message is sent).
25123
25124
25125 .option authenticated_sender smtp string&!! unset
25126 .cindex "Cyrus"
25127 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25128 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25129 overriding any existing authenticated sender value. If the string expansion is
25130 forced to fail, the option is ignored. Other expansion failures cause delivery
25131 to be deferred. If the result of expansion is an empty string, that is also
25132 ignored.
25133
25134 The expansion happens after the outgoing connection has been made and TLS
25135 started, if required. This means that the &$host$&, &$host_address$&,
25136 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25137 particular connection.
25138
25139 If the SMTP session is not authenticated, the expansion of
25140 &%authenticated_sender%& still happens (and can cause the delivery to be
25141 deferred if it fails), but no AUTH= item is added to MAIL commands
25142 unless &%authenticated_sender_force%& is true.
25143
25144 This option allows you to use the &(smtp)& transport in LMTP mode to
25145 deliver mail to Cyrus IMAP and provide the proper local part as the
25146 &"authenticated sender"&, via a setting such as:
25147 .code
25148 authenticated_sender = $local_part
25149 .endd
25150 This removes the need for IMAP subfolders to be assigned special ACLs to
25151 allow direct delivery to those subfolders.
25152
25153 Because of expected uses such as that just described for Cyrus (when no
25154 domain is involved), there is no checking on the syntax of the provided
25155 value.
25156
25157
25158 .option authenticated_sender_force smtp boolean false
25159 If this option is set true, the &%authenticated_sender%& option's value
25160 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25161 authenticated as a client.
25162
25163
25164 .option command_timeout smtp time 5m
25165 .cindex timeout "smtp transport command"
25166 This sets a timeout for receiving a response to an SMTP command that has been
25167 sent out. It is also used when waiting for the initial banner line from the
25168 remote host. Its value must not be zero.
25169
25170
25171 .option connect_timeout smtp time 5m
25172 .cindex timeout "smtp transport connect"
25173 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25174 to a remote host. A setting of zero allows the system timeout (typically
25175 several minutes) to act. To have any effect, the value of this option must be
25176 less than the system timeout. However, it has been observed that on some
25177 systems there is no system timeout, which is why the default value for this
25178 option is 5 minutes, a value recommended by RFC 1123.
25179
25180
25181 .option connection_max_messages smtp integer 500
25182 .cindex "SMTP" "passed connection"
25183 .cindex "SMTP" "multiple deliveries"
25184 .cindex "multiple SMTP deliveries"
25185 This controls the maximum number of separate message deliveries that are sent
25186 over a single TCP/IP connection. If the value is zero, there is no limit.
25187 For testing purposes, this value can be overridden by the &%-oB%& command line
25188 option.
25189
25190
25191 .option dane_require_tls_ciphers smtp string&!! unset
25192 .cindex "TLS" "requiring specific ciphers for DANE"
25193 .cindex "cipher" "requiring specific"
25194 .cindex DANE "TLS ciphers"
25195 This option may be used to override &%tls_require_ciphers%& for connections
25196 where DANE has been determined to be in effect.
25197 If not set, then &%tls_require_ciphers%& will be used.
25198 Normal SMTP delivery is not able to make strong demands of TLS cipher
25199 configuration, because delivery will fall back to plaintext.  Once DANE has
25200 been determined to be in effect, there is no plaintext fallback and making the
25201 TLS cipherlist configuration stronger will increase security, rather than
25202 counter-intuitively decreasing it.
25203 If the option expands to be empty or is forced to fail, then it will
25204 be treated as unset and &%tls_require_ciphers%& will be used instead.
25205
25206
25207 .option data_timeout smtp time 5m
25208 .cindex timeout "for transmitted SMTP data blocks"
25209 This sets a timeout for the transmission of each block in the data portion of
25210 the message. As a result, the overall timeout for a message depends on the size
25211 of the message. Its value must not be zero. See also &%final_timeout%&.
25212
25213
25214 .option dkim_canon smtp string&!! unset
25215 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25216 .option dkim_domain smtp "string list&!!" unset
25217 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25218 .option dkim_hash smtp string&!! sha256
25219 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25220 .option dkim_identity smtp string&!! unset
25221 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25222 .option dkim_private_key smtp string&!! unset
25223 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25224 .option dkim_selector smtp string&!! unset
25225 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25226 .option dkim_strict smtp string&!! unset
25227 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25228 .option dkim_sign_headers smtp string&!! "per RFC"
25229 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25230 .option dkim_timestamps smtp string&!! unset
25231 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25232
25233
25234 .option delay_after_cutoff smtp boolean true
25235 .cindex "final cutoff" "retries, controlling"
25236 .cindex retry "final cutoff"
25237 This option controls what happens when all remote IP addresses for a given
25238 domain have been inaccessible for so long that they have passed their retry
25239 cutoff times.
25240
25241 In the default state, if the next retry time has not been reached for any of
25242 them, the address is bounced without trying any deliveries. In other words,
25243 Exim delays retrying an IP address after the final cutoff time until a new
25244 retry time is reached, and can therefore bounce an address without ever trying
25245 a delivery, when machines have been down for a long time. Some people are
25246 unhappy at this prospect, so...
25247
25248 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25249 addresses are past their final cutoff time, Exim tries to deliver to those
25250 IP addresses that have not been tried since the message arrived. If there are
25251 none, of if they all fail, the address is bounced. In other words, it does not
25252 delay when a new message arrives, but immediately tries those expired IP
25253 addresses that haven't been tried since the message arrived. If there is a
25254 continuous stream of messages for the dead hosts, unsetting
25255 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25256 to them.
25257
25258
25259 .option dns_qualify_single smtp boolean true
25260 If the &%hosts%& or &%fallback_hosts%& option is being used,
25261 and the &%gethostbyname%& option is false,
25262 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25263 in chapter &<<CHAPdnslookup>>& for more details.
25264
25265
25266 .option dns_search_parents smtp boolean false
25267 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25268 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25269 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25270 details.
25271
25272
25273 .option dnssec_request_domains smtp "domain list&!!" *
25274 .cindex "MX record" "security"
25275 .cindex "DNSSEC" "MX lookup"
25276 .cindex "security" "MX lookup"
25277 .cindex "DNS" "DNSSEC"
25278 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25279 the DNSSEC request bit set. Setting this transport option is only useful if the
25280 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25281 router option.
25282
25283
25284
25285 .option dnssec_require_domains smtp "domain list&!!" unset
25286 .cindex "MX record" "security"
25287 .cindex "DNSSEC" "MX lookup"
25288 .cindex "security" "MX lookup"
25289 .cindex "DNS" "DNSSEC"
25290 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25291 the DNSSEC request bit set.  Setting this transport option is only
25292 useful if the transport overrides or sets the host names. See the
25293 &%dnssec_require_domains%& router option.
25294
25295
25296
25297 .option dscp smtp string&!! unset
25298 .cindex "DCSP" "outbound"
25299 This option causes the DSCP value associated with a socket to be set to one
25300 of a number of fixed strings or to numeric value.
25301 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25302 Common values include &`throughput`&, &`mincost`&, and on newer systems
25303 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25304
25305 The outbound packets from Exim will be marked with this value in the header
25306 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25307 that these values will have any effect, not be stripped by networking
25308 equipment, or do much of anything without cooperation with your Network
25309 Engineer and those of all network operators between the source and destination.
25310
25311
25312 .option fallback_hosts smtp "string list" unset
25313 .cindex "fallback" "hosts specified on transport"
25314 String expansion is not applied to this option. The argument must be a
25315 colon-separated list of host names or IP addresses, optionally also including
25316 port numbers, though the separator can be changed, as described in section
25317 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25318 item in a &%route_list%& setting for the &(manualroute)& router, as described
25319 in section &<<SECTformatonehostitem>>&.
25320
25321 Fallback hosts can also be specified on routers, which associate them with the
25322 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25323 &%fallback_hosts%& specified on the transport is used only if the address does
25324 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25325 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25326 However, &%hosts_randomize%& does apply to fallback host lists.
25327
25328 If Exim is unable to deliver to any of the hosts for a particular address, and
25329 the errors are not permanent rejections, the address is put on a separate
25330 transport queue with its host list replaced by the fallback hosts, unless the
25331 address was routed via MX records and the current host was in the original MX
25332 list. In that situation, the fallback host list is not used.
25333
25334 Once normal deliveries are complete, the fallback queue is delivered by
25335 re-running the same transports with the new host lists. If several failing
25336 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25337 copy of the message is sent.
25338
25339 The resolution of the host names on the fallback list is controlled by the
25340 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25341 both to cases when the host list comes with the address and when it is taken
25342 from &%hosts%&. This option provides a &"use a smart host only if delivery
25343 fails"& facility.
25344
25345
25346 .option final_timeout smtp time 10m
25347 .cindex timeout "for transmitted SMTP data accept"
25348 This is the timeout that applies while waiting for the response to the final
25349 line containing just &"."& that terminates a message. Its value must not be
25350 zero.
25351
25352 .option gethostbyname smtp boolean false
25353 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25354 being used, names are looked up using &[gethostbyname()]&
25355 (or &[getipnodebyname()]& when available)
25356 instead of using the DNS. Of course, that function may in fact use the DNS, but
25357 it may also consult other sources of information such as &_/etc/hosts_&.
25358
25359 .option gnutls_compat_mode smtp boolean unset
25360 This option controls whether GnuTLS is used in compatibility mode in an Exim
25361 server. This reduces security slightly, but improves interworking with older
25362 implementations of TLS.
25363
25364 .option helo_data smtp string&!! "see below"
25365 .cindex "HELO" "argument, setting"
25366 .cindex "EHLO" "argument, setting"
25367 .cindex "LHLO argument setting"
25368 The value of this option is expanded after a connection to a another host has
25369 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25370 command that starts the outgoing SMTP or LMTP session. The default value of the
25371 option is:
25372 .code
25373 $primary_hostname
25374 .endd
25375 During the expansion, the variables &$host$& and &$host_address$& are set to
25376 the identity of the remote host, and the variables &$sending_ip_address$& and
25377 &$sending_port$& are set to the local IP address and port number that are being
25378 used. These variables can be used to generate different values for different
25379 servers or different local IP addresses. For example, if you want the string
25380 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25381 interface address, you could use this:
25382 .code
25383 helo_data = ${lookup dnsdb{ptr=$sending_ip_address} \
25384   {${listextract{1}{<\n $value}}} \
25385   {$primary_hostname}}
25386 .endd
25387 The use of &%helo_data%& applies both to sending messages and when doing
25388 callouts.
25389
25390 .option host_name_extract smtp "string list&!!" "see below"
25391 .cindex "load balancer" "hosts behind"
25392 .cindex TLS resumption
25393 Some mail-accepting sites
25394 (notably Microsoft)
25395 operate many servers behind a network load-balancer.  When this is done,
25396 with separated TLS session caches, TLS session resuption becomes problematic.
25397 It will only succeed when the same server happens to be selected by the
25398 load-balancer, matching the session stored in the client's cache.
25399
25400 Exim can pull out a server name, if there is one, from the response to the
25401 client's SMTP EHLO command.
25402 The default value of this option:
25403 .code
25404     ${if and { {match {$host} {.outlook.com\$}} \
25405                {match {$item} {\N^250-([\w.]+)\s\N}} \
25406              } {$1}}
25407 .endd
25408 suffices for one known case.
25409 During the expansion of this option the &$item$& variable will have the
25410 server's EHLO response.
25411 The result of the option expansion is included in the key used to store and
25412 retrieve the TLS session, for session resumption.
25413
25414 Operators of high-load sites may wish to evaluate their logs for indications
25415 of other destination sites operating load-balancers, and develop a suitable
25416 expression for this option.
25417 The smtp:ehlo event and the &$tls_out_resumption$& variable
25418 will be useful for such work.
25419
25420 .option hosts smtp "string list&!!" unset
25421 Hosts are associated with an address by a router such as &(dnslookup)&, which
25422 finds the hosts by looking up the address domain in the DNS, or by
25423 &(manualroute)&, which has lists of hosts in its configuration. However,
25424 email addresses can be passed to the &(smtp)& transport by any router, and not
25425 all of them can provide an associated list of hosts.
25426
25427 The &%hosts%& option specifies a list of hosts to be used if the address being
25428 processed does not have any hosts associated with it. The hosts specified by
25429 &%hosts%& are also used, whether or not the address has its own hosts, if
25430 &%hosts_override%& is set.
25431
25432 The string is first expanded, before being interpreted as a colon-separated
25433 list of host names or IP addresses, possibly including port numbers. The
25434 separator may be changed to something other than colon, as described in section
25435 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25436 item in a &%route_list%& setting for the &(manualroute)& router, as described
25437 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25438 of the &(manualroute)& router is not available here.
25439
25440 If the expansion fails, delivery is deferred. Unless the failure was caused by
25441 the inability to complete a lookup, the error is logged to the panic log as
25442 well as the main log. Host names are looked up either by searching directly for
25443 address records in the DNS or by calling &[gethostbyname()]& (or
25444 &[getipnodebyname()]& when available), depending on the setting of the
25445 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25446 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25447 address are used.
25448
25449 During delivery, the hosts are tried in order, subject to their retry status,
25450 unless &%hosts_randomize%& is set.
25451
25452
25453 .option hosts_avoid_esmtp smtp "host list&!!" unset
25454 .cindex "ESMTP, avoiding use of"
25455 .cindex "HELO" "forcing use of"
25456 .cindex "EHLO" "avoiding use of"
25457 .cindex "PIPELINING" "avoiding the use of"
25458 This option is for use with broken hosts that announce ESMTP facilities (for
25459 example, PIPELINING) and then fail to implement them properly. When a host
25460 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25461 start of the SMTP session. This means that it cannot use any of the ESMTP
25462 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25463
25464
25465 .option hosts_avoid_pipelining smtp "host list&!!" unset
25466 .cindex "PIPELINING" "avoiding the use of"
25467 .cindex "ESMTP extensions" PIPELINING
25468 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25469 that matches this list, even if the server host advertises PIPELINING support.
25470
25471 .option hosts_pipe_connect smtp "host list&!!" unset
25472 .cindex "pipelining" "early connection"
25473 .cindex "pipelining" PIPECONNECT
25474 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25475 this option controls which to hosts the facility watched for
25476 and recorded, and used for subsequent connections.
25477
25478 The retry hints database is used for the record,
25479 and records are subject to the &%retry_data_expire%& option.
25480 When used, the pipelining saves on roundtrip times.
25481 It also turns SMTP into a client-first protocol
25482 so combines well with TCP Fast Open.
25483
25484 See also the &%pipelining_connect_advertise_hosts%& main option.
25485
25486 Note:
25487 When the facility is used, if the transport &%interface%& option is unset
25488 the &%helo_data%& option
25489 will be expanded before the &$sending_ip_address$& variable
25490 is filled in.
25491 A check is made for the use of that variable, without the
25492 presence of a &"def:"& test on it, but suitably complex coding
25493 can avoid the check and produce unexpected results.
25494 You have been warned.
25495
25496
25497 .option hosts_avoid_tls smtp "host list&!!" unset
25498 .cindex "TLS" "avoiding for certain hosts"
25499 Exim will not try to start a TLS session when delivering to any host that
25500 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25501
25502 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25503 .cindex "TLS" "avoiding for certain hosts"
25504 Exim will not try to start a TLS session for a verify callout,
25505 or when delivering in cutthrough mode,
25506 to any host that matches this list.
25507
25508
25509 .option hosts_max_try smtp integer 5
25510 .cindex "host" "maximum number to try"
25511 .cindex "limit" "number of hosts tried"
25512 .cindex "limit" "number of MX tried"
25513 .cindex "MX record" "maximum tried"
25514 This option limits the number of IP addresses that are tried for any one
25515 delivery in cases where there are temporary delivery errors. Section
25516 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25517
25518
25519 .option hosts_max_try_hardlimit smtp integer 50
25520 This is an additional check on the maximum number of IP addresses that Exim
25521 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25522 why it exists.
25523
25524
25525
25526 .option hosts_nopass_tls smtp "host list&!!" unset
25527 .cindex "TLS" "passing connection"
25528 .cindex "multiple SMTP deliveries"
25529 .cindex "TLS" "multiple message deliveries"
25530 For any host that matches this list, a connection on which a TLS session has
25531 been started will not be passed to a new delivery process for sending another
25532 message on the same connection. See section &<<SECTmulmessam>>& for an
25533 explanation of when this might be needed.
25534
25535 .option hosts_noproxy_tls smtp "host list&!!" unset
25536 .cindex "TLS" "passing connection"
25537 .cindex "multiple SMTP deliveries"
25538 .cindex "TLS" "multiple message deliveries"
25539 For any host that matches this list, a TLS session which has
25540 been started will not be passed to a new delivery process for sending another
25541 message on the same session.
25542
25543 The traditional implementation closes down TLS and re-starts it in the new
25544 process, on the same open TCP connection, for each successive message
25545 sent.  If permitted by this option a pipe to to the new process is set up
25546 instead, and the original process maintains the TLS connection and proxies
25547 the SMTP connection from and to the new process and any subsequents.
25548 The new process has no access to TLS information, so cannot include it in
25549 logging.
25550
25551
25552
25553 .option hosts_override smtp boolean false
25554 If this option is set and the &%hosts%& option is also set, any hosts that are
25555 attached to the address are ignored, and instead the hosts specified by the
25556 &%hosts%& option are always used. This option does not apply to
25557 &%fallback_hosts%&.
25558
25559
25560 .option hosts_randomize smtp boolean false
25561 .cindex "randomized host list"
25562 .cindex "host" "list of; randomized"
25563 .cindex "fallback" "randomized hosts"
25564 If this option is set, and either the list of hosts is taken from the
25565 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25566 were not obtained from MX records (this includes fallback hosts from the
25567 router), and were not randomized by the router, the order of trying the hosts
25568 is randomized each time the transport runs. Randomizing the order of a host
25569 list can be used to do crude load sharing.
25570
25571 When &%hosts_randomize%& is true, a host list may be split into groups whose
25572 order is separately randomized. This makes it possible to set up MX-like
25573 behaviour. The boundaries between groups are indicated by an item that is just
25574 &`+`& in the host list. For example:
25575 .code
25576 hosts = host1:host2:host3:+:host4:host5
25577 .endd
25578 The order of the first three hosts and the order of the last two hosts is
25579 randomized for each use, but the first three always end up before the last two.
25580 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25581
25582 .option hosts_require_auth smtp "host list&!!" unset
25583 .cindex "authentication" "required by client"
25584 This option provides a list of servers for which authentication must succeed
25585 before Exim will try to transfer a message. If authentication fails for
25586 servers which are not in this list, Exim tries to send unauthenticated. If
25587 authentication fails for one of these servers, delivery is deferred. This
25588 temporary error is detectable in the retry rules, so it can be turned into a
25589 hard failure if required. See also &%hosts_try_auth%&, and chapter
25590 &<<CHAPSMTPAUTH>>& for details of authentication.
25591
25592
25593 .option hosts_request_ocsp smtp "host list&!!" *
25594 .cindex "TLS" "requiring for certain servers"
25595 Exim will request a Certificate Status on a
25596 TLS session for any host that matches this list.
25597 &%tls_verify_certificates%& should also be set for the transport.
25598
25599 .option hosts_require_alpn smtp "host list&!!" unset
25600 .cindex ALPN "require negotiation in client"
25601 .cindex TLS ALPN
25602 .cindex TLS "Application Layer Protocol Names"
25603 If the TLS library supports ALPN
25604 then a successful negotiation of ALPN will be required for any host
25605 matching the list, for TLS to be used.
25606 See also the &%tls_alpn%& option.
25607
25608 &*Note*&: prevention of fallback to in-clear connection is not
25609 managed by this option; see &%hosts_require_tls%&.
25610
25611 .option hosts_require_dane smtp "host list&!!" unset
25612 .cindex DANE "transport options"
25613 .cindex DANE "requiring for certain servers"
25614 If built with DANE support, Exim  will require that a DNSSEC-validated
25615 TLSA record is present for any host matching the list,
25616 and that a DANE-verified TLS connection is made.
25617 There will be no fallback to in-clear communication.
25618 See the &%dnssec_request_domains%& router and transport options.
25619 See section &<<SECDANE>>&.
25620
25621 .option hosts_require_ocsp smtp "host list&!!" unset
25622 .cindex "TLS" "requiring for certain servers"
25623 Exim will request, and check for a valid Certificate Status being given, on a
25624 TLS session for any host that matches this list.
25625 &%tls_verify_certificates%& should also be set for the transport.
25626
25627 .option hosts_require_tls smtp "host list&!!" unset
25628 .cindex "TLS" "requiring for certain servers"
25629 Exim will insist on using a TLS session when delivering to any host that
25630 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25631 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25632 incoming messages, use an appropriate ACL.
25633
25634 .option hosts_try_auth smtp "host list&!!" unset
25635 .cindex "authentication" "optional in client"
25636 This option provides a list of servers to which, provided they announce
25637 authentication support, Exim will attempt to authenticate as a client when it
25638 connects. If authentication fails
25639 and &%hosts_require_auth%& permits,
25640 Exim will try to transfer the message unauthenticated.
25641 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25642
25643 .option hosts_try_chunking smtp "host list&!!" *
25644 .cindex CHUNKING "enabling, in client"
25645 .cindex BDAT "SMTP command"
25646 .cindex "RFC 3030" "CHUNKING"
25647 This option provides a list of servers to which, provided they announce
25648 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25649 Unless DKIM signing is being done,
25650 BDAT will not be used in conjunction with a transport filter.
25651
25652 .option hosts_try_dane smtp "host list&!!" *
25653 .cindex DANE "transport options"
25654 .cindex DANE "attempting for certain servers"
25655 If built with DANE support, Exim  will look up a
25656 TLSA record for any host matching the list,
25657 If one is found and that lookup was DNSSEC-validated,
25658 then Exim requires that a DANE-verified TLS connection is made for that host;
25659 there will be no fallback to in-clear communication.
25660 See the &%dnssec_request_domains%& router and transport options.
25661 See section &<<SECDANE>>&.
25662
25663 .option hosts_try_fastopen smtp "host list&!!" *
25664 .cindex "fast open, TCP" "enabling, in client"
25665 .cindex "TCP Fast Open" "enabling, in client"
25666 .cindex "RFC 7413" "TCP Fast Open"
25667 This option provides a list of servers to which, provided
25668 the facility is supported by this system, Exim will attempt to
25669 perform a TCP Fast Open.
25670 No data is sent on the SYN segment but, if the remote server also
25671 supports the facility, it can send its SMTP banner immediately after
25672 the SYN,ACK segment.  This can save up to one round-trip time.
25673
25674 The facility is only active for previously-contacted servers,
25675 as the initiator must present a cookie in the SYN segment.
25676
25677 On (at least some) current Linux distributions the facility must be enabled
25678 in the kernel by the sysadmin before the support is usable.
25679 There is no option for control of the server side; if the system supports
25680 it it is always enabled.  Note that lengthy operations in the connect ACL,
25681 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25682
25683 .option hosts_try_prdr smtp "host list&!!" *
25684 .cindex "PRDR" "enabling, optional in client"
25685 .cindex "ESMTP extensions" PRDR
25686 This option provides a list of servers to which, provided they announce
25687 PRDR support, Exim will attempt to negotiate PRDR
25688 for multi-recipient messages.
25689 The option can usually be left as default.
25690
25691 .option interface smtp "string list&!!" unset
25692 .cindex "bind IP address"
25693 .cindex "IP address" "binding"
25694 .vindex "&$host$&"
25695 .vindex "&$host_address$&"
25696 This option specifies which interface to bind to when making an outgoing SMTP
25697 call. The value is an IP address, not an interface name such as
25698 &`eth0`&. Do not confuse this with the interface address that was used when a
25699 message was received, which is in &$received_ip_address$&, formerly known as
25700 &$interface_address$&. The name was changed to minimize confusion with the
25701 outgoing interface address. There is no variable that contains an outgoing
25702 interface address because, unless it is set by this option, its value is
25703 unknown.
25704
25705 During the expansion of the &%interface%& option the variables &$host$& and
25706 &$host_address$& refer to the host to which a connection is about to be made
25707 during the expansion of the string. Forced expansion failure, or an empty
25708 string result causes the option to be ignored. Otherwise, after expansion, the
25709 string must be a list of IP addresses, colon-separated by default, but the
25710 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25711 For example:
25712 .code
25713 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25714 .endd
25715 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25716 connection. If none of them are the correct type, the option is ignored. If
25717 &%interface%& is not set, or is ignored, the system's IP functions choose which
25718 interface to use if the host has more than one.
25719
25720
25721 .option keepalive smtp boolean true
25722 .cindex "keepalive" "on outgoing connection"
25723 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25724 connections. When set, it causes the kernel to probe idle connections
25725 periodically, by sending packets with &"old"& sequence numbers. The other end
25726 of the connection should send a acknowledgment if the connection is still okay
25727 or a reset if the connection has been aborted. The reason for doing this is
25728 that it has the beneficial effect of freeing up certain types of connection
25729 that can get stuck when the remote host is disconnected without tidying up the
25730 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25731 unreachable hosts.
25732
25733
25734 .option lmtp_ignore_quota smtp boolean false
25735 .cindex "LMTP" "ignoring quota errors"
25736 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25737 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25738 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25739
25740 .option max_rcpt smtp integer 100
25741 .cindex "RCPT" "maximum number of outgoing"
25742 This option limits the number of RCPT commands that are sent in a single
25743 SMTP message transaction. Each set of addresses is treated independently, and
25744 so can cause parallel connections to the same host if &%remote_max_parallel%&
25745 permits this. A value setting of zero disables the limit.
25746
25747
25748 .option message_linelength_limit smtp integer 998
25749 .cindex "line length" limit
25750 This option sets the maximum line length, in bytes, that the transport
25751 will send.  Any messages with lines exceeding the given value
25752 will fail and a failure-DSN ("bounce") message will if possible be returned
25753 to the sender.
25754 The default value is that defined by the SMTP standards.
25755
25756 It is generally wise to also check in the data ACL so that messages
25757 received via SMTP can be refused without producing a bounce.
25758
25759
25760 .option multi_domain smtp boolean&!! true
25761 .vindex "&$domain$&"
25762 When this option is set, the &(smtp)& transport can handle a number of
25763 addresses containing a mixture of different domains provided they all resolve
25764 to the same list of hosts. Turning the option off restricts the transport to
25765 handling only one domain at a time. This is useful if you want to use
25766 &$domain$& in an expansion for the transport, because it is set only when there
25767 is a single domain involved in a remote delivery.
25768
25769 It is expanded per-address and can depend on any of
25770 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25771 &$host$&, &$host_address$& and &$host_port$&.
25772
25773 If the connection is DANE-enabled then this option is ignored;
25774 only messages having the domain used for the DANE TLSA lookup are
25775 sent on the connection.
25776
25777 .option port smtp string&!! "see below"
25778 .cindex "port" "sending TCP/IP"
25779 .cindex "TCP/IP" "setting outgoing port"
25780 This option specifies the TCP/IP port on the server to which Exim connects.
25781 &*Note:*& Do not confuse this with the port that was used when a message was
25782 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25783 The name was changed to minimize confusion with the outgoing port. There is no
25784 variable that contains an outgoing port.
25785
25786 If the value of this option begins with a digit it is taken as a port number;
25787 otherwise it is looked up using &[getservbyname()]&. The default value is
25788 normally &"smtp"&,
25789 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25790 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25791 If the expansion fails, or if a port number cannot be found, delivery
25792 is deferred.
25793
25794 Note that at least one Linux distribution has been seen failing
25795 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25796
25797
25798
25799 .option protocol smtp string smtp
25800 .cindex "LMTP" "over TCP/IP"
25801 .cindex "ssmtp protocol" "outbound"
25802 .cindex "TLS" "SSL-on-connect outbound"
25803 .vindex "&$port$&"
25804 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25805 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25806 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25807 deliveries into closed message stores. Exim also has support for running LMTP
25808 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25809
25810 If this option is set to &"smtps"&, the default value for the &%port%& option
25811 changes to &"smtps"&, and the transport initiates TLS immediately after
25812 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25813 The Internet standards bodies used to strongly discourage use of this mode,
25814 but as of RFC 8314 it is preferred over STARTTLS for message submission
25815 (as distinct from MTA-MTA communication).
25816
25817
25818 .option retry_include_ip_address smtp boolean&!! true
25819 Exim normally includes both the host name and the IP address in the key it
25820 constructs for indexing retry data after a temporary delivery failure. This
25821 means that when one of several IP addresses for a host is failing, it gets
25822 tried periodically (controlled by the retry rules), but use of the other IP
25823 addresses is not affected.
25824
25825 However, in some dialup environments hosts are assigned a different IP address
25826 each time they connect. In this situation the use of the IP address as part of
25827 the retry key leads to undesirable behaviour. Setting this option false causes
25828 Exim to use only the host name.
25829 Since it is expanded it can be made to depend on the host or domain.
25830
25831
25832 .option serialize_hosts smtp "host list&!!" unset
25833 .cindex "serializing connections"
25834 .cindex "host" "serializing connections"
25835 Because Exim operates in a distributed manner, if several messages for the same
25836 host arrive at around the same time, more than one simultaneous connection to
25837 the remote host can occur. This is not usually a problem except when there is a
25838 slow link between the hosts. In that situation it may be helpful to restrict
25839 Exim to one connection at a time. This can be done by setting
25840 &%serialize_hosts%& to match the relevant hosts.
25841
25842 .cindex "hints database" "serializing deliveries to a host"
25843 Exim implements serialization by means of a hints database in which a record is
25844 written whenever a process connects to one of the restricted hosts. The record
25845 is deleted when the connection is completed. Obviously there is scope for
25846 records to get left lying around if there is a system or program crash. To
25847 guard against this, Exim ignores any records that are more than six hours old.
25848
25849 If you set up this kind of serialization, you should also arrange to delete the
25850 relevant hints database whenever your system reboots. The names of the files
25851 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25852 may be one or two files, depending on the type of DBM in use. The same files
25853 are used for ETRN serialization.
25854
25855 See also the &%max_parallel%& generic transport option.
25856
25857
25858 .option size_addition smtp integer 1024
25859 .cindex "SIZE" "ESMTP extension"
25860 .cindex "message" "size issue for transport filter"
25861 .cindex "size" "of message"
25862 .cindex "transport" "filter"
25863 .cindex "filter" "transport filter"
25864 If a remote SMTP server indicates that it supports the SIZE option of the
25865 MAIL command, Exim uses this to pass over the message size at the start of
25866 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25867 sends, to allow for headers and other text that may be added during delivery by
25868 configuration options or in a transport filter. It may be necessary to increase
25869 this if a lot of text is added to messages.
25870
25871 Alternatively, if the value of &%size_addition%& is set negative, it disables
25872 the use of the SIZE option altogether.
25873
25874
25875 .option socks_proxy smtp string&!! unset
25876 .cindex proxy SOCKS
25877 This option enables use of SOCKS proxies for connections made by the
25878 transport.  For details see section &<<SECTproxySOCKS>>&.
25879
25880
25881 .option tls_alpn smtp string&!! unset
25882 .cindex TLS "Application Layer Protocol Names"
25883 .cindex TLS ALPN
25884 .cindex ALPN "set name in client"
25885 If this option is set
25886 and the TLS library supports ALPN,
25887 the value given is used.
25888
25889 As of writing no value has been standardised for email use.
25890 The authors suggest using &"smtp"&.
25891
25892
25893
25894 .option tls_certificate smtp string&!! unset
25895 .cindex "TLS" "client certificate, location of"
25896 .cindex "certificate" "client, location of"
25897 .vindex "&$host$&"
25898 .vindex "&$host_address$&"
25899 The value of this option must be the absolute path to a file which contains the
25900 client's certificate, for possible use when sending a message over an encrypted
25901 connection. The values of &$host$& and &$host_address$& are set to the name and
25902 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25903 details of TLS.
25904
25905 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25906 certificate when sending messages as a client. The global option of the same
25907 name specifies the certificate for Exim as a server; it is not automatically
25908 assumed that the same certificate should be used when Exim is operating as a
25909 client.
25910
25911
25912 .option tls_crl smtp string&!! unset
25913 .cindex "TLS" "client certificate revocation list"
25914 .cindex "certificate" "revocation list for client"
25915 This option specifies a certificate revocation list. The expanded value must
25916 be the name of a file that contains a CRL in PEM format.
25917
25918
25919 .option tls_dh_min_bits smtp integer 1024
25920 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25921 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25922 key agreement is negotiated, the server will provide a large prime number
25923 for use.  This option establishes the minimum acceptable size of that number.
25924 If the parameter offered by the server is too small, then the TLS handshake
25925 will fail.
25926
25927 Only supported when using GnuTLS.
25928
25929
25930 .option tls_privatekey smtp string&!! unset
25931 .cindex "TLS" "client private key, location of"
25932 .vindex "&$host$&"
25933 .vindex "&$host_address$&"
25934 The value of this option must be the absolute path to a file which contains the
25935 client's private key. This is used when sending a message over an encrypted
25936 connection using a client certificate. The values of &$host$& and
25937 &$host_address$& are set to the name and address of the server during the
25938 expansion. If this option is unset, or the expansion is forced to fail, or the
25939 result is an empty string, the private key is assumed to be in the same file as
25940 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25941
25942
25943 .option tls_require_ciphers smtp string&!! unset
25944 .cindex "TLS" "requiring specific ciphers"
25945 .cindex "cipher" "requiring specific"
25946 .vindex "&$host$&"
25947 .vindex "&$host_address$&"
25948 The value of this option must be a list of permitted cipher suites, for use
25949 when setting up an outgoing encrypted connection. (There is a global option of
25950 the same name for controlling incoming connections.) The values of &$host$& and
25951 &$host_address$& are set to the name and address of the server during the
25952 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25953 is used in different ways by OpenSSL and GnuTLS (see sections
25954 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25955 ciphers is a preference order.
25956
25957
25958 .option tls_resumption_hosts smtp "host list&!!" unset
25959 .cindex TLS resumption
25960 This option controls which connections to use the TLS resumption feature.
25961 See &<<SECTresumption>>& for details.
25962
25963
25964
25965 .option tls_sni smtp string&!! unset
25966 .cindex "TLS" "Server Name Indication"
25967 .cindex "TLS" SNI
25968 .cindex SNI "setting in client"
25969 .vindex "&$tls_sni$&"
25970 If this option is set
25971 and the connection is not DANE-validated
25972 then it sets the $tls_out_sni variable and causes any
25973 TLS session to pass this value as the Server Name Indication extension to
25974 the remote side, which can be used by the remote side to select an appropriate
25975 certificate and private key for the session.
25976
25977 See &<<SECTtlssni>>& for more information.
25978
25979 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25980 TLS extensions.
25981
25982
25983
25984
25985 .option tls_tempfail_tryclear smtp boolean true
25986 .cindex "4&'xx'& responses" "to STARTTLS"
25987 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25988 setting up a TLS session, this option determines whether or not Exim should try
25989 to deliver the message unencrypted. If it is set false, delivery to the
25990 current host is deferred; if there are other hosts, they are tried. If this
25991 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25992 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25993 TLS negotiation fails, Exim closes the current connection (because it is in an
25994 unknown state), opens a new one to the same host, and then tries the delivery
25995 in clear.
25996
25997
25998 .option tls_try_verify_hosts smtp "host list&!!" *
25999 .cindex "TLS" "server certificate verification"
26000 .cindex "certificate" "verification of server"
26001 This option gives a list of hosts for which, on encrypted connections,
26002 certificate verification will be tried but need not succeed.
26003 The &%tls_verify_certificates%& option must also be set.
26004 Note that unless the host is in this list
26005 TLS connections will be denied to hosts using self-signed certificates
26006 when &%tls_verify_certificates%& is matched.
26007 The &$tls_out_certificate_verified$& variable is set when
26008 certificate verification succeeds.
26009
26010
26011 .option tls_verify_cert_hostnames smtp "host list&!!" *
26012 .cindex "TLS" "server certificate hostname verification"
26013 .cindex "certificate" "verification of server"
26014 This option give a list of hosts for which,
26015 while verifying the server certificate,
26016 checks will be included on the host name
26017 (note that this will generally be the result of a DNS MX lookup)
26018 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
26019 limited to being the initial component of a 3-or-more component FQDN.
26020
26021 There is no equivalent checking on client certificates.
26022
26023
26024 .option tls_verify_certificates smtp string&!! system
26025 .cindex "TLS" "server certificate verification"
26026 .cindex "certificate" "verification of server"
26027 .vindex "&$host$&"
26028 .vindex "&$host_address$&"
26029 The value of this option must be either the
26030 word "system"
26031 or the absolute path to
26032 a file or directory containing permitted certificates for servers,
26033 for use when setting up an encrypted connection.
26034
26035 The "system" value for the option will use a location compiled into the SSL library.
26036 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
26037 is taken as empty and an explicit location
26038 must be specified.
26039
26040 The use of a directory for the option value is not available for GnuTLS versions
26041 preceding 3.3.6 and a single file must be used.
26042
26043 With OpenSSL the certificates specified
26044 explicitly
26045 either by file or directory
26046 are added to those given by the system default location.
26047
26048 The values of &$host$& and
26049 &$host_address$& are set to the name and address of the server during the
26050 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
26051
26052 For back-compatibility,
26053 if neither tls_verify_hosts nor tls_try_verify_hosts are set
26054 (a single-colon empty list counts as being set)
26055 and certificate verification fails the TLS connection is closed.
26056
26057
26058 .option tls_verify_hosts smtp "host list&!!" unset
26059 .cindex "TLS" "server certificate verification"
26060 .cindex "certificate" "verification of server"
26061 This option gives a list of hosts for which, on encrypted connections,
26062 certificate verification must succeed.
26063 The &%tls_verify_certificates%& option must also be set.
26064 If both this option and &%tls_try_verify_hosts%& are unset
26065 operation is as if this option selected all hosts.
26066 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
26067 that connections use TLS.
26068 Fallback to in-clear communication will be done unless restricted by 
26069 the &%hosts_require_tls%& option.
26070
26071 .option utf8_downconvert smtp integer&!! -1
26072 .cindex utf8 "address downconversion"
26073 .cindex i18n "utf8 address downconversion"
26074 If built with internationalization support,
26075 this option controls conversion of UTF-8 in message envelope addresses
26076 to a-label form.
26077 If, after expansion, the value is 1, 0, or -1 then this value overrides
26078 any value previously set for the message.  Otherwise, any previously
26079 set value is used.  To permit use of a previous value,
26080 set this option to an empty string.
26081 For details on the values see section &<<SECTi18nMTA>>&.
26082
26083
26084
26085
26086 .section "How the limits for the number of hosts to try are used" &&&
26087          "SECTvalhosmax"
26088 .cindex "host" "maximum number to try"
26089 .cindex "limit" "hosts; maximum number tried"
26090 There are two options that are concerned with the number of hosts that are
26091 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
26092 &%hosts_max_try_hardlimit%&.
26093
26094
26095 The &%hosts_max_try%& option limits the number of hosts that are tried
26096 for a single delivery. However, despite the term &"host"& in its name, the
26097 option actually applies to each IP address independently. In other words, a
26098 multihomed host is treated as several independent hosts, just as it is for
26099 retrying.
26100
26101 Many of the larger ISPs have multiple MX records which often point to
26102 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26103 created as a result of routing one of these domains.
26104
26105 Trying every single IP address on such a long list does not seem sensible; if
26106 several at the top of the list fail, it is reasonable to assume there is some
26107 problem that is likely to affect all of them. Roughly speaking, the value of
26108 &%hosts_max_try%& is the maximum number that are tried before deferring the
26109 delivery. However, the logic cannot be quite that simple.
26110
26111 Firstly, IP addresses that are skipped because their retry times have not
26112 arrived do not count, and in addition, addresses that are past their retry
26113 limits are also not counted, even when they are tried. This means that when
26114 some IP addresses are past their retry limits, more than the value of
26115 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26116 that all IP addresses are considered before timing out an email address (but
26117 see below for an exception).
26118
26119 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26120 list to see if there is a subsequent host with a different (higher valued) MX.
26121 If there is, that host is considered next, and the current IP address is used
26122 but not counted. This behaviour helps in the case of a domain with a retry rule
26123 that hardly ever delays any hosts, as is now explained:
26124
26125 Consider the case of a long list of hosts with one MX value, and a few with a
26126 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26127 hosts at the top of the list are tried at first. With the default retry rule,
26128 which specifies increasing retry times, the higher MX hosts are eventually
26129 tried when those at the top of the list are skipped because they have not
26130 reached their retry times.
26131
26132 However, it is common practice to put a fixed short retry time on domains for
26133 large ISPs, on the grounds that their servers are rarely down for very long.
26134 Unfortunately, these are exactly the domains that tend to resolve to long lists
26135 of hosts. The short retry time means that the lowest MX hosts are tried every
26136 time. The attempts may be in a different order because of random sorting, but
26137 without the special MX check, the higher MX hosts would never be tried until
26138 all the lower MX hosts had timed out (which might be several days), because
26139 there are always some lower MX hosts that have reached their retry times. With
26140 the special check, Exim considers at least one IP address from each MX value at
26141 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26142 reached.
26143
26144 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26145 particular, Exim normally eventually tries all the IP addresses before timing
26146 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26147 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26148 been set up with hundreds of IP addresses for some domains. It can
26149 take a very long time indeed for an address to time out in these cases.
26150
26151 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26152 Exim never tries more than this number of IP addresses; if it hits this limit
26153 and they are all timed out, the email address is bounced, even though not all
26154 possible IP addresses have been tried.
26155 .ecindex IIDsmttra1
26156 .ecindex IIDsmttra2
26157
26158
26159
26160
26161
26162 . ////////////////////////////////////////////////////////////////////////////
26163 . ////////////////////////////////////////////////////////////////////////////
26164
26165 .chapter "Address rewriting" "CHAPrewrite"
26166 .scindex IIDaddrew "rewriting" "addresses"
26167 There are some circumstances in which Exim automatically rewrites domains in
26168 addresses. The two most common are when an address is given without a domain
26169 (referred to as an &"unqualified address"&) or when an address contains an
26170 abbreviated domain that is expanded by DNS lookup.
26171
26172 Unqualified envelope addresses are accepted only for locally submitted
26173 messages, or for messages that are received from hosts matching
26174 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26175 appropriate. Unqualified addresses in header lines are qualified if they are in
26176 locally submitted messages, or messages from hosts that are permitted to send
26177 unqualified envelope addresses. Otherwise, unqualified addresses in header
26178 lines are neither qualified nor rewritten.
26179
26180 One situation in which Exim does &'not'& automatically rewrite a domain is
26181 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26182 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26183 do this. The new RFCs do not contain this suggestion.
26184
26185
26186 .section "Explicitly configured address rewriting" "SECID147"
26187 This chapter describes the rewriting rules that can be used in the
26188 main rewrite section of the configuration file, and also in the generic
26189 &%headers_rewrite%& option that can be set on any transport.
26190
26191 Some people believe that configured address rewriting is a Mortal Sin.
26192 Others believe that life is not possible without it. Exim provides the
26193 facility; you do not have to use it.
26194
26195 The main rewriting rules that appear in the &"rewrite"& section of the
26196 configuration file are applied to addresses in incoming messages, both envelope
26197 addresses and addresses in header lines. Each rule specifies the types of
26198 address to which it applies.
26199
26200 Whether or not addresses in header lines are rewritten depends on the origin of
26201 the headers and the type of rewriting. Global rewriting, that is, rewriting
26202 rules from the rewrite section of the configuration file, is applied only to
26203 those headers that were received with the message. Header lines that are added
26204 by ACLs or by a system filter or by individual routers or transports (which
26205 are specific to individual recipient addresses) are not rewritten by the global
26206 rules.
26207
26208 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26209 applies all headers except those added by routers and transports. That is, as
26210 well as the headers that were received with the message, it also applies to
26211 headers that were added by an ACL or a system filter.
26212
26213
26214 In general, rewriting addresses from your own system or domain has some
26215 legitimacy. Rewriting other addresses should be done only with great care and
26216 in special circumstances. The author of Exim believes that rewriting should be
26217 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26218 Although it can sometimes be used as a routing tool, this is very strongly
26219 discouraged.
26220
26221 There are two commonly encountered circumstances where rewriting is used, as
26222 illustrated by these examples:
26223
26224 .ilist
26225 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26226 exchange mail with each other behind a firewall, but there is only a single
26227 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26228 &'hitch.fict.example'& when sending mail off-site.
26229 .next
26230 A host rewrites the local parts of its own users so that, for example,
26231 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26232 .endlist
26233
26234
26235
26236 .section "When does rewriting happen?" "SECID148"
26237 .cindex "rewriting" "timing of"
26238 .cindex "&ACL;" "rewriting addresses in"
26239 Configured address rewriting can take place at several different stages of a
26240 message's processing.
26241
26242 .vindex "&$sender_address$&"
26243 At the start of an ACL for MAIL, the sender address may have been rewritten
26244 by a special SMTP-time rewrite rule (see section &<<SSECTrewriteS>>&), but no
26245 ordinary rewrite rules have yet been applied. If, however, the sender address
26246 is verified in the ACL, it is rewritten before verification, and remains
26247 rewritten thereafter. The subsequent value of &$sender_address$& is the
26248 rewritten address. This also applies if sender verification happens in a
26249 RCPT ACL. Otherwise, when the sender address is not verified, it is
26250 rewritten as soon as a message's header lines have been received.
26251
26252 .vindex "&$domain$&"
26253 .vindex "&$local_part$&"
26254 Similarly, at the start of an ACL for RCPT, the current recipient's address
26255 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26256 rewrite rules have yet been applied to it. However, the behaviour is different
26257 from the sender address when a recipient is verified. The address is rewritten
26258 for the verification, but the rewriting is not remembered at this stage. The
26259 value of &$local_part$& and &$domain$& after verification are always the same
26260 as they were before (that is, they contain the unrewritten &-- except for
26261 SMTP-time rewriting &-- address).
26262
26263 As soon as a message's header lines have been received, all the envelope
26264 recipient addresses are permanently rewritten, and rewriting is also applied to
26265 the addresses in the header lines (if configured). This happens before adding
26266 any header lines that were specified in MAIL or RCPT ACLs, and
26267 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26268 before the DATA ACL and &[local_scan()]& functions are run.
26269
26270 When an address is being routed, either for delivery or for verification,
26271 rewriting is applied immediately to child addresses that are generated by
26272 redirection, unless &%no_rewrite%& is set on the router.
26273
26274 .cindex "envelope from"
26275 .cindex "envelope sender" "rewriting at transport time"
26276 .cindex "rewriting" "at transport time"
26277 .cindex "header lines" "rewriting at transport time"
26278 At transport time, additional rewriting of addresses in header lines can be
26279 specified by setting the generic &%headers_rewrite%& option on a transport.
26280 This option contains rules that are identical in form to those in the rewrite
26281 section of the configuration file. They are applied to the original message
26282 header lines and any that were added by ACLs or a system filter. They are not
26283 applied to header lines that are added by routers or the transport.
26284
26285 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26286 transport option. However, it is not possible to rewrite envelope recipients at
26287 transport time.
26288
26289
26290
26291
26292 .section "Testing the rewriting rules that apply on input" "SECID149"
26293 .cindex "rewriting" "testing"
26294 .cindex "testing" "rewriting"
26295 Exim's input rewriting configuration appears in a part of the runtime
26296 configuration file headed by &"begin rewrite"&. It can be tested by the
26297 &%-brw%& command line option. This takes an address (which can be a full RFC
26298 2822 address) as its argument. The output is a list of how the address would be
26299 transformed by the rewriting rules for each of the different places it might
26300 appear in an incoming message, that is, for each different header and for the
26301 envelope sender and recipient fields. For example,
26302 .code
26303 exim -brw ph10@exim.workshop.example
26304 .endd
26305 might produce the output
26306 .code
26307 sender: Philip.Hazel@exim.workshop.example
26308 from: Philip.Hazel@exim.workshop.example
26309 to: ph10@exim.workshop.example
26310 cc: ph10@exim.workshop.example
26311 bcc: ph10@exim.workshop.example
26312 reply-to: Philip.Hazel@exim.workshop.example
26313 env-from: Philip.Hazel@exim.workshop.example
26314 env-to: ph10@exim.workshop.example
26315 .endd
26316 which shows that rewriting has been set up for that address when used in any of
26317 the source fields, but not when it appears as a recipient address. At the
26318 present time, there is no equivalent way of testing rewriting rules that are
26319 set for a particular transport.
26320
26321
26322 .section "Rewriting rules" "SECID150"
26323 .cindex "rewriting" "rules"
26324 The rewrite section of the configuration file consists of lines of rewriting
26325 rules in the form
26326 .display
26327 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26328 .endd
26329 Rewriting rules that are specified for the &%headers_rewrite%& generic
26330 transport option are given as a colon-separated list. Each item in the list
26331 takes the same form as a line in the main rewriting configuration (except that
26332 any colons must be doubled, of course).
26333
26334 The formats of source patterns and replacement strings are described below.
26335 Each is terminated by white space, unless enclosed in double quotes, in which
26336 case normal quoting conventions apply inside the quotes. The flags are single
26337 characters which may appear in any order. Spaces and tabs between them are
26338 ignored.
26339
26340 For each address that could potentially be rewritten, the rules are scanned in
26341 order, and replacements for the address from earlier rules can themselves be
26342 replaced by later rules (but see the &"q"& and &"R"& flags).
26343
26344 The order in which addresses are rewritten is undefined, may change between
26345 releases, and must not be relied on, with one exception: when a message is
26346 received, the envelope sender is always rewritten first, before any header
26347 lines are rewritten. For example, the replacement string for a rewrite of an
26348 address in &'To:'& must not assume that the message's address in &'From:'& has
26349 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26350 that the envelope sender has already been rewritten.
26351
26352 .vindex "&$domain$&"
26353 .vindex "&$local_part$&"
26354 The variables &$local_part$& and &$domain$& can be used in the replacement
26355 string to refer to the address that is being rewritten. Note that lookup-driven
26356 rewriting can be done by a rule of the form
26357 .code
26358 *@*   ${lookup ...
26359 .endd
26360 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26361 refer to the address that is being rewritten.
26362
26363
26364 .section "Rewriting patterns" "SECID151"
26365 .cindex "rewriting" "patterns"
26366 .cindex "address list" "in a rewriting pattern"
26367 The source pattern in a rewriting rule is any item which may appear in an
26368 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26369 single-item address list, which means that it is expanded before being tested
26370 against the address. As always, if you use a regular expression as a pattern,
26371 you must take care to escape dollar and backslash characters, or use the &`\N`&
26372 facility to suppress string expansion within the regular expression.
26373
26374 Domains in patterns should be given in lower case. Local parts in patterns are
26375 case-sensitive. If you want to do case-insensitive matching of local parts, you
26376 can use a regular expression that starts with &`^(?i)`&.
26377
26378 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26379 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26380 depending on the type of match which occurred. These can be used in the
26381 replacement string to insert portions of the incoming address. &$0$& always
26382 refers to the complete incoming address. When a regular expression is used, the
26383 numerical variables are set from its capturing subexpressions. For other types
26384 of pattern they are set as follows:
26385
26386 .ilist
26387 If a local part or domain starts with an asterisk, the numerical variables
26388 refer to the character strings matched by asterisks, with &$1$& associated with
26389 the first asterisk, and &$2$& with the second, if present. For example, if the
26390 pattern
26391 .code
26392 *queen@*.fict.example
26393 .endd
26394 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26395 .code
26396 $0 = hearts-queen@wonderland.fict.example
26397 $1 = hearts-
26398 $2 = wonderland
26399 .endd
26400 Note that if the local part does not start with an asterisk, but the domain
26401 does, it is &$1$& that contains the wild part of the domain.
26402
26403 .next
26404 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26405 of the domain are placed in the next available numerical variables. Suppose,
26406 for example, that the address &'foo@bar.baz.example'& is processed by a
26407 rewriting rule of the form
26408 .display
26409 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26410 .endd
26411 and the key in the file that matches the domain is &`*.baz.example`&. Then
26412 .code
26413 $1 = foo
26414 $2 = bar
26415 $3 = baz.example
26416 .endd
26417 If the address &'foo@baz.example'& is looked up, this matches the same
26418 wildcard file entry, and in this case &$2$& is set to the empty string, but
26419 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26420 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26421 whole domain. For non-partial domain lookups, no numerical variables are set.
26422 .endlist
26423
26424
26425 .section "Rewriting replacements" "SECID152"
26426 .cindex "rewriting" "replacements"
26427 If the replacement string for a rule is a single asterisk, addresses that
26428 match the pattern and the flags are &'not'& rewritten, and no subsequent
26429 rewriting rules are scanned. For example,
26430 .code
26431 hatta@lookingglass.fict.example  *  f
26432 .endd
26433 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26434 &'From:'& headers.
26435
26436 .vindex "&$domain$&"
26437 .vindex "&$local_part$&"
26438 If the replacement string is not a single asterisk, it is expanded, and must
26439 yield a fully qualified address. Within the expansion, the variables
26440 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26441 Any letters they contain retain their original case &-- they are not lower
26442 cased. The numerical variables are set up according to the type of pattern that
26443 matched the address, as described above. If the expansion is forced to fail by
26444 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26445 current rule is abandoned, but subsequent rules may take effect. Any other
26446 expansion failure causes the entire rewriting operation to be abandoned, and an
26447 entry written to the panic log.
26448
26449
26450
26451 .subsection "Rewriting flags" "SSECID153"
26452 There are three different kinds of flag that may appear on rewriting rules:
26453
26454 .ilist
26455 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26456 c, f, h, r, s, t.
26457 .next
26458 A flag that specifies rewriting at SMTP time: S.
26459 .next
26460 Flags that control the rewriting process: Q, q, R, w.
26461 .endlist
26462
26463 For rules that are part of the &%headers_rewrite%& generic transport option,
26464 E, F, T, and S are not permitted.
26465
26466
26467
26468 .subsection "Flags specifying which headers and envelope addresses to rewrite" &&&
26469          "SSECID154"
26470 .cindex rewriting flags
26471 If none of the following flag letters, nor the &"S"& flag (see section
26472 &<<SSECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26473 and to both the sender and recipient fields of the envelope, whereas a
26474 transport-time rewriting rule just applies to all headers. Otherwise, the
26475 rewriting rule is skipped unless the relevant addresses are being processed.
26476 .display
26477 &`E`&       rewrite all envelope fields
26478 &`F`&       rewrite the envelope From field
26479 &`T`&       rewrite the envelope To field
26480 &`b`&       rewrite the &'Bcc:'& header
26481 &`c`&       rewrite the &'Cc:'& header
26482 &`f`&       rewrite the &'From:'& header
26483 &`h`&       rewrite all headers
26484 &`r`&       rewrite the &'Reply-To:'& header
26485 &`s`&       rewrite the &'Sender:'& header
26486 &`t`&       rewrite the &'To:'& header
26487 .endd
26488 "All headers" means all of the headers listed above that can be selected
26489 individually, plus their &'Resent-'& versions. It does not include
26490 other headers such as &'Subject:'& etc.
26491
26492 You should be particularly careful about rewriting &'Sender:'& headers, and
26493 restrict this to special known cases in your own domains.
26494
26495
26496 .subsection "The SMTP-time rewriting flag" SSECTrewriteS
26497 .cindex SMTP "rewriting malformed addresses"
26498 .cindex RCPT "rewriting argument of"
26499 .cindex MAIL "rewriting argument of"
26500 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26501 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26502 before any other processing; even before syntax checking. The pattern is
26503 required to be a regular expression, and it is matched against the whole of the
26504 data for the command, including any surrounding angle brackets.
26505
26506 .vindex "&$domain$&"
26507 .vindex "&$local_part$&"
26508 This form of rewrite rule allows for the handling of addresses that are not
26509 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26510 input). Because the input is not required to be a syntactically valid address,
26511 the variables &$local_part$& and &$domain$& are not available during the
26512 expansion of the replacement string. The result of rewriting replaces the
26513 original address in the MAIL or RCPT command.
26514
26515
26516 .subsection "Flags controlling the rewriting process" SSECID155
26517 There are four flags which control the way the rewriting process works. These
26518 take effect only when a rule is invoked, that is, when the address is of the
26519 correct type (matches the flags) and matches the pattern:
26520
26521 .ilist
26522 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26523 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26524 absence of &"Q"& the rewritten address must always include a domain.
26525 .next
26526 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26527 even if no rewriting actually takes place because of a &"fail"& in the
26528 expansion. The &"q"& flag is not effective if the address is of the wrong type
26529 (does not match the flags) or does not match the pattern.
26530 .next
26531 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26532 address, up to ten times. It can be combined with the &"q"& flag, to stop
26533 rewriting once it fails to match (after at least one successful rewrite).
26534 .next
26535 .cindex "rewriting" "whole addresses"
26536 When an address in a header is rewritten, the rewriting normally applies only
26537 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26538 left unchanged. For example, rewriting might change
26539 .code
26540 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26541 .endd
26542 into
26543 .code
26544 From: Ford Prefect <prefectf@hitch.fict.example>
26545 .endd
26546 .cindex "RFC 2047"
26547 Sometimes there is a need to replace the whole address item, and this can be
26548 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26549 causes an address in a header line to be rewritten, the entire address is
26550 replaced, not just the working part. The replacement must be a complete RFC
26551 2822 address, including the angle brackets if necessary. If text outside angle
26552 brackets contains a character whose value is greater than 126 or less than 32
26553 (except for tab), the text is encoded according to RFC 2047. The character set
26554 is taken from &%headers_charset%&, which gets its default at build time.
26555
26556 When the &"w"& flag is set on a rule that causes an envelope address to be
26557 rewritten, all but the working part of the replacement address is discarded.
26558 .endlist
26559
26560
26561 .section "Rewriting examples" "SECID156"
26562 Here is an example of the two common rewriting paradigms:
26563 .code
26564 *@*.hitch.fict.example  $1@hitch.fict.example
26565 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26566                      {$value}fail}@hitch.fict.example bctfrF
26567 .endd
26568 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26569 the string expansion to fail if the lookup does not succeed. In this context it
26570 has the effect of leaving the original address unchanged, but Exim goes on to
26571 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26572 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26573 explicitly, which would cause the rewritten address to be the same as before,
26574 at the cost of a small bit of processing. Not supplying either of these is an
26575 error, since the rewritten address would then contain no local part.
26576
26577 The first example above replaces the domain with a superior, more general
26578 domain. This may not be desirable for certain local parts. If the rule
26579 .code
26580 root@*.hitch.fict.example  *
26581 .endd
26582 were inserted before the first rule, rewriting would be suppressed for the
26583 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26584
26585 Rewriting can be made conditional on a number of tests, by making use of
26586 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26587 messages that originate outside the local host:
26588 .code
26589 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26590                          {$1@hitch.fict.example}fail}"
26591 .endd
26592 The replacement string is quoted in this example because it contains white
26593 space.
26594
26595 .cindex "rewriting" "bang paths"
26596 .cindex "bang paths" "rewriting"
26597 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26598 an address it treats it as an unqualified local part which it qualifies with
26599 the local qualification domain (if the source of the message is local or if the
26600 remote host is permitted to send unqualified addresses). Rewriting can
26601 sometimes be used to handle simple bang paths with a fixed number of
26602 components. For example, the rule
26603 .code
26604 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26605 .endd
26606 rewrites a two-component bang path &'host.name!user'& as the domain address
26607 &'user@host.name'&. However, there is a security implication in using this as
26608 a global rewriting rule for envelope addresses. It can provide a backdoor
26609 method for using your system as a relay, because the incoming addresses appear
26610 to be local. If the bang path addresses are received via SMTP, it is safer to
26611 use the &"S"& flag to rewrite them as they are received, so that relay checking
26612 can be done on the rewritten addresses.
26613 .ecindex IIDaddrew
26614
26615
26616
26617
26618
26619 . ////////////////////////////////////////////////////////////////////////////
26620 . ////////////////////////////////////////////////////////////////////////////
26621
26622 .chapter "Retry configuration" "CHAPretry"
26623 .scindex IIDretconf1 "retry" "configuration, description of"
26624 .scindex IIDregconf2 "configuration file" "retry section"
26625 The &"retry"& section of the runtime configuration file contains a list of
26626 retry rules that control how often Exim tries to deliver messages that cannot
26627 be delivered at the first attempt. If there are no retry rules (the section is
26628 empty or not present), there are no retries. In this situation, temporary
26629 errors are treated as permanent. The default configuration contains a single,
26630 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26631 line option can be used to test which retry rule will be used for a given
26632 address, domain and error.
26633
26634 The most common cause of retries is temporary failure to deliver to a remote
26635 host because the host is down, or inaccessible because of a network problem.
26636 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26637 address) basis, not on a per-message basis. Thus, if one message has recently
26638 been delayed, delivery of a new message to the same host is not immediately
26639 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26640 log selector is set, the message
26641 .cindex "retry" "time not reached"
26642 &"retry time not reached"& is written to the main log whenever a delivery is
26643 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26644 the handling of errors during remote deliveries.
26645
26646 Retry processing applies to routing as well as to delivering, except as covered
26647 in the next paragraph. The retry rules do not distinguish between these
26648 actions. It is not possible, for example, to specify different behaviour for
26649 failures to route the domain &'snark.fict.example'& and failures to deliver to
26650 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26651 added complication, so did not implement it. However, although they share the
26652 same retry rule, the actual retry times for routing and transporting a given
26653 domain are maintained independently.
26654
26655 When a delivery is not part of a queue run (typically an immediate delivery on
26656 receipt of a message), the routers are always run, and local deliveries are
26657 always attempted, even if retry times are set for them. This makes for better
26658 behaviour if one particular message is causing problems (for example, causing
26659 quota overflow, or provoking an error in a filter file). If such a delivery
26660 suffers a temporary failure, the retry data is updated as normal, and
26661 subsequent delivery attempts from queue runs occur only when the retry time for
26662 the local address is reached.
26663
26664 .section "Changing retry rules" "SECID157"
26665 If you change the retry rules in your configuration, you should consider
26666 whether or not to delete the retry data that is stored in Exim's spool area in
26667 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26668 always safe; that is why they are called &"hints"&.
26669
26670 The hints retry data contains suggested retry times based on the previous
26671 rules. In the case of a long-running problem with a remote host, it might
26672 record the fact that the host has timed out. If your new rules increase the
26673 timeout time for such a host, you should definitely remove the old retry data
26674 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26675 messages that it should now be retaining.
26676
26677
26678
26679 .section "Format of retry rules" "SECID158"
26680 .cindex "retry" "rules"
26681 Each retry rule occupies one line and consists of three or four parts,
26682 separated by white space: a pattern, an error name, an optional list of sender
26683 addresses, and a list of retry parameters. The pattern and sender lists must be
26684 enclosed in double quotes if they contain white space. The rules are searched
26685 in order until one is found where the pattern, error name, and sender list (if
26686 present) match the failing host or address, the error that occurred, and the
26687 message's sender, respectively.
26688
26689
26690 The pattern is any single item that may appear in an address list (see section
26691 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26692 which means that it is expanded before being tested against the address that
26693 has been delayed. A negated address list item is permitted. Address
26694 list processing treats a plain domain name as if it were preceded by &"*@"&,
26695 which makes it possible for many retry rules to start with just a domain. For
26696 example,
26697 .code
26698 lookingglass.fict.example        *  F,24h,30m;
26699 .endd
26700 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26701 whereas
26702 .code
26703 alice@lookingglass.fict.example  *  F,24h,30m;
26704 .endd
26705 applies only to temporary failures involving the local part &%alice%&.
26706 In practice, almost all rules start with a domain name pattern without a local
26707 part.
26708
26709 .cindex "regular expressions" "in retry rules"
26710 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26711 must match a complete address, not just a domain, because that is how regular
26712 expressions work in address lists.
26713 .display
26714 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26715 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26716 .endd
26717
26718
26719 .section "Choosing which retry rule to use for address errors" "SECID159"
26720 When Exim is looking for a retry rule after a routing attempt has failed (for
26721 example, after a DNS timeout), each line in the retry configuration is tested
26722 against the complete address only if &%retry_use_local_part%& is set for the
26723 router. Otherwise, only the domain is used, except when matching against a
26724 regular expression, when the local part of the address is replaced with &"*"&.
26725 A domain on its own can match a domain pattern, or a pattern that starts with
26726 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26727 &%check_local_user%& is true, and false for other routers.
26728
26729 Similarly, when Exim is looking for a retry rule after a local delivery has
26730 failed (for example, after a mailbox full error), each line in the retry
26731 configuration is tested against the complete address only if
26732 &%retry_use_local_part%& is set for the transport (it defaults true for all
26733 local transports).
26734
26735 .cindex "4&'xx'& responses" "retry rules for"
26736 However, when Exim is looking for a retry rule after a remote delivery attempt
26737 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26738 whole address is always used as the key when searching the retry rules. The
26739 rule that is found is used to create a retry time for the combination of the
26740 failing address and the message's sender. It is the combination of sender and
26741 recipient that is delayed in subsequent queue runs until its retry time is
26742 reached. You can delay the recipient without regard to the sender by setting
26743 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26744 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26745 commands.
26746
26747
26748
26749 .section "Choosing which retry rule to use for host and message errors" &&&
26750          "SECID160"
26751 For a temporary error that is not related to an individual address (for
26752 example, a connection timeout), each line in the retry configuration is checked
26753 twice. First, the name of the remote host is used as a domain name (preceded by
26754 &"*@"& when matching a regular expression). If this does not match the line,
26755 the domain from the email address is tried in a similar fashion. For example,
26756 suppose the MX records for &'a.b.c.example'& are
26757 .code
26758 a.b.c.example  MX  5  x.y.z.example
26759                MX  6  p.q.r.example
26760                MX  7  m.n.o.example
26761 .endd
26762 and the retry rules are
26763 .code
26764 p.q.r.example    *      F,24h,30m;
26765 a.b.c.example    *      F,4d,45m;
26766 .endd
26767 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26768 first rule matches neither the host nor the domain, so Exim looks at the second
26769 rule. This does not match the host, but it does match the domain, so it is used
26770 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26771 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26772 first retry rule is used, because it matches the host.
26773
26774 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26775 first rule to determine retry times, but for all the other hosts for the domain
26776 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26777 routing to &'a.b.c.example'& suffers a temporary failure.
26778
26779 &*Note*&: The host name is used when matching the patterns, not its IP address.
26780 However, if a message is routed directly to an IP address without the use of a
26781 host name, for example, if a &(manualroute)& router contains a setting such as:
26782 .code
26783 route_list = *.a.example  192.168.34.23
26784 .endd
26785 then the &"host name"& that is used when searching for a retry rule is the
26786 textual form of the IP address.
26787
26788 .section "Retry rules for specific errors" "SECID161"
26789 .cindex "retry" "specific errors; specifying"
26790 The second field in a retry rule is the name of a particular error, or an
26791 asterisk, which matches any error. The errors that can be tested for are:
26792
26793 .vlist
26794 .vitem &%auth_failed%&
26795 Authentication failed when trying to send to a host in the
26796 &%hosts_require_auth%& list in an &(smtp)& transport.
26797
26798 .vitem &%data_4xx%&
26799 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26800 after the command, or after sending the message's data.
26801
26802 .vitem &%mail_4xx%&
26803 A 4&'xx'& error was received for an outgoing MAIL command.
26804
26805 .vitem &%rcpt_4xx%&
26806 A 4&'xx'& error was received for an outgoing RCPT command.
26807 .endlist
26808
26809 For the three 4&'xx'& errors, either the first or both of the x's can be given
26810 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26811 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26812 and have retries every ten minutes with a one-hour timeout, you could set up a
26813 retry rule of this form:
26814 .code
26815 the.domain.name  rcpt_452   F,1h,10m
26816 .endd
26817 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26818 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26819
26820 .vlist
26821 .vitem &%lost_connection%&
26822 A server unexpectedly closed the SMTP connection. There may, of course,
26823 legitimate reasons for this (host died, network died), but if it repeats a lot
26824 for the same host, it indicates something odd.
26825
26826 .vitem &%lookup%&
26827 A DNS lookup for a host failed.
26828 Note that a &%dnslookup%& router will need to have matched
26829 its &%fail_defer_domains%& option for this retry type to be usable.
26830 Also note that a &%manualroute%& router will probably need
26831 its &%host_find_failed%& option set to &%defer%&.
26832
26833 .vitem &%refused_MX%&
26834 A connection to a host obtained from an MX record was refused.
26835
26836 .vitem &%refused_A%&
26837 A connection to a host not obtained from an MX record was refused.
26838
26839 .vitem &%refused%&
26840 A connection was refused.
26841
26842 .vitem &%timeout_connect_MX%&
26843 A connection attempt to a host obtained from an MX record timed out.
26844
26845 .vitem &%timeout_connect_A%&
26846 A connection attempt to a host not obtained from an MX record timed out.
26847
26848 .vitem &%timeout_connect%&
26849 A connection attempt timed out.
26850
26851 .vitem &%timeout_MX%&
26852 There was a timeout while connecting or during an SMTP session with a host
26853 obtained from an MX record.
26854
26855 .vitem &%timeout_A%&
26856 There was a timeout while connecting or during an SMTP session with a host not
26857 obtained from an MX record.
26858
26859 .vitem &%timeout%&
26860 There was a timeout while connecting or during an SMTP session.
26861
26862 .vitem &%tls_required%&
26863 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26864 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26865 to STARTTLS, or there was a problem setting up the TLS connection.
26866
26867 .vitem &%quota%&
26868 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26869 transport.
26870
26871 .vitem &%quota_%&<&'time'&>
26872 .cindex "quota" "error testing in retry rule"
26873 .cindex "retry" "quota error testing"
26874 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26875 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26876 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26877 for four days.
26878 .endlist
26879
26880 .cindex "mailbox" "time of last read"
26881 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26882 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26883 it should be based on the last time that the user accessed the mailbox.
26884 However, it is not always possible to determine this. Exim uses the following
26885 heuristic rules:
26886
26887 .ilist
26888 If the mailbox is a single file, the time of last access (the &"atime"&) is
26889 used. As no new messages are being delivered (because the mailbox is over
26890 quota), Exim does not access the file, so this is the time of last user access.
26891 .next
26892 .cindex "maildir format" "time of last read"
26893 For a maildir delivery, the time of last modification of the &_new_&
26894 subdirectory is used. As the mailbox is over quota, no new files are created in
26895 the &_new_& subdirectory, because no new messages are being delivered. Any
26896 change to the &_new_& subdirectory is therefore assumed to be the result of an
26897 MUA moving a new message to the &_cur_& directory when it is first read. The
26898 time that is used is therefore the last time that the user read a new message.
26899 .next
26900 For other kinds of multi-file mailbox, the time of last access cannot be
26901 obtained, so a retry rule that uses this type of error field is never matched.
26902 .endlist
26903
26904 The quota errors apply both to system-enforced quotas and to Exim's own quota
26905 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26906 when a local delivery is deferred because a partition is full (the ENOSPC
26907 error).
26908
26909
26910
26911 .section "Retry rules for specified senders" "SECID162"
26912 .cindex "retry" "rules; sender-specific"
26913 You can specify retry rules that apply only when the failing message has a
26914 specific sender. In particular, this can be used to define retry rules that
26915 apply only to bounce messages. The third item in a retry rule can be of this
26916 form:
26917 .display
26918 &`senders=`&<&'address list'&>
26919 .endd
26920 The retry timings themselves are then the fourth item. For example:
26921 .code
26922 *   rcpt_4xx   senders=:   F,1h,30m
26923 .endd
26924 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26925 host. If the address list contains white space, it must be enclosed in quotes.
26926 For example:
26927 .code
26928 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26929 .endd
26930 &*Warning*&: This facility can be unhelpful if it is used for host errors
26931 (which do not depend on the recipient). The reason is that the sender is used
26932 only to match the retry rule. Once the rule has been found for a host error,
26933 its contents are used to set a retry time for the host, and this will apply to
26934 all messages, not just those with specific senders.
26935
26936 When testing retry rules using &%-brt%&, you can supply a sender using the
26937 &%-f%& command line option, like this:
26938 .code
26939 exim -f "" -brt user@dom.ain
26940 .endd
26941 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26942 list is never matched.
26943
26944
26945
26946
26947
26948 .section "Retry parameters" "SECID163"
26949 .cindex "retry" "parameters in rules"
26950 The third (or fourth, if a senders list is present) field in a retry rule is a
26951 sequence of retry parameter sets, separated by semicolons. Each set consists of
26952 .display
26953 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26954 .endd
26955 The letter identifies the algorithm for computing a new retry time; the cutoff
26956 time is the time beyond which this algorithm no longer applies, and the
26957 arguments vary the algorithm's action. The cutoff time is measured from the
26958 time that the first failure for the domain (combined with the local part if
26959 relevant) was detected, not from the time the message was received.
26960
26961 .cindex "retry" "algorithms"
26962 .cindex "retry" "fixed intervals"
26963 .cindex "retry" "increasing intervals"
26964 .cindex "retry" "random intervals"
26965 The available algorithms are:
26966
26967 .ilist
26968 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26969 the interval.
26970 .next
26971 &'G'&: retry at geometrically increasing intervals. The first argument
26972 specifies a starting value for the interval, and the second a multiplier, which
26973 is used to increase the size of the interval at each retry.
26974 .next
26975 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26976 retry, the previous interval is multiplied by the factor in order to get a
26977 maximum for the next interval. The minimum interval is the first argument of
26978 the parameter, and an actual interval is chosen randomly between them. Such a
26979 rule has been found to be helpful in cluster configurations when all the
26980 members of the cluster restart at once, and may therefore synchronize their
26981 queue processing times.
26982 .endlist
26983
26984 When computing the next retry time, the algorithm definitions are scanned in
26985 order until one whose cutoff time has not yet passed is reached. This is then
26986 used to compute a new retry time that is later than the current time. In the
26987 case of fixed interval retries, this simply means adding the interval to the
26988 current time. For geometrically increasing intervals, retry intervals are
26989 computed from the rule's parameters until one that is greater than the previous
26990 interval is found. The main configuration variable
26991 .cindex "limit" "retry interval"
26992 .cindex "retry" "interval, maximum"
26993 .oindex "&%retry_interval_max%&"
26994 &%retry_interval_max%& limits the maximum interval between retries. It
26995 cannot be set greater than &`24h`&, which is its default value.
26996
26997 A single remote domain may have a number of hosts associated with it, and each
26998 host may have more than one IP address. Retry algorithms are selected on the
26999 basis of the domain name, but are applied to each IP address independently. If,
27000 for example, a host has two IP addresses and one is unusable, Exim will
27001 generate retry times for it and will not try to use it until its next retry
27002 time comes. Thus the good IP address is likely to be tried first most of the
27003 time.
27004
27005 .cindex "hints database" "use for retrying"
27006 Retry times are hints rather than promises. Exim does not make any attempt to
27007 run deliveries exactly at the computed times. Instead, a queue runner process
27008 starts delivery processes for delayed messages periodically, and these attempt
27009 new deliveries only for those addresses that have passed their next retry time.
27010 If a new message arrives for a deferred address, an immediate delivery attempt
27011 occurs only if the address has passed its retry time. In the absence of new
27012 messages, the minimum time between retries is the interval between queue runner
27013 processes. There is not much point in setting retry times of five minutes if
27014 your queue runners happen only once an hour, unless there are a significant
27015 number of incoming messages (which might be the case on a system that is
27016 sending everything to a smart host, for example).
27017
27018 The data in the retry hints database can be inspected by using the
27019 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
27020 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
27021 &'exinext'& utility script can be used to find out what the next retry times
27022 are for the hosts associated with a particular mail domain, and also for local
27023 deliveries that have been deferred.
27024
27025
27026 .section "Retry rule examples" "SECID164"
27027 Here are some example retry rules:
27028 .code
27029 alice@wonderland.fict.example quota_5d  F,7d,3h
27030 wonderland.fict.example       quota_5d
27031 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
27032 lookingglass.fict.example     *         F,24h,30m;
27033 *                 refused_A   F,2h,20m;
27034 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
27035 .endd
27036 The first rule sets up special handling for mail to
27037 &'alice@wonderland.fict.example'& when there is an over-quota error and the
27038 mailbox has not been read for at least 5 days. Retries continue every three
27039 hours for 7 days. The second rule handles over-quota errors for all other local
27040 parts at &'wonderland.fict.example'&; the absence of a local part has the same
27041 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
27042 fail are bounced immediately if the mailbox has not been read for at least 5
27043 days.
27044
27045 The third rule handles all other errors at &'wonderland.fict.example'&; retries
27046 happen every 15 minutes for an hour, then with geometrically increasing
27047 intervals until two days have passed since a delivery first failed. After the
27048 first hour there is a delay of one hour, then two hours, then four hours, and
27049 so on (this is a rather extreme example).
27050
27051 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
27052 They happen every 30 minutes for 24 hours only. The remaining two rules handle
27053 all other domains, with special action for connection refusal from hosts that
27054 were not obtained from an MX record.
27055
27056 The final rule in a retry configuration should always have asterisks in the
27057 first two fields so as to provide a general catch-all for any addresses that do
27058 not have their own special handling. This example tries every 15 minutes for 2
27059 hours, then with intervals starting at one hour and increasing by a factor of
27060 1.5 up to 16 hours, then every 8 hours up to 5 days.
27061
27062
27063
27064 .section "Timeout of retry data" "SECID165"
27065 .cindex "timeout" "of retry data"
27066 .oindex "&%retry_data_expire%&"
27067 .cindex "hints database" "data expiry"
27068 .cindex "retry" "timeout of data"
27069 Exim timestamps the data that it writes to its retry hints database. When it
27070 consults the data during a delivery it ignores any that is older than the value
27071 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
27072 been tried for 7 days, Exim will try to deliver to it immediately a message
27073 arrives, and if that fails, it will calculate a retry time as if it were
27074 failing for the first time.
27075
27076 This improves the behaviour for messages routed to rarely-used hosts such as MX
27077 backups. If such a host was down at one time, and happens to be down again when
27078 Exim tries a month later, using the old retry data would imply that it had been
27079 down all the time, which is not a justified assumption.
27080
27081 If a host really is permanently dead, this behaviour causes a burst of retries
27082 every now and again, but only if messages routed to it are rare. If there is a
27083 message at least once every 7 days the retry data never expires.
27084
27085
27086
27087
27088 .section "Long-term failures" "SECID166"
27089 .cindex "delivery failure, long-term"
27090 .cindex "retry" "after long-term failure"
27091 Special processing happens when an email address has been failing for so long
27092 that the cutoff time for the last algorithm is reached. For example, using the
27093 default retry rule:
27094 .code
27095 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
27096 .endd
27097 the cutoff time is four days. Reaching the retry cutoff is independent of how
27098 long any specific message has been failing; it is the length of continuous
27099 failure for the recipient address that counts.
27100
27101 When the cutoff time is reached for a local delivery, or for all the IP
27102 addresses associated with a remote delivery, a subsequent delivery failure
27103 causes Exim to give up on the address, and a bounce message is generated.
27104 In order to cater for new messages that use the failing address, a next retry
27105 time is still computed from the final algorithm, and is used as follows:
27106
27107 For local deliveries, one delivery attempt is always made for any subsequent
27108 messages. If this delivery fails, the address fails immediately. The
27109 post-cutoff retry time is not used.
27110
27111 .cindex "final cutoff" "retries, controlling"
27112 .cindex retry "final cutoff"
27113 If the delivery is remote, there are two possibilities, controlled by the
27114 .oindex "&%delay_after_cutoff%&"
27115 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27116 default. Until the post-cutoff retry time for one of the IP addresses,
27117 as set by the &%retry_data_expire%& option, is
27118 reached, the failing email address is bounced immediately, without a delivery
27119 attempt taking place. After that time, one new delivery attempt is made to
27120 those IP addresses that are past their retry times, and if that still fails,
27121 the address is bounced and new retry times are computed.
27122
27123 In other words, when all the hosts for a given email address have been failing
27124 for a long time, Exim bounces rather then defers until one of the hosts' retry
27125 times is reached. Then it tries once, and bounces if that attempt fails. This
27126 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27127 to a broken destination, but if the host does recover, Exim will eventually
27128 notice.
27129
27130 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27131 addresses are past their final cutoff time, Exim tries to deliver to those IP
27132 addresses that have not been tried since the message arrived. If there are
27133 no suitable IP addresses, or if they all fail, the address is bounced. In other
27134 words, it does not delay when a new message arrives, but tries the expired
27135 addresses immediately, unless they have been tried since the message arrived.
27136 If there is a continuous stream of messages for the failing domains, setting
27137 &%delay_after_cutoff%& false means that there will be many more attempts to
27138 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27139 true.
27140
27141 .section "Deliveries that work intermittently" "SECID167"
27142 .cindex "retry" "intermittently working deliveries"
27143 Some additional logic is needed to cope with cases where a host is
27144 intermittently available, or when a message has some attribute that prevents
27145 its delivery when others to the same address get through. In this situation,
27146 because some messages are successfully delivered, the &"retry clock"& for the
27147 host or address keeps getting reset by the successful deliveries, and so
27148 failing messages remain in the queue for ever because the cutoff time is never
27149 reached.
27150
27151 Two exceptional actions are applied to prevent this happening. The first
27152 applies to errors that are related to a message rather than a remote host.
27153 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27154 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27155 commands, and quota failures. For this type of error, if a message's arrival
27156 time is earlier than the &"first failed"& time for the error, the earlier time
27157 is used when scanning the retry rules to decide when to try next and when to
27158 time out the address.
27159
27160 The exceptional second action applies in all cases. If a message has been on
27161 the queue for longer than the cutoff time of any applicable retry rule for a
27162 given address, a delivery is attempted for that address, even if it is not yet
27163 time, and if this delivery fails, the address is timed out. A new retry time is
27164 not computed in this case, so that other messages for the same address are
27165 considered immediately.
27166 .ecindex IIDretconf1
27167 .ecindex IIDregconf2
27168
27169
27170
27171
27172
27173
27174 . ////////////////////////////////////////////////////////////////////////////
27175 . ////////////////////////////////////////////////////////////////////////////
27176
27177 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27178 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27179 .scindex IIDauthconf2 "authentication"
27180 The &"authenticators"& section of Exim's runtime configuration is concerned
27181 with SMTP authentication. This facility is an extension to the SMTP protocol,
27182 described in RFC 2554, which allows a client SMTP host to authenticate itself
27183 to a server. This is a common way for a server to recognize clients that are
27184 permitted to use it as a relay. SMTP authentication is not of relevance to the
27185 transfer of mail between servers that have no managerial connection with each
27186 other.
27187
27188 The name of an authenticator is limited to be &drivernamemax; ASCII characters long;
27189 prior to Exim 4.95 names would be silently truncated at this length, but now
27190 it is enforced.
27191
27192 .cindex "AUTH" "description of"
27193 .cindex "ESMTP extensions" AUTH
27194 Very briefly, the way SMTP authentication works is as follows:
27195
27196 .olist
27197 The server advertises a number of authentication &'mechanisms'& in response to
27198 the client's EHLO command.
27199 .next
27200 The client issues an AUTH command, naming a specific mechanism. The command
27201 may, optionally, contain some authentication data.
27202 .next
27203 The server may issue one or more &'challenges'&, to which the client must send
27204 appropriate responses. In simple authentication mechanisms, the challenges are
27205 just prompts for user names and passwords. The server does not have to issue
27206 any challenges &-- in some mechanisms the relevant data may all be transmitted
27207 with the AUTH command.
27208 .next
27209 The server either accepts or denies authentication.
27210 .next
27211 If authentication succeeds, the client may optionally make use of the AUTH
27212 option on the MAIL command to pass an authenticated sender in subsequent
27213 mail transactions. Authentication lasts for the remainder of the SMTP
27214 connection.
27215 .next
27216 If authentication fails, the client may give up, or it may try a different
27217 authentication mechanism, or it may try transferring mail over the
27218 unauthenticated connection.
27219 .endlist
27220
27221 If you are setting up a client, and want to know which authentication
27222 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27223 SMTP port) on the server, and issue an EHLO command. The response to this
27224 includes the list of supported mechanisms. For example:
27225 .display
27226 &`$ `&&*&`telnet server.example 25`&*&
27227 &`Trying 192.168.34.25...`&
27228 &`Connected to server.example.`&
27229 &`Escape character is &#x0027;^]&#x0027;.`&
27230 &`220 server.example ESMTP Exim 4.20 ...`&
27231 &*&`ehlo client.example`&*&
27232 &`250-server.example Hello client.example [10.8.4.5]`&
27233 &`250-SIZE 52428800`&
27234 &`250-PIPELINING`&
27235 &`250-AUTH PLAIN`&
27236 &`250 HELP`&
27237 .endd
27238 The second-last line of this example output shows that the server supports
27239 authentication using the PLAIN mechanism. In Exim, the different authentication
27240 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27241 routers and transports, which authenticators are included in the binary is
27242 controlled by build-time definitions. The following are currently available,
27243 included by setting
27244 .code
27245 AUTH_CRAM_MD5=yes
27246 AUTH_CYRUS_SASL=yes
27247 AUTH_DOVECOT=yes
27248 AUTH_EXTERNAL=yes
27249 AUTH_GSASL=yes
27250 AUTH_HEIMDAL_GSSAPI=yes
27251 AUTH_PLAINTEXT=yes
27252 AUTH_SPA=yes
27253 AUTH_TLS=yes
27254 .endd
27255 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27256 authentication mechanism (RFC 2195), and the second provides an interface to
27257 the Cyrus SASL authentication library.
27258 The third is an interface to Dovecot's authentication system, delegating the
27259 work via a socket interface.
27260 The fourth provides for negotiation of authentication done via non-SMTP means,
27261 as defined by RFC 4422 Appendix A.
27262 The fifth provides an interface to the GNU SASL authentication library, which
27263 provides mechanisms but typically not data sources.
27264 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27265 supporting setting a server keytab.
27266 The seventh can be configured to support
27267 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27268 not formally documented, but used by several MUAs.
27269 The eighth authenticator
27270 supports Microsoft's &'Secure Password Authentication'& mechanism.
27271 The last is an Exim authenticator but not an SMTP one;
27272 instead it can use information from a TLS negotiation.
27273
27274 The authenticators are configured using the same syntax as other drivers (see
27275 section &<<SECTfordricon>>&). If no authenticators are required, no
27276 authentication section need be present in the configuration file. Each
27277 authenticator can in principle have both server and client functions. When Exim
27278 is receiving SMTP mail, it is acting as a server; when it is sending out
27279 messages over SMTP, it is acting as a client. Authenticator configuration
27280 options are provided for use in both these circumstances.
27281
27282 To make it clear which options apply to which situation, the prefixes
27283 &%server_%& and &%client_%& are used on option names that are specific to
27284 either the server or the client function, respectively. Server and client
27285 functions are disabled if none of their options are set. If an authenticator is
27286 to be used for both server and client functions, a single definition, using
27287 both sets of options, is required. For example:
27288 .code
27289 cram:
27290   driver = cram_md5
27291   public_name = CRAM-MD5
27292   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27293   client_name = ph10
27294   client_secret = secret2
27295 .endd
27296 The &%server_%& option is used when Exim is acting as a server, and the
27297 &%client_%& options when it is acting as a client.
27298
27299 Descriptions of the individual authenticators are given in subsequent chapters.
27300 The remainder of this chapter covers the generic options for the
27301 authenticators, followed by general discussion of the way authentication works
27302 in Exim.
27303
27304 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27305 per-mechanism basis.  Please read carefully to determine which variables hold
27306 account labels such as usercodes and which hold passwords or other
27307 authenticating data.
27308
27309 Note that some mechanisms support two different identifiers for accounts: the
27310 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27311 and &'authz'& are commonly encountered.  The American spelling is standard here.
27312 Conceptually, authentication data such as passwords are tied to the identifier
27313 used to authenticate; servers may have rules to permit one user to act as a
27314 second user, so that after login the session is treated as though that second
27315 user had logged in.  That second user is the &'authorization id'&.  A robust
27316 configuration might confirm that the &'authz'& field is empty or matches the
27317 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27318 as verified data, the &'authz'& as an unverified request which the server might
27319 choose to honour.
27320
27321 A &'realm'& is a text string, typically a domain name, presented by a server
27322 to a client to help it select an account and credentials to use.  In some
27323 mechanisms, the client and server provably agree on the realm, but clients
27324 typically can not treat the realm as secure data to be blindly trusted.
27325
27326
27327
27328 .section "Generic options for authenticators" "SECID168"
27329 .cindex "authentication" "generic options"
27330 .cindex "options" "generic; for authenticators"
27331
27332 .option client_condition authenticators string&!! unset
27333 When Exim is authenticating as a client, it skips any authenticator whose
27334 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27335 used, for example, to skip plain text authenticators when the connection is not
27336 encrypted by a setting such as:
27337 .code
27338 client_condition = ${if !eq{$tls_out_cipher}{}}
27339 .endd
27340
27341
27342 .option client_set_id authenticators string&!! unset
27343 When client authentication succeeds, this condition is expanded; the
27344 result is used in the log lines for outbound messages.
27345 Typically it will be the user name used for authentication.
27346
27347
27348 .option driver authenticators string unset
27349 This option must always be set. It specifies which of the available
27350 authenticators is to be used.
27351
27352
27353 .option public_name authenticators string unset
27354 This option specifies the name of the authentication mechanism that the driver
27355 implements, and by which it is known to the outside world. These names should
27356 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27357 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27358 defaults to the driver's instance name.
27359
27360
27361 .option server_advertise_condition authenticators string&!! unset
27362 When a server is about to advertise an authentication mechanism, the condition
27363 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27364 mechanism is not advertised.
27365 If the expansion fails, the mechanism is not advertised. If the failure was not
27366 forced, and was not caused by a lookup defer, the incident is logged.
27367 See section &<<SECTauthexiser>>& below for further discussion.
27368
27369
27370 .option server_condition authenticators string&!! unset
27371 This option must be set for a &%plaintext%& server authenticator, where it
27372 is used directly to control authentication. See section &<<SECTplainserver>>&
27373 for details.
27374
27375 For the &(gsasl)& authenticator, this option is required for various
27376 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27377
27378 For the other authenticators, &%server_condition%& can be used as an additional
27379 authentication or authorization mechanism that is applied after the other
27380 authenticator conditions succeed. If it is set, it is expanded when the
27381 authenticator would otherwise return a success code. If the expansion is forced
27382 to fail, authentication fails. Any other expansion failure causes a temporary
27383 error code to be returned. If the result of a successful expansion is an empty
27384 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27385 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27386 other result, a temporary error code is returned, with the expanded string as
27387 the error text.
27388
27389
27390 .option server_debug_print authenticators string&!! unset
27391 If this option is set and authentication debugging is enabled (see the &%-d%&
27392 command line option), the string is expanded and included in the debugging
27393 output when the authenticator is run as a server. This can help with checking
27394 out the values of variables.
27395 If expansion of the string fails, the error message is written to the debugging
27396 output, and Exim carries on processing.
27397
27398
27399 .option server_set_id authenticators string&!! unset
27400 .vindex "&$authenticated_id$&"
27401 .vindex "&$authenticated_fail_id$&"
27402 When an Exim server successfully authenticates a client, this string is
27403 expanded using data from the authentication, and preserved for any incoming
27404 messages in the variable &$authenticated_id$&. It is also included in the log
27405 lines for incoming messages. For example, a user/password authenticator
27406 configuration might preserve the user name that was used to authenticate, and
27407 refer to it subsequently during delivery of the message.
27408 On a failing authentication the expansion result is instead saved in
27409 the &$authenticated_fail_id$& variable.
27410 If expansion fails, the option is ignored.
27411
27412
27413 .option server_mail_auth_condition authenticators string&!! unset
27414 This option allows a server to discard authenticated sender addresses supplied
27415 as part of MAIL commands in SMTP connections that are authenticated by the
27416 driver on which &%server_mail_auth_condition%& is set. The option is not used
27417 as part of the authentication process; instead its (unexpanded) value is
27418 remembered for later use.
27419 How it is used is described in the following section.
27420
27421
27422
27423
27424
27425 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27426 .cindex "authentication" "sender; authenticated"
27427 .cindex "AUTH" "on MAIL command"
27428 When a client supplied an AUTH= item on a MAIL command, Exim applies
27429 the following checks before accepting it as the authenticated sender of the
27430 message:
27431
27432 .ilist
27433 If the connection is not using extended SMTP (that is, HELO was used rather
27434 than EHLO), the use of AUTH= is a syntax error.
27435 .next
27436 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27437 .next
27438 .vindex "&$authenticated_sender$&"
27439 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27440 running, the value of &$authenticated_sender$& is set to the value obtained
27441 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27442 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27443 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27444 given for the MAIL command.
27445 .next
27446 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27447 is accepted and placed in &$authenticated_sender$& only if the client has
27448 authenticated.
27449 .next
27450 If the AUTH= value was accepted by either of the two previous rules, and
27451 the client has authenticated, and the authenticator has a setting for the
27452 &%server_mail_auth_condition%&, the condition is checked at this point. The
27453 valued that was saved from the authenticator is expanded. If the expansion
27454 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27455 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27456 the value of &$authenticated_sender$& is retained and passed on with the
27457 message.
27458 .endlist
27459
27460
27461 When &$authenticated_sender$& is set for a message, it is passed on to other
27462 hosts to which Exim authenticates as a client. Do not confuse this value with
27463 &$authenticated_id$&, which is a string obtained from the authentication
27464 process, and which is not usually a complete email address.
27465
27466 .vindex "&$sender_address$&"
27467 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27468 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27469 therefore make use of &$authenticated_sender$&. The converse is not true: the
27470 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27471 ACL is run.
27472
27473
27474
27475 .section "Authentication on an Exim server" "SECTauthexiser"
27476 .cindex "authentication" "on an Exim server"
27477 When Exim receives an EHLO command, it advertises the public names of those
27478 authenticators that are configured as servers, subject to the following
27479 conditions:
27480
27481 .ilist
27482 The client host must match &%auth_advertise_hosts%& (default *).
27483 .next
27484 If the &%server_advertise_condition%& option is set, its expansion must not
27485 yield the empty string, &"0"&, &"no"&, or &"false"&.
27486 .endlist
27487
27488 The order in which the authenticators are defined controls the order in which
27489 the mechanisms are advertised.
27490
27491 Some mail clients (for example, some versions of Netscape) require the user to
27492 provide a name and password for authentication whenever AUTH is advertised,
27493 even though authentication may not in fact be needed (for example, Exim may be
27494 set up to allow unconditional relaying from the client by an IP address check).
27495 You can make such clients more friendly by not advertising AUTH to them.
27496 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27497 that runs for RCPT) to relay without authentication, you should set
27498 .code
27499 auth_advertise_hosts = ! 10.9.8.0/24
27500 .endd
27501 so that no authentication mechanisms are advertised to them.
27502
27503 The &%server_advertise_condition%& controls the advertisement of individual
27504 authentication mechanisms. For example, it can be used to restrict the
27505 advertisement of a particular mechanism to encrypted connections, by a setting
27506 such as:
27507 .code
27508 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27509 .endd
27510 .vindex "&$tls_in_cipher$&"
27511 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27512 yields &"yes"&, which allows the advertisement to happen.
27513
27514 When an Exim server receives an AUTH command from a client, it rejects it
27515 immediately if AUTH was not advertised in response to an earlier EHLO
27516 command. This is the case if
27517
27518 .ilist
27519 The client host does not match &%auth_advertise_hosts%&; or
27520 .next
27521 No authenticators are configured with server options; or
27522 .next
27523 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27524 server authenticators.
27525 .endlist
27526
27527
27528 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27529 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27530 AUTH is accepted from any client host.
27531
27532 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27533 server authentication mechanism that was advertised in response to EHLO and
27534 that matches the one named in the AUTH command. If it finds one, it runs
27535 the appropriate authentication protocol, and authentication either succeeds or
27536 fails. If there is no matching advertised mechanism, the AUTH command is
27537 rejected with a 504 error.
27538
27539 .vindex "&$received_protocol$&"
27540 .vindex "&$sender_host_authenticated$&"
27541 When a message is received from an authenticated host, the value of
27542 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27543 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27544 public name) of the authenticator driver that successfully authenticated the
27545 client from which the message was received. This variable is empty if there was
27546 no successful authentication.
27547
27548 .cindex authentication "expansion item"
27549 Successful authentication sets up information used by the
27550 &%authresults%& expansion item.
27551
27552 .new
27553 .cindex authentication "failure event, server"
27554 If an authenticator is run and does not succeed,
27555 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27556 While the event is being processed the variables
27557 &$sender_host_authenticated$& (with the authenticator name)
27558 and &$authenticated_fail_id$& (as set by the authenticator &%server_set_id%& option)
27559 will be valid.
27560 If the event is serviced and a string is returned then the string will be logged
27561 instead of the default log line.
27562 See <<CHAPevents>> for details on events.
27563 .wen
27564
27565
27566 .section "Testing server authentication" "SECID169"
27567 .cindex "authentication" "testing a server"
27568 .cindex "AUTH" "testing a server"
27569 .cindex "base64 encoding" "creating authentication test data"
27570 Exim's &%-bh%& option can be useful for testing server authentication
27571 configurations. The data for the AUTH command has to be sent using base64
27572 encoding. A quick way to produce such data for testing is the following Perl
27573 script:
27574 .code
27575 use MIME::Base64;
27576 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27577 .endd
27578 .cindex "binary zero" "in authentication data"
27579 This interprets its argument as a Perl string, and then encodes it. The
27580 interpretation as a Perl string allows binary zeros, which are required for
27581 some kinds of authentication, to be included in the data. For example, a
27582 command line to run this script on such data might be
27583 .code
27584 encode '\0user\0password'
27585 .endd
27586 Note the use of single quotes to prevent the shell interpreting the
27587 backslashes, so that they can be interpreted by Perl to specify characters
27588 whose code value is zero.
27589
27590 &*Warning 1*&: If either of the user or password strings starts with an octal
27591 digit, you must use three zeros instead of one after the leading backslash. If
27592 you do not, the octal digit that starts your string will be incorrectly
27593 interpreted as part of the code for the first character.
27594
27595 &*Warning 2*&: If there are characters in the strings that Perl interprets
27596 specially, you must use a Perl escape to prevent them being misinterpreted. For
27597 example, a command such as
27598 .code
27599 encode '\0user@domain.com\0pas$$word'
27600 .endd
27601 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27602
27603 If you have the &%mimencode%& command installed, another way to produce
27604 base64-encoded strings is to run the command
27605 .code
27606 echo -e -n `\0user\0password' | mimencode
27607 .endd
27608 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27609 in the argument, and the &%-n%& option specifies no newline at the end of its
27610 output. However, not all versions of &%echo%& recognize these options, so you
27611 should check your version before relying on this suggestion.
27612
27613
27614
27615 .section "Authentication by an Exim client" "SECID170"
27616 .cindex "authentication" "on an Exim client"
27617 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27618 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27619 announces support for authentication, and the host matches an entry in either
27620 of these options, Exim (as a client) tries to authenticate as follows:
27621
27622 .ilist
27623 For each authenticator that is configured as a client, in the order in which
27624 they are defined in the configuration, it searches the authentication
27625 mechanisms announced by the server for one whose name matches the public name
27626 of the authenticator.
27627 .next
27628 .vindex "&$host$&"
27629 .vindex "&$host_address$&"
27630 When it finds one that matches, it runs the authenticator's client code. The
27631 variables &$host$& and &$host_address$& are available for any string expansions
27632 that the client might do. They are set to the server's name and IP address. If
27633 any expansion is forced to fail, the authentication attempt is abandoned, and
27634 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27635 delivery to be deferred.
27636 .next
27637 If the result of the authentication attempt is a temporary error or a timeout,
27638 Exim abandons trying to send the message to the host for the moment. It will
27639 try again later. If there are any backup hosts available, they are tried in the
27640 usual way.
27641
27642 .new
27643 .next
27644 .cindex authentication "failure event, client"
27645 If the response to authentication is a permanent error (5&'xx'& code),
27646 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27647 While the event is being processed the variable
27648 &$sender_host_authenticated$& (with the authenticator name)
27649 will be valid.
27650 If the event is serviced and a string is returned then the string will be logged.
27651 See <<CHAPevents>> for details on events.
27652 .wen
27653
27654 .next
27655 If the response to authentication is a permanent error (5&'xx'& code), Exim
27656 carries on searching the list of authenticators and tries another one if
27657 possible. If all authentication attempts give permanent errors, or if there are
27658 no attempts because no mechanisms match (or option expansions force failure),
27659 what happens depends on whether the host matches &%hosts_require_auth%& or
27660 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27661 delivery is deferred. The error can be detected in the retry rules, and thereby
27662 turned into a permanent error if you wish. In the second case, Exim tries to
27663 deliver the message unauthenticated.
27664 .endlist
27665
27666 Note that the hostlist test for whether to do authentication can be
27667 confused if name-IP lookups change between the time the peer is decided
27668 upon and the time that the transport runs.  For example, with a manualroute
27669 router given a host name, and with DNS "round-robin" used by that name: if
27670 the local resolver cache times out between the router and the transport
27671 running, the transport may get an IP for the name for its authentication
27672 check which does not match the connection peer IP.
27673 No authentication will then be done, despite the names being identical.
27674
27675 For such cases use a separate transport which always authenticates.
27676
27677 .cindex "AUTH" "on MAIL command"
27678 When Exim has authenticated itself to a remote server, it adds the AUTH
27679 parameter to the MAIL commands it sends, if it has an authenticated sender for
27680 the message. If the message came from a remote host, the authenticated sender
27681 is the one that was receiving on an incoming MAIL command, provided that the
27682 incoming connection was authenticated and the &%server_mail_auth%& condition
27683 allowed the authenticated sender to be retained. If a local process calls Exim
27684 to send a message, the sender address that is built from the login name and
27685 &%qualify_domain%& is treated as authenticated. However, if the
27686 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27687 the authenticated sender that was received with the message.
27688 .ecindex IIDauthconf1
27689 .ecindex IIDauthconf2
27690
27691
27692
27693
27694
27695
27696 . ////////////////////////////////////////////////////////////////////////////
27697 . ////////////////////////////////////////////////////////////////////////////
27698
27699 .chapter "The plaintext authenticator" "CHAPplaintext"
27700 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27701 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27702 The &(plaintext)& authenticator can be configured to support the PLAIN and
27703 LOGIN authentication mechanisms, both of which transfer authentication data as
27704 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27705 security risk; you are strongly advised to insist on the use of SMTP encryption
27706 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27707 use unencrypted plain text, you should not use the same passwords for SMTP
27708 connections as you do for login accounts.
27709
27710 .section "Avoiding cleartext use" "SECTplain_TLS"
27711 The following generic option settings will disable &(plaintext)& authenticators when
27712 TLS is not being used:
27713 .code
27714   server_advertise_condition = ${if def:tls_in_cipher }
27715   client_condition =           ${if def:tls_out_cipher}
27716 .endd
27717
27718 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27719 but is still vulnerable to a Man In The Middle attack unless certificates
27720 (including their names) have been properly verified.
27721
27722 .section "Plaintext server options" "SECID171"
27723 .cindex "options" "&(plaintext)& authenticator (server)"
27724 When configured as a server, &(plaintext)& uses the following options:
27725
27726 .option server_condition authenticators string&!! unset
27727 This is actually a global authentication option, but it must be set in order to
27728 configure the &(plaintext)& driver as a server. Its use is described below.
27729
27730 .option server_prompts plaintext "string list&!!" unset
27731 The contents of this option, after expansion, must be a colon-separated list of
27732 prompt strings. If expansion fails, a temporary authentication rejection is
27733 given.
27734
27735 .section "Using plaintext in a server" "SECTplainserver"
27736 .cindex "AUTH" "in &(plaintext)& authenticator"
27737 .cindex "binary zero" "in &(plaintext)& authenticator"
27738 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27739         "in &(plaintext)& authenticator"
27740 .vindex "&$auth1$&, &$auth2$&, etc"
27741 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27742
27743 When running as a server, &(plaintext)& performs the authentication test by
27744 expanding a string. The data sent by the client with the AUTH command, or in
27745 response to subsequent prompts, is base64 encoded, and so may contain any byte
27746 values when decoded. If any data is supplied with the command, it is treated as
27747 a list of strings, separated by NULs (binary zeros), the first three of which
27748 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27749 (neither LOGIN nor PLAIN uses more than three strings).
27750
27751 For compatibility with previous releases of Exim, the values are also placed in
27752 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27753 variables for this purpose is now deprecated, as it can lead to confusion in
27754 string expansions that also use them for other things.
27755
27756 If there are more strings in &%server_prompts%& than the number of strings
27757 supplied with the AUTH command, the remaining prompts are used to obtain more
27758 data. Each response from the client may be a list of NUL-separated strings.
27759
27760 .vindex "&$authenticated_id$&"
27761 Once a sufficient number of data strings have been received,
27762 &%server_condition%& is expanded. If the expansion is forced to fail,
27763 authentication fails. Any other expansion failure causes a temporary error code
27764 to be returned. If the result of a successful expansion is an empty string,
27765 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27766 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27767 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27768 For any other result, a temporary error code is returned, with the expanded
27769 string as the error text.
27770
27771 &*Warning*&: If you use a lookup in the expansion to find the user's
27772 password, be sure to make the authentication fail if the user is unknown.
27773 There are good and bad examples at the end of the next section.
27774
27775
27776
27777 .section "The PLAIN authentication mechanism" "SECID172"
27778 .cindex "PLAIN authentication mechanism"
27779 .cindex authentication PLAIN
27780 .cindex "binary zero" "in &(plaintext)& authenticator"
27781 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27782 sent as one item of data (that is, one combined string containing two NUL
27783 separators). The data is sent either as part of the AUTH command, or
27784 subsequently in response to an empty prompt from the server.
27785
27786 The second and third strings are a user name and a corresponding password.
27787 Using a single fixed user name and password as an example, this could be
27788 configured as follows:
27789 .code
27790 fixed_plain:
27791   driver = plaintext
27792   public_name = PLAIN
27793   server_prompts = :
27794   server_condition = \
27795     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27796   server_set_id = $auth2
27797 .endd
27798 Note that the default result strings from &%if%& (&"true"& or an empty string)
27799 are exactly what we want here, so they need not be specified. Obviously, if the
27800 password contains expansion-significant characters such as dollar, backslash,
27801 or closing brace, they have to be escaped.
27802
27803 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27804 the end of a string list are ignored). If all the data comes as part of the
27805 AUTH command, as is commonly the case, the prompt is not used. This
27806 authenticator is advertised in the response to EHLO as
27807 .code
27808 250-AUTH PLAIN
27809 .endd
27810 and a client host can authenticate itself by sending the command
27811 .code
27812 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27813 .endd
27814 As this contains three strings (more than the number of prompts), no further
27815 data is required from the client. Alternatively, the client may just send
27816 .code
27817 AUTH PLAIN
27818 .endd
27819 to initiate authentication, in which case the server replies with an empty
27820 prompt. The client must respond with the combined data string.
27821
27822 The data string is base64 encoded, as required by the RFC. This example,
27823 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27824 represents a zero byte. This is split up into three strings, the first of which
27825 is empty. The &%server_condition%& option in the authenticator checks that the
27826 second two are &`username`& and &`mysecret`& respectively.
27827
27828 Having just one fixed user name and password, as in this example, is not very
27829 realistic, though for a small organization with only a handful of
27830 authenticating clients it could make sense.
27831
27832 A more sophisticated instance of this authenticator could use the user name in
27833 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27834 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27835 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27836 This is an incorrect example:
27837 .code
27838 server_condition = \
27839   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27840 .endd
27841 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27842 which it then compares to the supplied password (&$auth3$&). Why is this example
27843 incorrect? It works fine for existing users, but consider what happens if a
27844 non-existent user name is given. The lookup fails, but as no success/failure
27845 strings are given for the lookup, it yields an empty string. Thus, to defeat
27846 the authentication, all a client has to do is to supply a non-existent user
27847 name and an empty password. The correct way of writing this test is:
27848 .code
27849 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27850   {${if eq{$value}{$auth3}}} {false}}
27851 .endd
27852 In this case, if the lookup succeeds, the result is checked; if the lookup
27853 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27854 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27855 always fails if its second argument is empty. However, the second way of
27856 writing the test makes the logic clearer.
27857
27858
27859 .section "The LOGIN authentication mechanism" "SECID173"
27860 .cindex "LOGIN authentication mechanism"
27861 .cindex authentication LOGIN
27862 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27863 in a number of programs. No data is sent with the AUTH command. Instead, a
27864 user name and password are supplied separately, in response to prompts. The
27865 plaintext authenticator can be configured to support this as in this example:
27866 .code
27867 fixed_login:
27868   driver = plaintext
27869   public_name = LOGIN
27870   server_prompts = User Name : Password
27871   server_condition = \
27872     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27873   server_set_id = $auth1
27874 .endd
27875 Because of the way plaintext operates, this authenticator accepts data supplied
27876 with the AUTH command (in contravention of the specification of LOGIN), but
27877 if the client does not supply it (as is the case for LOGIN clients), the prompt
27878 strings are used to obtain two data items.
27879
27880 Some clients are very particular about the precise text of the prompts. For
27881 example, Outlook Express is reported to recognize only &"Username:"& and
27882 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27883 strings. It uses the &%ldapauth%& expansion condition to check the user
27884 name and password by binding to an LDAP server:
27885 .code
27886 login:
27887   driver = plaintext
27888   public_name = LOGIN
27889   server_prompts = Username:: : Password::
27890   server_condition = ${if and{{ \
27891     !eq{}{$auth1} }{ \
27892     ldapauth{\
27893       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27894       pass=${quote:$auth2} \
27895       ldap://ldap.example.org/} }} }
27896   server_set_id = uid=$auth1,ou=people,o=example.org
27897 .endd
27898 We have to check that the username is not empty before using it, because LDAP
27899 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27900 operator to correctly quote the DN for authentication. However, the basic
27901 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27902 correct one to use for the password, because quoting is needed only to make
27903 the password conform to the Exim syntax. At the LDAP level, the password is an
27904 uninterpreted string.
27905
27906
27907 .section "Support for different kinds of authentication" "SECID174"
27908 A number of string expansion features are provided for the purpose of
27909 interfacing to different ways of user authentication. These include checking
27910 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27911 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27912 &<<SECTexpcond>>&.
27913
27914
27915
27916
27917 .section "Using plaintext in a client" "SECID175"
27918 .cindex "options" "&(plaintext)& authenticator (client)"
27919 The &(plaintext)& authenticator has two client options:
27920
27921 .option client_ignore_invalid_base64 plaintext boolean false
27922 If the client receives a server prompt that is not a valid base64 string,
27923 authentication is abandoned by default. However, if this option is set true,
27924 the error in the challenge is ignored and the client sends the response as
27925 usual.
27926
27927 .option client_send plaintext string&!! unset
27928 The string is a colon-separated list of authentication data strings. Each
27929 string is independently expanded before being sent to the server. The first
27930 string is sent with the AUTH command; any more strings are sent in response
27931 to prompts from the server. Before each string is expanded, the value of the
27932 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27933 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27934 way. Thus, the prompt that is received in response to sending the first string
27935 (with the AUTH command) can be used in the expansion of the second string, and
27936 so on. If an invalid base64 string is received when
27937 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27938 &$auth$&<&'n'&> variable.
27939
27940 &*Note*&: You cannot use expansion to create multiple strings, because
27941 splitting takes priority and happens first.
27942
27943 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27944 the data, further processing is applied to each string before it is sent. If
27945 there are any single circumflex characters in the string, they are converted to
27946 NULs. Should an actual circumflex be required as data, it must be doubled in
27947 the string.
27948
27949 This is an example of a client configuration that implements the PLAIN
27950 authentication mechanism with a fixed user name and password:
27951 .code
27952 fixed_plain:
27953   driver = plaintext
27954   public_name = PLAIN
27955   client_send = ^username^mysecret
27956 .endd
27957 The lack of colons means that the entire text is sent with the AUTH
27958 command, with the circumflex characters converted to NULs.
27959 Note that due to the ambiguity of parsing three consectutive circumflex characters
27960 there is no way to provide a password having a leading circumflex.
27961
27962
27963 A similar example
27964 that uses the LOGIN mechanism is:
27965 .code
27966 fixed_login:
27967   driver = plaintext
27968   public_name = LOGIN
27969   client_send = : username : mysecret
27970 .endd
27971 The initial colon means that the first string is empty, so no data is sent with
27972 the AUTH command itself. The remaining strings are sent in response to
27973 prompts.
27974 .ecindex IIDplaiauth1
27975 .ecindex IIDplaiauth2
27976
27977
27978
27979
27980 . ////////////////////////////////////////////////////////////////////////////
27981 . ////////////////////////////////////////////////////////////////////////////
27982
27983 .chapter "The cram_md5 authenticator" "CHID9"
27984 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27985 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27986 .cindex "CRAM-MD5 authentication mechanism"
27987 .cindex authentication CRAM-MD5
27988 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27989 sends a challenge string to the client, and the response consists of a user
27990 name and the CRAM-MD5 digest of the challenge string combined with a secret
27991 string (password) which is known to both server and client. Thus, the secret
27992 is not sent over the network as plain text, which makes this authenticator more
27993 secure than &(plaintext)&. However, the downside is that the secret has to be
27994 available in plain text at either end.
27995
27996
27997 .section "Using cram_md5 as a server" "SECID176"
27998 .cindex "options" "&(cram_md5)& authenticator (server)"
27999 This authenticator has one server option, which must be set to configure the
28000 authenticator as a server:
28001
28002 .option server_secret cram_md5 string&!! unset
28003 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
28004 When the server receives the client's response, the user name is placed in
28005 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
28006 obtain the password for that user. The server then computes the CRAM-MD5 digest
28007 that the client should have sent, and checks that it received the correct
28008 string. If the expansion of &%server_secret%& is forced to fail, authentication
28009 fails. If the expansion fails for some other reason, a temporary error code is
28010 returned to the client.
28011
28012 For compatibility with previous releases of Exim, the user name is also placed
28013 in &$1$&. However, the use of this variables for this purpose is now
28014 deprecated, as it can lead to confusion in string expansions that also use
28015 numeric variables for other things.
28016
28017 For example, the following authenticator checks that the user name given by the
28018 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
28019 user name, authentication fails.
28020 .code
28021 fixed_cram:
28022   driver = cram_md5
28023   public_name = CRAM-MD5
28024   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
28025   server_set_id = $auth1
28026 .endd
28027 .vindex "&$authenticated_id$&"
28028 If authentication succeeds, the setting of &%server_set_id%& preserves the user
28029 name in &$authenticated_id$&. A more typical configuration might look up the
28030 secret string in a file, using the user name as the key. For example:
28031 .code
28032 lookup_cram:
28033   driver = cram_md5
28034   public_name = CRAM-MD5
28035   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
28036                   {$value}fail}
28037   server_set_id = $auth1
28038 .endd
28039 Note that this expansion explicitly forces failure if the lookup fails
28040 because &$auth1$& contains an unknown user name.
28041
28042 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
28043 using the relevant libraries, you need to know the realm to specify in the
28044 lookup and then ask for the &"userPassword"& attribute for that user in that
28045 realm, with:
28046 .code
28047 cyrusless_crammd5:
28048   driver = cram_md5
28049   public_name = CRAM-MD5
28050   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
28051                   dbmjz{/etc/sasldb2}{$value}fail}
28052   server_set_id = $auth1
28053 .endd
28054
28055 .section "Using cram_md5 as a client" "SECID177"
28056 .cindex "options" "&(cram_md5)& authenticator (client)"
28057 When used as a client, the &(cram_md5)& authenticator has two options:
28058
28059
28060
28061 .option client_name cram_md5 string&!! "the primary host name"
28062 This string is expanded, and the result used as the user name data when
28063 computing the response to the server's challenge.
28064
28065
28066 .option client_secret cram_md5 string&!! unset
28067 This option must be set for the authenticator to work as a client. Its value is
28068 expanded and the result used as the secret string when computing the response.
28069
28070
28071 .vindex "&$host$&"
28072 .vindex "&$host_address$&"
28073 Different user names and secrets can be used for different servers by referring
28074 to &$host$& or &$host_address$& in the options. Forced failure of either
28075 expansion string is treated as an indication that this authenticator is not
28076 prepared to handle this case. Exim moves on to the next configured client
28077 authenticator. Any other expansion failure causes Exim to give up trying to
28078 send the message to the current server.
28079
28080 A simple example configuration of a &(cram_md5)& authenticator, using fixed
28081 strings, is:
28082 .code
28083 fixed_cram:
28084   driver = cram_md5
28085   public_name = CRAM-MD5
28086   client_name = ph10
28087   client_secret = secret
28088 .endd
28089 .ecindex IIDcramauth1
28090 .ecindex IIDcramauth2
28091
28092
28093
28094 . ////////////////////////////////////////////////////////////////////////////
28095 . ////////////////////////////////////////////////////////////////////////////
28096
28097 .chapter "The cyrus_sasl authenticator" "CHID10"
28098 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
28099 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
28100 .cindex "Cyrus" "SASL library"
28101 .cindex "Kerberos"
28102 The code for this authenticator was provided by Matthew Byng-Maddick while
28103 at A L Digital Ltd.
28104
28105 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
28106 library implementation of the RFC 2222 (&"Simple Authentication and Security
28107 Layer"&). This library supports a number of authentication mechanisms,
28108 including PLAIN and LOGIN, but also several others that Exim does not support
28109 directly. In particular, there is support for Kerberos authentication.
28110
28111 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
28112 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
28113 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
28114 name of the driver to determine which mechanism to support.
28115
28116 Where access to some kind of secret file is required, for example, in GSSAPI
28117 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
28118 user, and that the Cyrus SASL library has no way of escalating privileges
28119 by default. You may also find you need to set environment variables,
28120 depending on the driver you are using.
28121
28122 The application name provided by Exim is &"exim"&, so various SASL options may
28123 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
28124 Kerberos, note that because of limitations in the GSSAPI interface,
28125 changing the server keytab might need to be communicated down to the Kerberos
28126 layer independently. The mechanism for doing so is dependent upon the Kerberos
28127 implementation.
28128
28129 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
28130 may be set to point to an alternative keytab file. Exim will pass this
28131 variable through from its own inherited environment when started as root or the
28132 Exim user. The keytab file needs to be readable by the Exim user.
28133 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
28134 environment variable.  In practice, for those releases, the Cyrus authenticator
28135 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28136 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28137
28138
28139 .section "Using cyrus_sasl as a server" "SECID178"
28140 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28141 (on a successful authentication) into &$auth1$&. For compatibility with
28142 previous releases of Exim, the username is also placed in &$1$&. However, the
28143 use of this variable for this purpose is now deprecated, as it can lead to
28144 confusion in string expansions that also use numeric variables for other
28145 things.
28146
28147
28148 .option server_hostname cyrus_sasl string&!! "see below"
28149 This option selects the hostname that is used when communicating with the
28150 library. The default value is &`$primary_hostname`&. It is up to the underlying
28151 SASL plug-in what it does with this data.
28152
28153
28154 .option server_mech cyrus_sasl string "see below"
28155 This option selects the authentication mechanism this driver should use. The
28156 default is the value of the generic &%public_name%& option. This option allows
28157 you to use a different underlying mechanism from the advertised name. For
28158 example:
28159 .code
28160 sasl:
28161   driver = cyrus_sasl
28162   public_name = X-ANYTHING
28163   server_mech = CRAM-MD5
28164   server_set_id = $auth1
28165 .endd
28166
28167 .option server_realm cyrus_sasl string&!! unset
28168 This specifies the SASL realm that the server claims to be in.
28169
28170
28171 .option server_service cyrus_sasl string &`smtp`&
28172 This is the SASL service that the server claims to implement.
28173
28174
28175 For straightforward cases, you do not need to set any of the authenticator's
28176 private options. All you need to do is to specify an appropriate mechanism as
28177 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28178 PLAIN, you could have two authenticators as follows:
28179 .code
28180 sasl_cram_md5:
28181   driver = cyrus_sasl
28182   public_name = CRAM-MD5
28183   server_set_id = $auth1
28184
28185 sasl_plain:
28186   driver = cyrus_sasl
28187   public_name = PLAIN
28188   server_set_id = $auth2
28189 .endd
28190 Cyrus SASL does implement the LOGIN authentication method, even though it is
28191 not a standard method. It is disabled by default in the source distribution,
28192 but it is present in many binary distributions.
28193 .ecindex IIDcyrauth1
28194 .ecindex IIDcyrauth2
28195
28196
28197
28198
28199 . ////////////////////////////////////////////////////////////////////////////
28200 . ////////////////////////////////////////////////////////////////////////////
28201 .chapter "The dovecot authenticator" "CHAPdovecot"
28202 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28203 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28204 This authenticator is an interface to the authentication facility of the
28205 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28206 Note that Dovecot must be configured to use auth-client not auth-userdb.
28207 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28208 to use the same mechanisms for SMTP authentication. This is a server
28209 authenticator only. There is only one option:
28210
28211 .option server_socket dovecot string unset
28212
28213 This option must specify the UNIX socket that is the interface to Dovecot
28214 authentication. The &%public_name%& option must specify an authentication
28215 mechanism that Dovecot is configured to support. You can have several
28216 authenticators for different mechanisms. For example:
28217 .code
28218 dovecot_plain:
28219   driver = dovecot
28220   public_name = PLAIN
28221   server_socket = /var/run/dovecot/auth-client
28222   server_set_id = $auth1
28223
28224 dovecot_ntlm:
28225   driver = dovecot
28226   public_name = NTLM
28227   server_socket = /var/run/dovecot/auth-client
28228   server_set_id = $auth1
28229 .endd
28230 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28231 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28232 option is passed in the Dovecot authentication command. If, for a TLS
28233 connection, a client certificate has been verified, the &"valid-client-cert"&
28234 option is passed. When authentication succeeds, the identity of the user
28235 who authenticated is placed in &$auth1$&.
28236
28237 The Dovecot configuration to match the above will look
28238 something like:
28239 .code
28240 conf.d/10-master.conf :-
28241
28242 service auth {
28243 ...
28244 #SASL
28245   unix_listener auth-client {
28246     mode = 0660
28247     user = mail
28248   }
28249 ...
28250 }
28251
28252 conf.d/10-auth.conf :-
28253
28254 auth_mechanisms = plain login ntlm
28255 .endd
28256
28257 .ecindex IIDdcotauth1
28258 .ecindex IIDdcotauth2
28259
28260
28261 . ////////////////////////////////////////////////////////////////////////////
28262 . ////////////////////////////////////////////////////////////////////////////
28263 .chapter "The gsasl authenticator" "CHAPgsasl"
28264 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28265 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28266 .cindex "authentication" "GNU SASL"
28267 .cindex "authentication" "SASL"
28268 .cindex "authentication" "EXTERNAL"
28269 .cindex "authentication" "ANONYMOUS"
28270 .cindex "authentication" "PLAIN"
28271 .cindex "authentication" "LOGIN"
28272 .cindex "authentication" "DIGEST-MD5"
28273 .cindex "authentication" "CRAM-MD5"
28274 .cindex "authentication" "SCRAM family"
28275 The &(gsasl)& authenticator provides integration for the GNU SASL
28276 library and the mechanisms it provides.  This is new as of the 4.80 release
28277 and there are a few areas where the library does not let Exim smoothly
28278 scale to handle future authentication mechanisms, so no guarantee can be
28279 made that any particular new authentication mechanism will be supported
28280 without code changes in Exim.
28281
28282 The library is expected to add support in an upcoming
28283 realease for the SCRAM-SHA-256 method.
28284 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28285 when this happens.
28286
28287 To see the list of mechanisms supported by the library run Exim with "auth" debug
28288 enabled and look for a line containing "GNU SASL supports".
28289 Note however that some may not have been tested from Exim.
28290
28291
28292 .option client_authz gsasl string&!! unset
28293 This option can be used to supply an &'authorization id'&
28294 which is different to the &'authentication_id'& provided
28295 by &%client_username%& option.
28296 If unset or (after expansion) empty it is not used,
28297 which is the common case.
28298
28299 .option client_channelbinding gsasl boolean false
28300 See &%server_channelbinding%& below.
28301
28302 .option client_password gsasl string&!! unset
28303 This option is exapanded before use, and should result in
28304 the password to be used, in clear.
28305
28306 .option client_username gsasl string&!! unset
28307 This option is exapanded before use, and should result in
28308 the account name to be used.
28309
28310
28311 .option client_spassword gsasl string&!! unset
28312 This option is only supported for library versions 1.9.1 and greater.
28313 The macro _HAVE_AUTH_GSASL_SCRAM_S_KEY will be defined when this is so.
28314
28315 If a SCRAM mechanism is being used and this option is set
28316 and correctly sized
28317 it is used in preference to &%client_password%&.
28318 The value after expansion should be
28319 a 40 (for SHA-1) or 64 (for SHA-256) character string
28320 with the PBKDF2-prepared password, hex-encoded.
28321
28322 Note that this value will depend on the salt and iteration-count
28323 supplied by the server.
28324 The option is expanded before use.
28325 During the expansion &$auth1$& is set with the client username,
28326 &$auth2$& with the iteration count, and
28327 &$auth3$& with the salt.
28328
28329 The intent of this option
28330 is to support clients that can cache thes salted password
28331 to save on recalculation costs.
28332 The cache lookup should return an unusable value
28333 (eg. an empty string)
28334 if the salt or iteration count has changed
28335
28336 If the authentication succeeds then the above variables are set,
28337 .vindex "&$auth4$&"
28338 plus the calculated salted password value value in &$auth4$&,
28339 during the expansion of the &%client_set_id%& option.
28340 A side-effect of this expansion can be used to prime the cache.
28341
28342
28343 .option server_channelbinding gsasl boolean false
28344 Some authentication mechanisms are able to use external context at both ends
28345 of the session to bind the authentication to that context, and fail the
28346 authentication process if that context differs.  Specifically, some TLS
28347 ciphersuites can provide identifying information about the cryptographic
28348 context.
28349
28350 This should have meant that certificate identity and verification becomes a
28351 non-issue, as a man-in-the-middle attack will cause the correct client and
28352 server to see different identifiers and authentication will fail.
28353
28354 This is
28355 only usable by mechanisms which support "channel binding"; at time of
28356 writing, that's the SCRAM family.
28357 When using this feature the "-PLUS" variants of the method names need to be used.
28358
28359 This defaults off to ensure smooth upgrade across Exim releases, in case
28360 this option causes some clients to start failing.  Some future release
28361 of Exim might have switched the default to be true.
28362
28363 . However, Channel Binding in TLS has proven to be vulnerable in current versions.
28364 . Do not plan to rely upon this feature for security, ever, without consulting
28365 . with a subject matter expert (a cryptographic engineer).
28366
28367 This option was deprecated in previous releases due to doubts over
28368 the "Triple Handshake" vulnerability.
28369 Exim takes suitable precausions (requiring Extended Master Secret if TLS
28370 Session Resumption was used) for safety.
28371
28372
28373 .option server_hostname gsasl string&!! "see below"
28374 This option selects the hostname that is used when communicating with the
28375 library. The default value is &`$primary_hostname`&.
28376 Some mechanisms will use this data.
28377
28378
28379 .option server_mech gsasl string "see below"
28380 This option selects the authentication mechanism this driver should use. The
28381 default is the value of the generic &%public_name%& option. This option allows
28382 you to use a different underlying mechanism from the advertised name. For
28383 example:
28384 .code
28385 sasl:
28386   driver = gsasl
28387   public_name = X-ANYTHING
28388   server_mech = CRAM-MD5
28389   server_set_id = $auth1
28390 .endd
28391
28392
28393 .option server_password gsasl string&!! unset
28394 Various mechanisms need access to the cleartext password on the server, so
28395 that proof-of-possession can be demonstrated on the wire, without sending
28396 the password itself.
28397
28398 The data available for lookup varies per mechanism.
28399 In all cases, &$auth1$& is set to the &'authentication id'&.
28400 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28401 if available, else the empty string.
28402 The &$auth3$& variable will always be the &'realm'& if available,
28403 else the empty string.
28404
28405 A forced failure will cause authentication to defer.
28406
28407 If using this option, it may make sense to set the &%server_condition%&
28408 option to be simply "true".
28409
28410
28411 .option server_realm gsasl string&!! unset
28412 This specifies the SASL realm that the server claims to be in.
28413 Some mechanisms will use this data.
28414
28415
28416 .option server_scram_iter gsasl string&!! 4096
28417 This option provides data for the SCRAM family of mechanisms.
28418 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28419 when this option is expanded.
28420
28421 The result of expansion should be a decimal number,
28422 and represents both a lower-bound on the security, and
28423 a compute cost factor imposed on the client
28424 (if it does not cache results, or the server changes
28425 either the iteration count or the salt).
28426 A minimum value of 4096 is required by the standards
28427 for all current SCRAM mechanism variants.
28428
28429 .option server_scram_salt gsasl string&!! unset
28430 This option provides data for the SCRAM family of mechanisms.
28431 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28432 when this option is expanded.
28433 The value should be a base64-encoded string,
28434 of random data typically 4-to-16 bytes long.
28435 If unset or empty after expansion the library will provides a value for the
28436 protocol conversation.
28437
28438
28439 .option server_key gsasl string&!! unset
28440 .option server_skey gsasl string&!! unset
28441 These options can be used for the SCRAM family of mechanisms
28442 to provide stored information related to a password,
28443 the storage of which is preferable to plaintext.
28444
28445 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28446 &%server_skey%& is StoredKey.
28447
28448 They are only available for version 1.9.0 (or later) of the gsasl library.
28449 When this is so, the macros
28450 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28451 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28452 will be defined.
28453
28454 The &$authN$& variables are available when these options are expanded.
28455
28456 If set, the results of expansion should for each
28457 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28458 of base64-coded data, and will be used in preference to the
28459 &%server_password%& option.
28460 If unset or not of the right length, &%server_password%& will be used.
28461
28462 The libgsasl library release includes a utility &'gsasl'& which can be used
28463 to generate these values.
28464
28465
28466 .option server_service gsasl string &`smtp`&
28467 This is the SASL service that the server claims to implement.
28468 Some mechanisms will use this data.
28469
28470
28471 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28472 .vindex "&$auth1$&, &$auth2$&, etc"
28473 These may be set when evaluating specific options, as detailed above.
28474 They will also be set when evaluating &%server_condition%&.
28475
28476 Unless otherwise stated below, the &(gsasl)& integration will use the following
28477 meanings for these variables:
28478
28479 .ilist
28480 .vindex "&$auth1$&"
28481 &$auth1$&: the &'authentication id'&
28482 .next
28483 .vindex "&$auth2$&"
28484 &$auth2$&: the &'authorization id'&
28485 .next
28486 .vindex "&$auth3$&"
28487 &$auth3$&: the &'realm'&
28488 .endlist
28489
28490 On a per-mechanism basis:
28491
28492 .ilist
28493 .cindex "authentication" "EXTERNAL"
28494 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28495 the &%server_condition%& option must be present.
28496 .next
28497 .cindex "authentication" "ANONYMOUS"
28498 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28499 the &%server_condition%& option must be present.
28500 .next
28501 .cindex "authentication" "GSSAPI"
28502 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28503 &$auth2$& will be set to the &'authorization id'&,
28504 the &%server_condition%& option must be present.
28505 .endlist
28506
28507 An &'anonymous token'& is something passed along as an unauthenticated
28508 identifier; this is analogous to FTP anonymous authentication passing an
28509 email address, or software-identifier@, as the "password".
28510
28511
28512 An example showing the password having the realm specified in the callback
28513 and demonstrating a Cyrus SASL to GSASL migration approach is:
28514 .code
28515 gsasl_cyrusless_crammd5:
28516   driver = gsasl
28517   public_name = CRAM-MD5
28518   server_realm = imap.example.org
28519   server_password = ${lookup{$auth1:$auth3:userPassword}\
28520                     dbmjz{/etc/sasldb2}{$value}fail}
28521   server_set_id = ${quote:$auth1}
28522   server_condition = yes
28523 .endd
28524
28525
28526 . ////////////////////////////////////////////////////////////////////////////
28527 . ////////////////////////////////////////////////////////////////////////////
28528
28529 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28530 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28531 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28532 .cindex "authentication" "GSSAPI"
28533 .cindex "authentication" "Kerberos"
28534 The &(heimdal_gssapi)& authenticator provides server integration for the
28535 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28536 reliably.
28537
28538 .option server_hostname heimdal_gssapi string&!! "see below"
28539 This option selects the hostname that is used, with &%server_service%&,
28540 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28541 identifier.  The default value is &`$primary_hostname`&.
28542
28543 .option server_keytab heimdal_gssapi string&!! unset
28544 If set, then Heimdal will not use the system default keytab (typically
28545 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28546 The value should be a pathname, with no &"file:"& prefix.
28547
28548 .option server_service heimdal_gssapi string&!! "smtp"
28549 This option specifies the service identifier used, in conjunction with
28550 &%server_hostname%&, for building the identifier for finding credentials
28551 from the keytab.
28552
28553
28554 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28555 Beware that these variables will typically include a realm, thus will appear
28556 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28557 not verified, so a malicious client can set it to anything.
28558
28559 The &$auth1$& field should be safely trustable as a value from the Key
28560 Distribution Center.  Note that these are not quite email addresses.
28561 Each identifier is for a role, and so the left-hand-side may include a
28562 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28563
28564 .vindex "&$auth1$&, &$auth2$&, etc"
28565 .ilist
28566 .vindex "&$auth1$&"
28567 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28568 .next
28569 .vindex "&$auth2$&"
28570 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28571 authentication.  If that was empty, this will also be set to the
28572 GSS Display Name.
28573 .endlist
28574
28575
28576 . ////////////////////////////////////////////////////////////////////////////
28577 . ////////////////////////////////////////////////////////////////////////////
28578
28579 .chapter "The spa authenticator" "CHAPspa"
28580 .scindex IIDspaauth1 "&(spa)& authenticator"
28581 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28582 .cindex "authentication" "Microsoft Secure Password"
28583 .cindex "authentication" "NTLM"
28584 .cindex "Microsoft Secure Password Authentication"
28585 .cindex "NTLM authentication"
28586 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28587 Password Authentication'& mechanism,
28588 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28589 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28590 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28591 server side was subsequently contributed by Tom Kistner. The mechanism works as
28592 follows:
28593
28594 .ilist
28595 After the AUTH command has been accepted, the client sends an SPA
28596 authentication request based on the user name and optional domain.
28597 .next
28598 The server sends back a challenge.
28599 .next
28600 The client builds a challenge response which makes use of the user's password
28601 and sends it to the server, which then accepts or rejects it.
28602 .endlist
28603
28604 Encryption is used to protect the password in transit.
28605
28606
28607
28608 .section "Using spa as a server" "SECID179"
28609 .cindex "options" "&(spa)& authenticator (server)"
28610 The &(spa)& authenticator has just one server option:
28611
28612 .option server_password spa string&!! unset
28613 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28614 This option is expanded, and the result must be the cleartext password for the
28615 authenticating user, whose name is at this point in &$auth1$&. For
28616 compatibility with previous releases of Exim, the user name is also placed in
28617 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28618 it can lead to confusion in string expansions that also use numeric variables
28619 for other things. For example:
28620 .code
28621 spa:
28622   driver = spa
28623   public_name = NTLM
28624   server_password = \
28625     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28626 .endd
28627 If the expansion is forced to fail, authentication fails. Any other expansion
28628 failure causes a temporary error code to be returned.
28629
28630
28631
28632
28633
28634 .section "Using spa as a client" "SECID180"
28635 .cindex "options" "&(spa)& authenticator (client)"
28636 The &(spa)& authenticator has the following client options:
28637
28638
28639
28640 .option client_domain spa string&!! unset
28641 This option specifies an optional domain for the authentication.
28642
28643
28644 .option client_password spa string&!! unset
28645 This option specifies the user's password, and must be set.
28646
28647
28648 .option client_username spa string&!! unset
28649 This option specifies the user name, and must be set. Here is an example of a
28650 configuration of this authenticator for use with the mail servers at
28651 &'msn.com'&:
28652 .code
28653 msn:
28654   driver = spa
28655   public_name = MSN
28656   client_username = msn/msn_username
28657   client_password = msn_plaintext_password
28658   client_domain = DOMAIN_OR_UNSET
28659 .endd
28660 .ecindex IIDspaauth1
28661 .ecindex IIDspaauth2
28662
28663
28664
28665
28666
28667 . ////////////////////////////////////////////////////////////////////////////
28668 . ////////////////////////////////////////////////////////////////////////////
28669
28670 .chapter "The external authenticator" "CHAPexternauth"
28671 .scindex IIDexternauth1 "&(external)& authenticator"
28672 .scindex IIDexternauth2 "authenticators" "&(external)&"
28673 .cindex "authentication" "Client Certificate"
28674 .cindex "authentication" "X509"
28675 .cindex "Certificate-based authentication"
28676 The &(external)& authenticator provides support for
28677 authentication based on non-SMTP information.
28678 The specification is in RFC 4422 Appendix A
28679 (&url(https://tools.ietf.org/html/rfc4422)).
28680 It is only a transport and negotiation mechanism;
28681 the process of authentication is entirely controlled
28682 by the server configuration.
28683
28684 The client presents an identity in-clear.
28685 It is probably wise for a server to only advertise,
28686 and for clients to only attempt,
28687 this authentication method on a secure (eg. under TLS) connection.
28688
28689 One possible use, compatible with the
28690 K-9 Mail Android client (&url(https://k9mail.github.io/)),
28691 is for using X509 client certificates.
28692
28693 It thus overlaps in function with the TLS authenticator
28694 (see &<<CHAPtlsauth>>&)
28695 but is a full SMTP SASL authenticator
28696 rather than being implicit for TLS-connection carried
28697 client certificates only.
28698
28699 The examples and discussion in this chapter assume that
28700 client-certificate authentication is being done.
28701
28702 The client must present a certificate,
28703 for which it must have been requested via the
28704 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28705 (see &<<CHAPTLS>>&).
28706 For authentication to be effective the certificate should be
28707 verifiable against a trust-anchor certificate known to the server.
28708
28709 .section "External options" "SECTexternsoptions"
28710 .cindex "options" "&(external)& authenticator (server)"
28711 The &(external)& authenticator has two server options:
28712
28713 .option server_param2 external string&!! unset
28714 .option server_param3 external string&!! unset
28715 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28716 These options are expanded before the &%server_condition%& option
28717 and the result are placed in &$auth2$& and &$auth3$& resectively.
28718 If the expansion is forced to fail, authentication fails. Any other expansion
28719 failure causes a temporary error code to be returned.
28720
28721 They can be used to clarify the coding of a complex &%server_condition%&.
28722
28723 .section "Using external in a server" "SECTexternserver"
28724 .cindex "AUTH" "in &(external)& authenticator"
28725 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28726         "in &(external)& authenticator"
28727 .vindex "&$auth1$&, &$auth2$&, etc"
28728 .cindex "base64 encoding" "in &(external)& authenticator"
28729
28730 When running as a server, &(external)& performs the authentication test by
28731 expanding a string. The data sent by the client with the AUTH command, or in
28732 response to subsequent prompts, is base64 encoded, and so may contain any byte
28733 values when decoded. The decoded value is treated as
28734 an identity for authentication and
28735 placed in the expansion variable &$auth1$&.
28736
28737 For compatibility with previous releases of Exim, the value is also placed in
28738 the expansion variable &$1$&. However, the use of this
28739 variable for this purpose is now deprecated, as it can lead to confusion in
28740 string expansions that also use them for other things.
28741
28742 .vindex "&$authenticated_id$&"
28743 Once an identity has been received,
28744 &%server_condition%& is expanded. If the expansion is forced to fail,
28745 authentication fails. Any other expansion failure causes a temporary error code
28746 to be returned. If the result of a successful expansion is an empty string,
28747 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28748 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28749 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28750 For any other result, a temporary error code is returned, with the expanded
28751 string as the error text.
28752
28753 Example:
28754 .code
28755 ext_ccert_san_mail:
28756   driver =            external
28757   public_name =       EXTERNAL
28758
28759   server_advertise_condition = $tls_in_certificate_verified
28760   server_param2 =     ${certextract {subj_altname,mail,>:} \
28761                                     {$tls_in_peercert}}
28762   server_condition =  ${if forany {$auth2} \
28763                             {eq {$item}{$auth1}}}
28764   server_set_id =     $auth1
28765 .endd
28766 This accepts a client certificate that is verifiable against any
28767 of your configured trust-anchors
28768 (which usually means the full set of public CAs)
28769 and which has a mail-SAN matching the claimed identity sent by the client.
28770
28771 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28772 The account name is therefore guessable by an opponent.
28773 TLS 1.3 protects both server and client certificates, and is not vulnerable
28774 in this way.
28775
28776
28777 .section "Using external in a client" "SECTexternclient"
28778 .cindex "options" "&(external)& authenticator (client)"
28779 The &(external)& authenticator has one client option:
28780
28781 .option client_send external string&!! unset
28782 This option is expanded and sent with the AUTH command as the
28783 identity being asserted.
28784
28785 Example:
28786 .code
28787 ext_ccert:
28788   driver =      external
28789   public_name = EXTERNAL
28790
28791   client_condition = ${if !eq{$tls_out_cipher}{}}
28792   client_send = myaccount@smarthost.example.net
28793 .endd
28794
28795
28796 .ecindex IIDexternauth1
28797 .ecindex IIDexternauth2
28798
28799
28800
28801
28802
28803 . ////////////////////////////////////////////////////////////////////////////
28804 . ////////////////////////////////////////////////////////////////////////////
28805
28806 .chapter "The tls authenticator" "CHAPtlsauth"
28807 .scindex IIDtlsauth1 "&(tls)& authenticator"
28808 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28809 .cindex "authentication" "Client Certificate"
28810 .cindex "authentication" "X509"
28811 .cindex "Certificate-based authentication"
28812 The &(tls)& authenticator provides server support for
28813 authentication based on client certificates.
28814
28815 It is not an SMTP authentication mechanism and is not
28816 advertised by the server as part of the SMTP EHLO response.
28817 It is an Exim authenticator in the sense that it affects
28818 the protocol element of the log line, can be tested for
28819 by the &%authenticated%& ACL condition, and can set
28820 the &$authenticated_id$& variable.
28821
28822 The client must present a verifiable certificate,
28823 for which it must have been requested via the
28824 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28825 (see &<<CHAPTLS>>&).
28826
28827 If an authenticator of this type is configured it is
28828 run before any SMTP-level communication is done,
28829 and can authenticate the connection.
28830 If it does, SMTP authentication is not offered.
28831
28832 A maximum of one authenticator of this type may be present.
28833
28834
28835 .cindex "options" "&(tls)& authenticator (server)"
28836 The &(tls)& authenticator has three server options:
28837
28838 .option server_param1 tls string&!! unset
28839 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28840 This option is expanded after the TLS negotiation and
28841 the result is placed in &$auth1$&.
28842 If the expansion is forced to fail, authentication fails. Any other expansion
28843 failure causes a temporary error code to be returned.
28844
28845 .option server_param2 tls string&!! unset
28846 .option server_param3 tls string&!! unset
28847 As above, for &$auth2$& and &$auth3$&.
28848
28849 &%server_param1%& may also be spelled &%server_param%&.
28850
28851
28852 Example:
28853 .code
28854 tls:
28855   driver = tls
28856   server_param1 =     ${certextract {subj_altname,mail,>:} \
28857                                     {$tls_in_peercert}}
28858   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28859                                  {forany {$auth1} \
28860                             {!= {0} \
28861                                 {${lookup ldap{ldap:///\
28862                          mailname=${quote_ldap_dn:${lc:$item}},\
28863                          ou=users,LDAP_DC?mailid} {$value}{0} \
28864                        }    }  } }}}
28865   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28866 .endd
28867 This accepts a client certificate that is verifiable against any
28868 of your configured trust-anchors
28869 (which usually means the full set of public CAs)
28870 and which has a SAN with a good account name.
28871
28872 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28873 The account name is therefore guessable by an opponent.
28874 TLS 1.3 protects both server and client certificates, and is not vulnerable
28875 in this way.
28876 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28877
28878 . An alternative might use
28879 . .code
28880 .   server_param1 = ${sha256:$tls_in_peercert}
28881 . .endd
28882 . to require one of a set of specific certs that define a given account
28883 . (the verification is still required, but mostly irrelevant).
28884 . This would help for per-device use.
28885 .
28886 . However, for the future we really need support for checking a
28887 . user cert in LDAP - which probably wants a base-64 DER.
28888
28889 .ecindex IIDtlsauth1
28890 .ecindex IIDtlsauth2
28891
28892
28893 Note that because authentication is traditionally an SMTP operation,
28894 the &%authenticated%& ACL condition cannot be used in
28895 a connect- or helo-ACL.
28896
28897
28898
28899 . ////////////////////////////////////////////////////////////////////////////
28900 . ////////////////////////////////////////////////////////////////////////////
28901
28902 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28903          "Encrypted SMTP connections"
28904 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28905 .scindex IIDencsmtp2 "SMTP" "encryption"
28906 .cindex "TLS" "on SMTP connection"
28907 .cindex "OpenSSL"
28908 .cindex "GnuTLS"
28909 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28910 Sockets Layer), is implemented by making use of the OpenSSL library or the
28911 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28912 cryptographic code in the Exim distribution itself for implementing TLS. In
28913 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28914 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28915 You also need to understand the basic concepts of encryption at a managerial
28916 level, and in particular, the way that public keys, private keys, and
28917 certificates are used.
28918
28919 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28920 connection is established, the client issues a STARTTLS command. If the
28921 server accepts this, the client and the server negotiate an encryption
28922 mechanism. If the negotiation succeeds, the data that subsequently passes
28923 between them is encrypted.
28924
28925 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28926 and if so, what cipher suite is in use, whether the client supplied a
28927 certificate, and whether or not that certificate was verified. This makes it
28928 possible for an Exim server to deny or accept certain commands based on the
28929 encryption state.
28930
28931 &*Warning*&: Certain types of firewall and certain anti-virus products can
28932 disrupt TLS connections. You need to turn off SMTP scanning for these products
28933 in order to get TLS to work.
28934
28935
28936
28937 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28938          "SECID284"
28939 .cindex "submissions protocol"
28940 .cindex "ssmtp protocol"
28941 .cindex "smtps protocol"
28942 .cindex "SMTP" "submissions protocol"
28943 .cindex "SMTP" "ssmtp protocol"
28944 .cindex "SMTP" "smtps protocol"
28945 The history of port numbers for TLS in SMTP is a little messy and has been
28946 contentious.  As of RFC 8314, the common practice of using the historically
28947 allocated port 465 for "email submission but with TLS immediately upon connect
28948 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28949 by them in preference to STARTTLS.
28950
28951 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28952 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28953 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28954
28955 This approach was, for a while, officially abandoned when encrypted SMTP was
28956 standardized, but many clients kept using it, even as the TCP port number was
28957 reassigned for other use.
28958 Thus you may encounter guidance claiming that you shouldn't enable use of
28959 this port.
28960 In practice, a number of mail-clients have only ever supported submissions,
28961 not submission with STARTTLS upgrade.
28962 Ideally, offer both submission (587) and submissions (465) service.
28963
28964 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28965 global option. Its value must be a list of port numbers;
28966 the most common use is expected to be:
28967 .code
28968 tls_on_connect_ports = 465
28969 .endd
28970 The port numbers specified by this option apply to all SMTP connections, both
28971 via the daemon and via &'inetd'&. You still need to specify all the ports that
28972 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28973 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28974 an extra port &-- rather, it specifies different behaviour on a port that is
28975 defined elsewhere.
28976
28977 There is also a &%-tls-on-connect%& command line option. This overrides
28978 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28979
28980
28981
28982
28983
28984
28985 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28986 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28987 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28988 To build Exim to use OpenSSL you need to set
28989 .code
28990 USE_OPENSSL=yes
28991 .endd
28992 in Local/Makefile.
28993
28994 To build Exim to use GnuTLS, you need to set
28995 .code
28996 USE_GNUTLS=yes
28997 .endd
28998 in Local/Makefile.
28999
29000 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
29001 include files and libraries for GnuTLS can be found.
29002
29003 There are some differences in usage when using GnuTLS instead of OpenSSL:
29004
29005 .ilist
29006 The &%tls_verify_certificates%& option
29007 cannot be the path of a directory
29008 for GnuTLS versions before 3.3.6
29009 (for later versions, or OpenSSL, it can be either).
29010 .next
29011 The default value for &%tls_dhparam%& differs for historical reasons.
29012 .next
29013 .vindex "&$tls_in_peerdn$&"
29014 .vindex "&$tls_out_peerdn$&"
29015 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
29016 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
29017 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
29018 .next
29019 OpenSSL identifies cipher suites using hyphens as separators, for example:
29020 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
29021 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
29022 in a cipher list. To make life simpler, Exim changes underscores to hyphens
29023 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
29024 to handle its own older variants) when processing lists of cipher suites in the
29025 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
29026 option).
29027 .next
29028 The &%tls_require_ciphers%& options operate differently, as described in the
29029 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
29030 .next
29031 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
29032 When using OpenSSL, this option is ignored.
29033 (If an API is found to let OpenSSL be configured in this way,
29034 let the Exim Maintainers know and we'll likely use it).
29035 .next
29036 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
29037 main option, it must be ordered to match the &%tls_certificate%& list.
29038 .next
29039 Some other recently added features may only be available in one or the other.
29040 This should be documented with the feature.  If the documentation does not
29041 explicitly state that the feature is infeasible in the other TLS
29042 implementation, then patches are welcome.
29043 .next
29044 The output from "exim -bV" will show which (if any) support was included
29045 in the build.
29046 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
29047 .endlist
29048
29049
29050 .section "GnuTLS parameter computation" "SECTgnutlsparam"
29051 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
29052 an explicit path; if the latter, then the text about generation still applies,
29053 but not the chosen filename.
29054 By default, as of Exim 4.80 a hard-coded D-H prime is used.
29055 See the documentation of &%tls_dhparam%& for more information.
29056
29057 GnuTLS uses D-H parameters that may take a substantial amount of time
29058 to compute. It is unreasonable to re-compute them for every TLS session.
29059 Therefore, Exim keeps this data in a file in its spool directory, called
29060 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
29061 of bits requested.
29062 The file is owned by the Exim user and is readable only by
29063 its owner. Every Exim process that start up GnuTLS reads the D-H
29064 parameters from this file. If the file does not exist, the first Exim process
29065 that needs it computes the data and writes it to a temporary file which is
29066 renamed once it is complete. It does not matter if several Exim processes do
29067 this simultaneously (apart from wasting a few resources). Once a file is in
29068 place, new Exim processes immediately start using it.
29069
29070 For maximum security, the parameters that are stored in this file should be
29071 recalculated periodically, the frequency depending on your paranoia level.
29072 If you are avoiding using the fixed D-H primes published in RFCs, then you
29073 are concerned about some advanced attacks and will wish to do this; if you do
29074 not regenerate then you might as well stick to the standard primes.
29075
29076 Arranging this is easy in principle; just delete the file when you want new
29077 values to be computed. However, there may be a problem. The calculation of new
29078 parameters needs random numbers, and these are obtained from &_/dev/random_&.
29079 If the system is not very active, &_/dev/random_& may delay returning data
29080 until enough randomness (entropy) is available. This may cause Exim to hang for
29081 a substantial amount of time, causing timeouts on incoming connections.
29082
29083 The solution is to generate the parameters externally to Exim. They are stored
29084 in &_gnutls-params-N_& in PEM format, which means that they can be
29085 generated externally using the &(certtool)& command that is part of GnuTLS.
29086
29087 To replace the parameters with new ones, instead of deleting the file
29088 and letting Exim re-create it, you can generate new parameters using
29089 &(certtool)& and, when this has been done, replace Exim's cache file by
29090 renaming. The relevant commands are something like this:
29091 .code
29092 # ls
29093 [ look for file; assume gnutls-params-2236 is the most recent ]
29094 # rm -f new-params
29095 # touch new-params
29096 # chown exim:exim new-params
29097 # chmod 0600 new-params
29098 # certtool --generate-dh-params --bits 2236 >>new-params
29099 # openssl dhparam -noout -text -in new-params | head
29100 [ check the first line, make sure it's not more than 2236;
29101   if it is, then go back to the start ("rm") and repeat
29102   until the size generated is at most the size requested ]
29103 # chmod 0400 new-params
29104 # mv new-params gnutls-params-2236
29105 .endd
29106 If Exim never has to generate the parameters itself, the possibility of
29107 stalling is removed.
29108
29109 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
29110 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
29111 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
29112 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
29113 and Exim does so.  This attempt to remove Exim from TLS policy decisions
29114 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
29115 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
29116 which applies to all D-H usage, client or server.  If the value returned by
29117 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
29118 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
29119 limit, which is still much higher than Exim historically used.
29120
29121 The filename and bits used will change as the GnuTLS maintainers change the
29122 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
29123 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
29124 2432 bits, while NSS is limited to 2236 bits.
29125
29126 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
29127 increase the chance of the generated prime actually being within acceptable
29128 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
29129 procedure above.  There is no sane procedure available to Exim to double-check
29130 the size of the generated prime, so it might still be too large.
29131
29132
29133 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
29134 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
29135 .oindex "&%tls_require_ciphers%&" "OpenSSL"
29136 There is a function in the OpenSSL library that can be passed a list of cipher
29137 suites before the cipher negotiation takes place. This specifies which ciphers
29138 are acceptable for TLS versions prior to 1.3.
29139 The list is colon separated and may contain names like
29140 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
29141 directly to this function call.
29142 Many systems will install the OpenSSL manual-pages, so you may have
29143 &'ciphers(1)'& available to you.
29144 The following quotation from the OpenSSL
29145 documentation specifies what forms of item are allowed in the cipher string:
29146
29147 .ilist
29148 It can consist of a single cipher suite such as RC4-SHA.
29149 .next
29150 It can represent a list of cipher suites containing a certain algorithm,
29151 or cipher suites of a certain type. For example SHA1 represents all
29152 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
29153 SSL v3 algorithms.
29154 .next
29155 Lists of cipher suites can be combined in a single cipher string using
29156 the + character. This is used as a logical and operation. For example
29157 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29158 algorithms.
29159 .endlist
29160
29161 Each cipher string can be optionally preceded by one of the characters &`!`&,
29162 &`-`& or &`+`&.
29163 .ilist
29164 If &`!`& is used, the ciphers are permanently deleted from the list. The
29165 ciphers deleted can never reappear in the list even if they are explicitly
29166 stated.
29167 .next
29168 If &`-`& is used, the ciphers are deleted from the list, but some or all
29169 of the ciphers can be added again by later options.
29170 .next
29171 If &`+`& is used, the ciphers are moved to the end of the list. This
29172 option does not add any new ciphers; it just moves matching existing ones.
29173 .endlist
29174
29175 If none of these characters is present, the string is interpreted as
29176 a list of ciphers to be appended to the current preference list. If the list
29177 includes any ciphers already present they will be ignored: that is, they will
29178 not be moved to the end of the list.
29179 .endlist
29180
29181 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29182 string:
29183 .code
29184 # note single-quotes to get ! past any shell history expansion
29185 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29186 .endd
29187
29188 This example will let the library defaults be permitted on the MX port, where
29189 there's probably no identity verification anyway, but ups the ante on the
29190 submission ports where the administrator might have some influence on the
29191 choice of clients used:
29192 .code
29193 # OpenSSL variant; see man ciphers(1)
29194 tls_require_ciphers = ${if =={$received_port}{25}\
29195                            {DEFAULT}\
29196                            {HIGH:!MD5:!SHA1}}
29197 .endd
29198
29199 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29200 .code
29201 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29202 .endd
29203
29204 For TLS version 1.3 the control available is less fine-grained
29205 and Exim does not provide access to it at present.
29206 The value of the &%tls_require_ciphers%& option is ignored when
29207 TLS version 1.3 is negotiated.
29208
29209 As of writing the library default cipher suite list for TLSv1.3 is
29210 .code
29211 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29212 .endd
29213
29214
29215 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29216          "SECTreqciphgnu"
29217 .cindex "GnuTLS" "specifying parameters for"
29218 .cindex "TLS" "specifying ciphers (GnuTLS)"
29219 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29220 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29221 .cindex "TLS" "specifying protocols (GnuTLS)"
29222 .cindex "TLS" "specifying priority string (GnuTLS)"
29223 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29224 The GnuTLS library allows the caller to provide a "priority string", documented
29225 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29226 ciphersuite specification in OpenSSL.
29227
29228 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29229 and controls both protocols and ciphers.
29230
29231 The &%tls_require_ciphers%& option is available both as an global option,
29232 controlling how Exim behaves as a server, and also as an option of the
29233 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29234 the value is string expanded.  The resulting string is not an Exim list and
29235 the string is given to the GnuTLS library, so that Exim does not need to be
29236 aware of future feature enhancements of GnuTLS.
29237
29238 Documentation of the strings accepted may be found in the GnuTLS manual, under
29239 "Priority strings".  This is online as
29240 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29241 but beware that this relates to GnuTLS 3, which may be newer than the version
29242 installed on your system.  If you are using GnuTLS 3,
29243 then the example code
29244 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29245 on that site can be used to test a given string.
29246
29247 For example:
29248 .code
29249 # Disable older versions of protocols
29250 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29251 .endd
29252
29253 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29254 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29255 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29256
29257 This example will let the library defaults be permitted on the MX port, where
29258 there's probably no identity verification anyway, and lowers security further
29259 by increasing compatibility; but this ups the ante on the submission ports
29260 where the administrator might have some influence on the choice of clients
29261 used:
29262 .code
29263 # GnuTLS variant
29264 tls_require_ciphers = ${if =={$received_port}{25}\
29265                            {NORMAL:%COMPAT}\
29266                            {SECURE128}}
29267 .endd
29268
29269
29270 .section "Configuring an Exim server to use TLS" "SECID182"
29271 .cindex "TLS" "configuring an Exim server"
29272 .cindex "ESMTP extensions" STARTTLS
29273 When Exim has been built with TLS support, it advertises the availability of
29274 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29275 but not to any others. The default value of this option is *, which means
29276 that STARTTLS is always advertised.  Set it to blank to never advertise;
29277 this is reasonable for systems that want to use TLS only as a client.
29278
29279 If STARTTLS is to be used you
29280 need to set some other options in order to make TLS available.
29281
29282 If a client issues a STARTTLS command and there is some configuration
29283 problem in the server, the command is rejected with a 454 error. If the client
29284 persists in trying to issue SMTP commands, all except QUIT are rejected
29285 with the error
29286 .code
29287 554 Security failure
29288 .endd
29289 If a STARTTLS command is issued within an existing TLS session, it is
29290 rejected with a 554 error code.
29291
29292 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29293 must be set to match some hosts. The default is * which matches all hosts.
29294
29295 If this is all you do, TLS encryption will be enabled but not authentication -
29296 meaning that the peer has no assurance it is actually you he is talking to.
29297 You gain protection from a passive sniffer listening on the wire but not
29298 from someone able to intercept the communication.
29299
29300 Further protection requires some further configuration at the server end.
29301
29302 To make TLS work you need to set, in the server,
29303 .code
29304 tls_certificate = /some/file/name
29305 tls_privatekey = /some/file/name
29306 .endd
29307 These options are, in fact, expanded strings, so you can make them depend on
29308 the identity of the client that is connected if you wish. The first file
29309 contains the server's X509 certificate, and the second contains the private key
29310 that goes with it. These files need to be
29311 PEM format and readable by the Exim user, and must
29312 always be given as full path names.
29313 The key must not be password-protected.
29314 They can be the same file if both the
29315 certificate and the key are contained within it. If &%tls_privatekey%& is not
29316 set, or if its expansion is forced to fail or results in an empty string, this
29317 is assumed to be the case. The certificate file may also contain intermediate
29318 certificates that need to be sent to the client to enable it to authenticate
29319 the server's certificate.
29320
29321 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29322 colon-separated lists of file paths.  Ciphers using given authentication
29323 algorithms require the presence of a suitable certificate to supply the
29324 public-key.  The server selects among the certificates to present to the
29325 client depending on the selected cipher, hence the priority ordering for
29326 ciphers will affect which certificate is used.
29327
29328 If you do not understand about certificates and keys, please try to find a
29329 source of this background information, which is not Exim-specific. (There are a
29330 few comments below in section &<<SECTcerandall>>&.)
29331
29332 &*Note*&: These options do not apply when Exim is operating as a client &--
29333 they apply only in the case of a server. If you need to use a certificate in an
29334 Exim client, you must set the options of the same names in an &(smtp)&
29335 transport.
29336
29337 With just these options, an Exim server will be able to use TLS. It does not
29338 require the client to have a certificate (but see below for how to insist on
29339 this). There is one other option that may be needed in other situations. If
29340 .code
29341 tls_dhparam = /some/file/name
29342 .endd
29343 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29344 with the parameters contained in the file.
29345 Set this to &`none`& to disable use of DH entirely, by making no prime
29346 available:
29347 .code
29348 tls_dhparam = none
29349 .endd
29350 This may also be set to a string identifying a standard prime to be used for
29351 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29352 used is &`ike23`&.  There are a few standard primes available, see the
29353 documentation for &%tls_dhparam%& for the complete list.
29354
29355 See the command
29356 .code
29357 openssl dhparam
29358 .endd
29359 for a way of generating file data.
29360
29361 The strings supplied for these three options are expanded every time a client
29362 host connects. It is therefore possible to use different certificates and keys
29363 for different hosts, if you so wish, by making use of the client's IP address
29364 in &$sender_host_address$& to control the expansion. If a string expansion is
29365 forced to fail, Exim behaves as if the option is not set.
29366
29367 .cindex "cipher" "logging"
29368 .cindex "log" "TLS cipher"
29369 .vindex "&$tls_in_cipher$&"
29370 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29371 an incoming TLS connection. It is included in the &'Received:'& header of an
29372 incoming message (by default &-- you can, of course, change this), and it is
29373 also included in the log line that records a message's arrival, keyed by
29374 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29375 condition can be used to test for specific cipher suites in ACLs.
29376
29377 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29378 can check the name of the cipher suite and vary their actions accordingly. The
29379 cipher suite names vary, depending on which TLS library is being used. For
29380 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29381 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29382 documentation for more details.
29383
29384 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29385 (again depending on the &%tls_cipher%& log selector).
29386
29387
29388 .subsection "Requesting and verifying client certificates"
29389 .cindex "certificate" "verification of client"
29390 .cindex "TLS" "client certificate verification"
29391 If you want an Exim server to request a certificate when negotiating a TLS
29392 session with a client, you must set either &%tls_verify_hosts%& or
29393 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29394 apply to all TLS connections. For any host that matches one of these options,
29395 Exim requests a certificate as part of the setup of the TLS session. The
29396 contents of the certificate are verified by comparing it with a list of
29397 expected trust-anchors or certificates.
29398 These may be the system default set (depending on library version),
29399 an explicit file or,
29400 depending on library version, a directory, identified by
29401 &%tls_verify_certificates%&.
29402
29403 A file can contain multiple certificates, concatenated end to end. If a
29404 directory is used
29405 (OpenSSL only),
29406 each certificate must be in a separate file, with a name (or a symbolic link)
29407 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29408 certificate. You can compute the relevant hash by running the command
29409 .code
29410 openssl x509 -hash -noout -in /cert/file
29411 .endd
29412 where &_/cert/file_& contains a single certificate.
29413
29414 There is no checking of names of the client against the certificate
29415 Subject Name or Subject Alternate Names.
29416
29417 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29418 what happens if the client does not supply a certificate, or if the certificate
29419 does not match any of the certificates in the collection named by
29420 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29421 attempt to set up a TLS session is aborted, and the incoming connection is
29422 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29423 session continues. ACLs that run for subsequent SMTP commands can detect the
29424 fact that no certificate was verified, and vary their actions accordingly. For
29425 example, you can insist on a certificate before accepting a message for
29426 relaying, but not when the message is destined for local delivery.
29427
29428 .vindex "&$tls_in_peerdn$&"
29429 When a client supplies a certificate (whether it verifies or not), the value of
29430 the Distinguished Name of the certificate is made available in the variable
29431 &$tls_in_peerdn$& during subsequent processing of the message.
29432
29433 .cindex "log" "distinguished name"
29434 Because it is often a long text string, it is not included in the log line or
29435 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29436 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29437 &%received_header_text%& to change the &'Received:'& header. When no
29438 certificate is supplied, &$tls_in_peerdn$& is empty.
29439
29440
29441 .subsection "Caching of static server configuration items" "SSECTserverTLScache"
29442 .cindex certificate caching
29443 .cindex privatekey caching
29444 .cindex crl caching
29445 .cindex ocsp caching
29446 .cindex ciphers caching
29447 .cindex "CA bundle" caching
29448 .cindex "certificate authorities" caching
29449 .cindex tls_certificate caching
29450 .cindex tls_privatekey caching
29451 .cindex tls_crl caching
29452 .cindex tls_ocsp_file caching
29453 .cindex tls_require_ciphers caching
29454 .cindex tls_verify_certificate caching
29455 .cindex caching certificate
29456 .cindex caching privatekey
29457 .cindex caching crl
29458 .cindex caching ocsp
29459 .cindex caching ciphers
29460 .cindex caching "certificate authorities
29461 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29462 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29463 expandable elements,
29464 then the associated information is loaded at daemon startup.
29465 It is made available
29466 to child processes forked for handling received SMTP connections.
29467
29468 This caching is currently only supported under Linux and FreeBSD.
29469
29470 If caching is not possible, for example if an item has to be dependent
29471 on the peer host so contains a &$sender_host_name$& expansion, the load
29472 of the associated information is done at the startup of the TLS connection.
29473
29474 The cache is invalidated and reloaded after any changes to the directories
29475 containing files specified by these options.
29476
29477 The information specified by the main option &%tls_verify_certificates%&
29478 is similarly cached so long as it specifies files explicitly
29479 or (under GnuTLS) is the string &"system,cache"&.
29480 The latter case is not automatically invalidated;
29481 it is the operator's responsibility to arrange for a daemon restart
29482 any time the system certificate authority bundle is updated.
29483 A HUP signal is sufficient for this.
29484 The value &"system"& results in no caching under GnuTLS.
29485
29486 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29487 is acceptable in configurations for the Exim executavble.
29488
29489 Caching of the system Certificate Authorities bundle can
29490 save siginificant time and processing on every TLS connection
29491 accepted by Exim.
29492
29493
29494
29495
29496 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29497 .cindex "cipher" "logging"
29498 .cindex "log" "TLS cipher"
29499 .cindex "log" "distinguished name"
29500 .cindex "TLS" "configuring an Exim client"
29501 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29502 deliveries as well as to incoming, the latter one causing logging of the
29503 server certificate's DN. The remaining client configuration for TLS is all
29504 within the &(smtp)& transport.
29505
29506 .cindex "ESMTP extensions" STARTTLS
29507 It is not necessary to set any options to have TLS work in the &(smtp)&
29508 transport. If Exim is built with TLS support, and TLS is advertised by a
29509 server, the &(smtp)& transport always tries to start a TLS session. However,
29510 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29511 transport) to a list of server hosts for which TLS should not be used.
29512
29513 If you do not want Exim to attempt to send messages unencrypted when an attempt
29514 to set up an encrypted connection fails in any way, you can set
29515 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29516 those hosts, delivery is always deferred if an encrypted connection cannot be
29517 set up. If there are any other hosts for the address, they are tried in the
29518 usual way.
29519
29520 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29521 the message unencrypted. It always does this if the response to STARTTLS is
29522 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29523 session after a success response code, what happens is controlled by the
29524 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29525 delivery to this host is deferred, and other hosts (if available) are tried. If
29526 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29527 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29528 negotiation fails, Exim closes the current connection (because it is in an
29529 unknown state), opens a new one to the same host, and then tries the delivery
29530 unencrypted.
29531
29532 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29533 transport provide the client with a certificate, which is passed to the server
29534 if it requests it.
29535 This is an optional thing for TLS connections, although either end
29536 may insist on it.
29537 If the server is Exim, it will request a certificate only if
29538 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29539
29540 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29541 for client use (they are usable for server use).
29542 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29543 in failed connections.
29544
29545 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29546 specifies a collection of expected server certificates.
29547 These may be
29548 the system default set (depending on library version),
29549 a file,
29550 or (depending on library version) a directory.
29551 The client verifies the server's certificate
29552 against this collection, taking into account any revoked certificates that are
29553 in the list defined by &%tls_crl%&.
29554 Failure to verify fails the TLS connection unless either of the
29555 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29556
29557 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29558 certificate verification to the listed servers.  Verification either must
29559 or need not succeed respectively.
29560
29561 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29562 name checks are made on the server certificate.
29563 The match against this list is, as per other Exim usage, the
29564 IP for the host.  That is most closely associated with the
29565 name on the DNS A (or AAAA) record for the host.
29566 However, the name that needs to be in the certificate
29567 is the one at the head of any CNAME chain leading to the A record.
29568 The option defaults to always checking.
29569
29570 The &(smtp)& transport has two OCSP-related options:
29571 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29572 is requested and required for the connection to proceed.  The default
29573 value is empty.
29574 &%hosts_request_ocsp%&; a host-list for which (additionally)
29575 a Certificate Status is requested (but not necessarily verified).  The default
29576 value is "*" meaning that requests are made unless configured
29577 otherwise.
29578
29579 The host(s) should also be in &%hosts_require_tls%&, and
29580 &%tls_verify_certificates%& configured for the transport,
29581 for OCSP to be relevant.
29582
29583 If
29584 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29585 list of permitted cipher suites. If either of these checks fails, delivery to
29586 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29587 alternative hosts, if any.
29588
29589  &*Note*&:
29590 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29591 is operating as a client. Exim does not assume that a server certificate (set
29592 by the global options of the same name) should also be used when operating as a
29593 client.
29594
29595 .vindex "&$host$&"
29596 .vindex "&$host_address$&"
29597 All the TLS options in the &(smtp)& transport are expanded before use, with
29598 &$host$& and &$host_address$& containing the name and address of the server to
29599 which the client is connected. Forced failure of an expansion causes Exim to
29600 behave as if the relevant option were unset.
29601
29602 .vindex &$tls_out_bits$&
29603 .vindex &$tls_out_cipher$&
29604 .vindex &$tls_out_peerdn$&
29605 .vindex &$tls_out_sni$&
29606 Before an SMTP connection is established, the
29607 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29608 variables are emptied. (Until the first connection, they contain the values
29609 that were set when the message was received.) If STARTTLS is subsequently
29610 successfully obeyed, these variables are set to the relevant values for the
29611 outgoing connection.
29612
29613
29614
29615 .subsection "Caching of static client configuration items" SECTclientTLScache
29616 .cindex certificate caching
29617 .cindex privatekey caching
29618 .cindex crl caching
29619 .cindex ciphers caching
29620 .cindex "CA bundle" caching
29621 .cindex "certificate authorities" caching
29622 .cindex tls_certificate caching
29623 .cindex tls_privatekey caching
29624 .cindex tls_crl caching
29625 .cindex tls_require_ciphers caching
29626 .cindex tls_verify_certificate caching
29627 .cindex caching certificate
29628 .cindex caching privatekey
29629 .cindex caching crl
29630 .cindex caching ciphers
29631 .cindex caching "certificate authorities
29632 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29633 and &%tls_crl%& have values with no
29634 expandable elements,
29635 then the associated information is loaded per smtp transport
29636 at daemon startup, at the start of a queue run, or on a
29637 command-line specified message delivery.
29638 It is made available
29639 to child processes forked for handling making SMTP connections.
29640
29641 This caching is currently only supported under Linux.
29642
29643 If caching is not possible, the load
29644 of the associated information is done at the startup of the TLS connection.
29645
29646 The cache is invalidated in the daemon
29647 and reloaded after any changes to the directories
29648 containing files specified by these options.
29649
29650 The information specified by the main option &%tls_verify_certificates%&
29651 is similarly cached so long as it specifies files explicitly
29652 or (under GnuTLS) is the string &"system,cache"&.
29653 The latter case is not automatically invaludated;
29654 it is the operator's responsibility to arrange for a daemon restart
29655 any time the system certificate authority bundle is updated.
29656 A HUP signal is sufficient for this.
29657 The value &"system"& results in no caching under GnuTLS.
29658
29659 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29660 is acceptable in configurations for the Exim executavble.
29661
29662 Caching of the system Certificate Authorities bundle can
29663 save siginificant time and processing on every TLS connection
29664 initiated by Exim.
29665
29666
29667
29668
29669 .section "Use of TLS Server Name Indication" "SECTtlssni"
29670 .cindex "TLS" "Server Name Indication"
29671 .cindex "TLS" SNI
29672 .cindex SNI
29673 .vindex "&$tls_in_sni$&"
29674 .oindex "&%tls_in_sni%&"
29675 With TLS1.0 or above, there is an extension mechanism by which extra
29676 information can be included at various points in the protocol.  One of these
29677 extensions, documented in RFC 6066 (and before that RFC 4366) is
29678 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29679 client in the initial handshake, so that the server can examine the servername
29680 within and possibly choose to use different certificates and keys (and more)
29681 for this session.
29682
29683 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29684 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29685 address.
29686
29687 With SMTP to MX, there are the same problems here as in choosing the identity
29688 against which to validate a certificate: you can't rely on insecure DNS to
29689 provide the identity which you then cryptographically verify.  So this will
29690 be of limited use in that environment.
29691
29692 With SMTP to Submission, there is a well-defined hostname which clients are
29693 connecting to and can validate certificates against.  Thus clients &*can*&
29694 choose to include this information in the TLS negotiation.  If this becomes
29695 wide-spread, then hosters can choose to present different certificates to
29696 different clients.  Or even negotiate different cipher suites.
29697
29698 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29699 if not empty, will be sent on a TLS session as part of the handshake.  There's
29700 nothing more to it.  Choosing a sensible value not derived insecurely is the
29701 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29702 for the lifetime of the client connection (including during authentication).
29703
29704 If DANE validated the connection attempt then the value of the &%tls_sni%& option
29705 is forced to the name of the destination host, after any MX- or CNAME-following.
29706
29707 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29708 received from a client.
29709 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29710
29711 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29712 option (prior to expansion) then the following options will be re-expanded
29713 during TLS session handshake, to permit alternative values to be chosen:
29714
29715 .ilist
29716 &%tls_certificate%&
29717 .next
29718 &%tls_crl%&
29719 .next
29720 &%tls_privatekey%&
29721 .next
29722 &%tls_verify_certificates%&
29723 .next
29724 &%tls_ocsp_file%&
29725 .endlist
29726
29727 Great care should be taken to deal with matters of case, various injection
29728 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29729 can always be referenced; it is important to remember that &$tls_in_sni$& is
29730 arbitrary unverified data provided prior to authentication.
29731 Further, the initial certificate is loaded before SNI has arrived, so
29732 an expansion for &%tls_certificate%& must have a default which is used
29733 when &$tls_in_sni$& is empty.
29734
29735 The Exim developers are proceeding cautiously and so far no other TLS options
29736 are re-expanded.
29737
29738 When Exim is built against OpenSSL, OpenSSL must have been built with support
29739 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29740 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29741 see &`-servername`& in the output, then OpenSSL has support.
29742
29743 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29744 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29745 built, then you have SNI support).
29746
29747 .subsection ALPN
29748 .cindex TLS ALPN
29749 .cindex ALPN "general information"
29750 .cindex TLS "Application Layer Protocol Names"
29751 There is a TLS feature related to SNI
29752 called Application Layer Protocol Name (ALPN).
29753 This is intended to declare, or select, what protocol layer will be using a TLS
29754 connection.
29755 The client for the connection proposes a set of protocol names, and
29756 the server responds with a selected one.
29757 It is not, as of 2021, commonly used for SMTP connections.
29758 However, to guard against misirected or malicious use of web clients
29759 (which often do use ALPN) against MTA ports, Exim by default check that
29760 there is no incompatible ALPN specified by a client for a TLS connection.
29761 If there is, the connection is rejected.
29762
29763 As a client Exim does not supply ALPN by default.
29764 The behaviour of both client and server can be configured using the options
29765 &%tls_alpn%& and &%hosts_require_alpn%&.
29766 There are no variables providing observability.
29767 Some feature-specific logging may appear on denied connections, but this
29768 depends on the behavious of the peer
29769 (not all peers can send a feature-specific TLS Alert).
29770
29771 This feature is available when Exim is built with
29772 OpenSSL 1.1.0 or later or GnuTLS 3.2.0 or later;
29773 the macro _HAVE_TLS_ALPN will be defined when this is so.
29774
29775
29776
29777 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29778          "SECTmulmessam"
29779 .cindex "multiple SMTP deliveries with TLS"
29780 .cindex "TLS" "multiple message deliveries"
29781 Exim sends multiple messages down the same TCP/IP connection by starting up
29782 an entirely new delivery process for each message, passing the socket from
29783 one process to the next. This implementation does not fit well with the use
29784 of TLS, because there is quite a lot of state information associated with a TLS
29785 connection, not just a socket identification. Passing all the state information
29786 to a new process is not feasible. Consequently, for sending using TLS Exim
29787 starts an additional proxy process for handling the encryption, piping the
29788 unencrypted data stream from and to the delivery processes.
29789
29790 An older mode of operation can be enabled on a per-host basis by the
29791 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29792 this list the proxy process described above is not used; instead Exim
29793 shuts down an existing TLS session being run by the delivery process
29794 before passing the socket to a new process. The new process may then
29795 try to start a new TLS session, and if successful, may try to re-authenticate
29796 if AUTH is in use, before sending the next message.
29797
29798 The RFC is not clear as to whether or not an SMTP session continues in clear
29799 after TLS has been shut down, or whether TLS may be restarted again later, as
29800 just described. However, if the server is Exim, this shutdown and
29801 reinitialization works. It is not known which (if any) other servers operate
29802 successfully if the client closes a TLS session and continues with unencrypted
29803 SMTP, but there are certainly some that do not work. For such servers, Exim
29804 should not pass the socket to another process, because the failure of the
29805 subsequent attempt to use it would cause Exim to record a temporary host error,
29806 and delay other deliveries to that host.
29807
29808 To test for this case, Exim sends an EHLO command to the server after
29809 closing down the TLS session. If this fails in any way, the connection is
29810 closed instead of being passed to a new delivery process, but no retry
29811 information is recorded.
29812
29813 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29814 &(smtp)& transport to match those hosts for which Exim should not pass
29815 connections to new processes if TLS has been used.
29816
29817
29818
29819
29820 .section "Certificates and all that" "SECTcerandall"
29821 .cindex "certificate" "references to discussion"
29822 In order to understand fully how TLS works, you need to know about
29823 certificates, certificate signing, and certificate authorities.
29824 This is a large topic and an introductory guide is unsuitable for the Exim
29825 reference manual, so instead we provide pointers to existing documentation.
29826
29827 The Apache web-server was for a long time the canonical guide, so their
29828 documentation is a good place to start; their SSL module's Introduction
29829 document is currently at
29830 .display
29831 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29832 .endd
29833 and their FAQ is at
29834 .display
29835 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29836 .endd
29837
29838 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29839 0-201-61598-3) in 2001, contains both introductory and more in-depth
29840 descriptions.
29841 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29842 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29843 Ivan is the author of the popular TLS testing tools at
29844 &url(https://www.ssllabs.com/).
29845
29846
29847 .subsection "Certificate chains" SECID186
29848 A file named by &%tls_certificate%& may contain more than one
29849 certificate. This is useful in the case where the certificate that is being
29850 sent is validated by an intermediate certificate which the other end does
29851 not have. Multiple certificates must be in the correct order in the file.
29852 First the host's certificate itself, then the first intermediate
29853 certificate to validate the issuer of the host certificate, then the next
29854 intermediate certificate to validate the issuer of the first intermediate
29855 certificate, and so on, until finally (optionally) the root certificate.
29856 The root certificate must already be trusted by the recipient for
29857 validation to succeed, of course, but if it's not preinstalled, sending the
29858 root certificate along with the rest makes it available for the user to
29859 install if the receiving end is a client MUA that can interact with a user.
29860
29861 Note that certificates using MD5 are unlikely to work on today's Internet;
29862 even if your libraries allow loading them for use in Exim when acting as a
29863 server, increasingly clients will not accept such certificates.  The error
29864 diagnostics in such a case can be frustratingly vague.
29865
29866
29867
29868 .subsection "Self-signed certificates" SECID187
29869 .cindex "certificate" "self-signed"
29870 You can create a self-signed certificate using the &'req'& command provided
29871 with OpenSSL, like this:
29872 . ==== Do not shorten the duration here without reading and considering
29873 . ==== the text below.  Please leave it at 9999 days.
29874 .code
29875 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29876             -days 9999 -nodes
29877 .endd
29878 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29879 delimited and so can be identified independently. The &%-days%& option
29880 specifies a period for which the certificate is valid. The &%-nodes%& option is
29881 important: if you do not set it, the key is encrypted with a passphrase
29882 that you are prompted for, and any use that is made of the key causes more
29883 prompting for the passphrase. This is not helpful if you are going to use
29884 this certificate and key in an MTA, where prompting is not possible.
29885
29886 . ==== I expect to still be working 26 years from now.  The less technical
29887 . ==== debt I create, in terms of storing up trouble for my later years, the
29888 . ==== happier I will be then.  We really have reached the point where we
29889 . ==== should start, at the very least, provoking thought and making folks
29890 . ==== pause before proceeding, instead of leaving all the fixes until two
29891 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29892 . ==== -pdp, 2012
29893 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29894 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29895 the above command might produce a date in the past.  Think carefully about
29896 the lifetime of the systems you're deploying, and either reduce the duration
29897 of the certificate or reconsider your platform deployment.  (At time of
29898 writing, reducing the duration is the most likely choice, but the inexorable
29899 progression of time takes us steadily towards an era where this will not
29900 be a sensible resolution).
29901
29902 A self-signed certificate made in this way is sufficient for testing, and
29903 may be adequate for all your requirements if you are mainly interested in
29904 encrypting transfers, and not in secure identification.
29905
29906 However, many clients require that the certificate presented by the server be a
29907 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29908 certificate. In this situation, the self-signed certificate described above
29909 must be installed on the client host as a trusted root &'certification
29910 authority'& (CA), and the certificate used by Exim must be a user certificate
29911 signed with that self-signed certificate.
29912
29913 For information on creating self-signed CA certificates and using them to sign
29914 user certificates, see the &'General implementation overview'& chapter of the
29915 Open-source PKI book, available online at
29916 &url(https://sourceforge.net/projects/ospkibook/).
29917
29918
29919 .subsection "Revoked certificates"
29920 .cindex "TLS" "revoked certificates"
29921 .cindex "revocation list"
29922 .cindex "certificate" "revocation list"
29923 .cindex "OCSP" "stapling"
29924 There are three ways for a certificate to be made unusable
29925 before its expiry.
29926
29927 .ilist
29928 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
29929 certificates are revoked. If you have such a list, you can pass it to an Exim
29930 server using the global option called &%tls_crl%& and to an Exim client using
29931 an identically named option for the &(smtp)& transport. In each case, the value
29932 of the option is expanded and must then be the name of a file that contains a
29933 CRL in PEM format.
29934 The downside is that clients have to periodically re-download a potentially huge
29935 file from every certificate authority they know of.
29936
29937 .next
29938 The way with most moving parts at query time is Online Certificate
29939 Status Protocol (OCSP), where the client verifies the certificate
29940 against an OCSP server run by the CA.  This lets the CA track all
29941 usage of the certs.  It requires running software with access to the
29942 private key of the CA, to sign the responses to the OCSP queries.  OCSP
29943 is based on HTTP and can be proxied accordingly.
29944
29945 The only widespread OCSP server implementation (known to this writer)
29946 comes as part of OpenSSL and aborts on an invalid request, such as
29947 connecting to the port and then disconnecting.  This requires
29948 re-entering the passphrase each time some random client does this.
29949
29950 .next
29951 The third way is OCSP Stapling; in this, the server using a certificate
29952 issued by the CA periodically requests an OCSP proof of validity from
29953 the OCSP server, then serves it up inline as part of the TLS
29954 negotiation.   This approach adds no extra round trips, does not let the
29955 CA track users, scales well with number of certs issued by the CA and is
29956 resilient to temporary OCSP server failures, as long as the server
29957 starts retrying to fetch an OCSP proof some time before its current
29958 proof expires.  The downside is that it requires server support.
29959
29960 Unless Exim is built with the support disabled,
29961 or with GnuTLS earlier than version 3.3.16 / 3.4.8
29962 support for OCSP stapling is included.
29963
29964 There is a global option called &%tls_ocsp_file%&.
29965 The file specified therein is expected to be in DER format, and contain
29966 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
29967 option will be re-expanded for SNI, if the &%tls_certificate%& option
29968 contains &`tls_in_sni`&, as per other TLS options.
29969
29970 Exim does not at this time implement any support for fetching a new OCSP
29971 proof.  The burden is on the administrator to handle this, outside of
29972 Exim.  The file specified should be replaced atomically, so that the
29973 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
29974 on each connection, so a new file will be handled transparently on the
29975 next connection.
29976
29977 When built with OpenSSL Exim will check for a valid next update timestamp
29978 in the OCSP proof; if not present, or if the proof has expired, it will be
29979 ignored.
29980
29981 For the client to be able to verify the stapled OCSP the server must
29982 also supply, in its stapled information, any intermediate
29983 certificates for the chain leading to the OCSP proof from the signer
29984 of the server certificate.  There may be zero or one such. These
29985 intermediate certificates should be added to the server OCSP stapling
29986 file named by &%tls_ocsp_file%&.
29987
29988 Note that the proof only covers the terminal server certificate,
29989 not any of the chain from CA to it.
29990
29991 There is no current way to staple a proof for a client certificate.
29992
29993 .code
29994   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
29995   OCSP server is supplied.  The server URL may be included in the
29996   server certificate, if the CA is helpful.
29997
29998   One failure mode seen was the OCSP Signer cert expiring before the end
29999   of validity of the OCSP proof. The checking done by Exim/OpenSSL
30000   noted this as invalid overall, but the re-fetch script did not.
30001 .endd
30002 .endlist
30003
30004
30005 .ecindex IIDencsmtp1
30006 .ecindex IIDencsmtp2
30007
30008
30009 .section "TLS Resumption" "SECTresumption"
30010 .cindex TLS resumption
30011 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
30012 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
30013 (or later).
30014
30015 Session resumption (this is the "stateless" variant) involves the server sending
30016 a "session ticket" to the client on one connection, which can be stored by the
30017 client and used for a later session.  The ticket contains sufficient state for
30018 the server to reconstruct the TLS session, avoiding some expensive crypto
30019 calculation and (on TLS1.2) one full packet roundtrip time.
30020
30021 .ilist
30022 Operational cost/benefit:
30023
30024  The extra data being transmitted costs a minor amount, and the client has
30025  extra costs in storing and retrieving the data.
30026
30027  In the Exim/Gnutls implementation the extra cost on an initial connection
30028  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
30029  The saved cost on a subsequent connection is about 4ms; three or more
30030  connections become a net win.  On longer network paths, two or more
30031  connections will have an average lower startup time thanks to the one
30032  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
30033  packet roundtrips.
30034
30035 .cindex "hints database" tls
30036  Since a new hints DB is used on the TLS client,
30037  the hints DB maintenance should be updated to additionally handle "tls".
30038
30039 .next
30040 Security aspects:
30041
30042  The session ticket is encrypted, but is obviously an additional security
30043  vulnarability surface.  An attacker able to decrypt it would have access
30044  all connections using the resumed session.
30045  The session ticket encryption key is not committed to storage by the server
30046  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
30047  overlap; GnuTLS 6hr but does not specify any overlap).
30048  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
30049  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
30050
30051  There is a question-mark over the security of the Diffie-Helman parameters
30052  used for session negotiation.
30053
30054 .next
30055 Observability:
30056
30057  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
30058  element.
30059
30060  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
30061  have bits 0-4 indicating respectively
30062  support built, client requested ticket, client offered session,
30063  server issued ticket, resume used.  A suitable decode list is provided
30064  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
30065
30066 .next
30067 Control:
30068
30069 The &%tls_resumption_hosts%& main option specifies a hostlist for which
30070 exim, operating as a server, will offer resumption to clients.
30071 Current best practice is to not offer the feature to MUA connection.
30072 Commonly this can be done like this:
30073 .code
30074 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
30075 .endd
30076 If the peer host matches the list after expansion then resumption
30077 is offered and/or accepted.
30078
30079 The &%tls_resumption_hosts%& smtp transport option performs the
30080 equivalent function for operation as a client.
30081 If the peer host matches the list after expansion then resumption
30082 is attempted (if a stored session is available) or the information
30083 stored (if supplied by the peer).
30084
30085
30086 .next
30087 Issues:
30088
30089  In a resumed session:
30090 .ilist
30091   The variables &$tls_{in,out}_cipher$& will have values different
30092  to the original (under GnuTLS).
30093 .next
30094   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
30095  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
30096 . XXX need to do something with that hosts_require_ocsp
30097 .endlist
30098
30099 .endlist
30100
30101
30102 .section DANE "SECDANE"
30103 .cindex DANE
30104 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
30105 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
30106 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
30107 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
30108 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
30109 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
30110
30111 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
30112 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
30113 by (a) is thought to be smaller than that of the set of root CAs.
30114
30115 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
30116 fail to pass on a server's STARTTLS.
30117
30118 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
30119 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
30120 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
30121
30122 DANE requires a server operator to do three things:
30123 .olist
30124 Run DNSSEC.  This provides assurance to clients
30125 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
30126 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
30127 DNSSEC.
30128 .next
30129 Add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
30130 .next
30131 Offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
30132 .endlist
30133
30134 There are no changes to Exim specific to server-side operation of DANE.
30135 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
30136 in &_Local/Makefile_&.
30137 If it has been included, the macro "_HAVE_DANE" will be defined.
30138
30139 .subsection "DNS records"
30140 A TLSA record consist of 4 fields, the "Certificate Usage", the
30141 "Selector", the "Matching type", and the "Certificate Association Data".
30142 For a detailed description of the TLSA record see
30143 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
30144
30145 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
30146 These are the "Trust Anchor" and "End Entity" variants.
30147 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
30148 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
30149 this is appropriate for a single system, using a self-signed certificate.
30150 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
30151 well-known one.
30152 A private CA at simplest is just a self-signed certificate (with certain
30153 attributes) which is used to sign server certificates, but running one securely
30154 does require careful arrangement.
30155 With DANE-TA, as implemented in Exim and commonly in other MTAs,
30156 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
30157 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
30158 all of which point to a single TLSA record.
30159 DANE-TA and DANE-EE can both be used together.
30160
30161 Our recommendation is to use DANE with a certificate from a public CA,
30162 because this enables a variety of strategies for remote clients to verify
30163 your certificate.
30164 You can then publish information both via DANE and another technology,
30165 "MTA-STS", described below.
30166
30167 When you use DANE-TA to publish trust anchor information, you ask entities
30168 outside your administrative control to trust the Certificate Authority for
30169 connections to you.
30170 If using a private CA then you should expect others to still apply the
30171 technical criteria they'd use for a public CA to your certificates.
30172 In particular, you should probably try to follow current best practices for CA
30173 operation around hash algorithms and key sizes.
30174 Do not expect other organizations to lower their security expectations just
30175 because a particular profile might be reasonable for your own internal use.
30176
30177 When this text was last updated, this in practice means to avoid use of SHA-1
30178 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
30179 than 4096, for interoperability); to use keyUsage fields correctly; to use
30180 random serial numbers.
30181 The list of requirements is subject to change as best practices evolve.
30182 If you're not already using a private CA, or it doesn't meet these
30183 requirements, then we encourage you to avoid all these issues and use a public
30184 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
30185
30186 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
30187 a "Matching Type" (3rd) field of SHA2-512(2).
30188
30189 For the "Certificate Authority Data" (4th) field, commands like
30190
30191 .code
30192   openssl x509 -pubkey -noout <certificate.pem \
30193   | openssl rsa -outform der -pubin 2>/dev/null \
30194   | openssl sha512 \
30195   | awk '{print $2}'
30196 .endd
30197
30198 are workable to create a hash of the certificate's public key.
30199
30200 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30201
30202 .code
30203   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30204 .endd
30205
30206 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30207 is useful for quickly generating TLSA records.
30208
30209
30210 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30211
30212 The Certificate issued by the CA published in the DANE-TA model should be
30213 issued using a strong hash algorithm.
30214 Exim, and importantly various other MTAs sending to you, will not
30215 re-enable hash algorithms which have been disabled by default in TLS
30216 libraries.
30217 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30218 interoperability (and probably the maximum too, in 2018).
30219
30220 .subsection "Interaction with OCSP"
30221 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30222 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30223 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30224
30225 .code
30226   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30227                                  {= {4}{$tls_out_tlsa_usage}} } \
30228                          {*}{}}
30229 .endd
30230
30231 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30232 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30233 found. If the definition of &%hosts_request_ocsp%& includes the
30234 string "tls_out_tlsa_usage", they are re-expanded in time to
30235 control the OCSP request.
30236
30237 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30238 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30239
30240
30241 .subsection "Client configuration"
30242 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30243 and &%dane_require_tls_ciphers%&.
30244 The &"require"& variant will result in failure if the target host is not
30245 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30246 the &%dnssec_request_domains%& router or transport option.
30247
30248 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30249
30250 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using DNSSEC.
30251 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30252 will be required for the host.  If it does not, the host will not
30253 be used; there is no fallback to non-DANE or non-TLS.
30254
30255 If DANE is requested and usable, then the TLS cipher list configuration
30256 prefers to use the option &%dane_require_tls_ciphers%& and falls
30257 back to &%tls_require_ciphers%& only if that is unset.
30258 This lets you configure "decent crypto" for DANE and "better than nothing
30259 crypto" as the default.  Note though that while GnuTLS lets the string control
30260 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30261 limited to ciphersuite constraints.
30262
30263 If DANE is requested and useable (see above) the following transport options are ignored:
30264 .code
30265   hosts_require_tls
30266   tls_verify_hosts
30267   tls_try_verify_hosts
30268   tls_verify_certificates
30269   tls_crl
30270   tls_verify_cert_hostnames
30271   tls_sni
30272 .endd
30273
30274 If DANE is not usable, whether requested or not, and CA-anchored
30275 verification evaluation is wanted, the above variables should be set appropriately.
30276
30277 The router and transport option &%dnssec_request_domains%& must not be
30278 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30279
30280 .subsection Observability
30281 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30282
30283 There is a new variable &$tls_out_dane$& which will have "yes" if
30284 verification succeeded using DANE and "no" otherwise (only useful
30285 in combination with events; see &<<CHAPevents>>&),
30286 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30287
30288 .cindex DANE reporting
30289 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30290 to achieve DANE-verified connection, if one was either requested and offered, or
30291 required.  This is intended to support TLS-reporting as defined in
30292 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30293 The &$event_data$& will be one of the Result Types defined in
30294 Section 4.3 of that document.
30295
30296 .subsection General
30297 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30298
30299 DANE is specified in published RFCs and decouples certificate authority trust
30300 selection from a "race to the bottom" of "you must trust everything for mail
30301 to get through".
30302 There is an alternative technology called MTA-STS, which
30303 instead publishes MX trust anchor information on an HTTPS website.  At the
30304 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
30305 Exim has no support for MTA-STS as a client, but Exim mail server operators
30306 can choose to publish information describing their TLS configuration using
30307 MTA-STS to let those clients who do use that protocol derive trust
30308 information.
30309
30310 The MTA-STS design requires a certificate from a public Certificate Authority
30311 which is recognized by clients sending to you.
30312 That selection of which CAs are trusted by others is outside your control.
30313
30314 The most interoperable course of action is probably to use
30315 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30316 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30317 records for DANE clients (such as Exim and Postfix) and to publish anchor
30318 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30319 domain itself (with caveats around occasionally broken MTA-STS because of
30320 incompatible specification changes prior to reaching RFC status).
30321
30322
30323
30324 . ////////////////////////////////////////////////////////////////////////////
30325 . ////////////////////////////////////////////////////////////////////////////
30326
30327 .chapter "Access control lists" "CHAPACL"
30328 .scindex IIDacl "&ACL;" "description"
30329 .cindex "control of incoming mail"
30330 .cindex "message" "controlling incoming"
30331 .cindex "policy control" "access control lists"
30332 Access Control Lists (ACLs) are defined in a separate section of the runtime
30333 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30334 name, terminated by a colon. Here is a complete ACL section that contains just
30335 one very small ACL:
30336 .code
30337 begin acl
30338 small_acl:
30339   accept   hosts = one.host.only
30340 .endd
30341 You can have as many lists as you like in the ACL section, and the order in
30342 which they appear does not matter. The lists are self-terminating.
30343
30344 The majority of ACLs are used to control Exim's behaviour when it receives
30345 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30346 when a local process submits a message using SMTP by specifying the &%-bs%&
30347 option. The most common use is for controlling which recipients are accepted
30348 in incoming messages. In addition, you can define an ACL that is used to check
30349 local non-SMTP messages. The default configuration file contains an example of
30350 a realistic ACL for checking RCPT commands. This is discussed in chapter
30351 &<<CHAPdefconfil>>&.
30352
30353
30354 .section "Testing ACLs" "SECID188"
30355 The &%-bh%& command line option provides a way of testing your ACL
30356 configuration locally by running a fake SMTP session with which you interact.
30357
30358
30359 .section "Specifying when ACLs are used" "SECID189"
30360 .cindex "&ACL;" "options for specifying"
30361 In order to cause an ACL to be used, you have to name it in one of the relevant
30362 options in the main part of the configuration. These options are:
30363 .cindex "AUTH" "ACL for"
30364 .cindex "DATA" "ACLs for"
30365 .cindex "ETRN" "ACL for"
30366 .cindex "EXPN" "ACL for"
30367 .cindex "HELO" "ACL for"
30368 .cindex "EHLO" "ACL for"
30369 .cindex "DKIM" "ACL for"
30370 .cindex "MAIL" "ACL for"
30371 .cindex "QUIT, ACL for"
30372 .cindex "RCPT" "ACL for"
30373 .cindex "STARTTLS, ACL for"
30374 .cindex "VRFY" "ACL for"
30375 .cindex "SMTP" "connection, ACL for"
30376 .cindex "non-SMTP messages" "ACLs for"
30377 .cindex "MIME content scanning" "ACL for"
30378 .cindex "PRDR" "ACL for"
30379
30380 .table2 140pt
30381 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30382 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30383 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30384 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30385 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30386 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30387 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30388 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30389 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30390 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30391 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30392 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30393 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30394 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30395 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30396 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30397 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30398 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30399 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30400 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30401 .endtable
30402
30403 For example, if you set
30404 .code
30405 acl_smtp_rcpt = small_acl
30406 .endd
30407 the little ACL defined above is used whenever Exim receives a RCPT command
30408 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30409 done when RCPT commands arrive. A rejection of RCPT should cause the
30410 sending MTA to give up on the recipient address contained in the RCPT
30411 command, whereas rejection at other times may cause the client MTA to keep on
30412 trying to deliver the message. It is therefore recommended that you do as much
30413 testing as possible at RCPT time.
30414
30415
30416 .subsection "The non-SMTP ACLs" SECID190
30417 .cindex "non-SMTP messages" "ACLs for"
30418 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30419 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30420 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30421 the state of the SMTP connection such as encryption and authentication) are not
30422 relevant and are forbidden in these ACLs. However, the sender and recipients
30423 are known, so the &%senders%& and &%sender_domains%& conditions and the
30424 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30425 &$authenticated_sender$& are also available. You can specify added header lines
30426 in any of these ACLs.
30427
30428 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30429 non-SMTP message, before any of the message has been read. (This is the
30430 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30431 batched SMTP input, it runs after the DATA command has been reached. The
30432 result of this ACL is ignored; it cannot be used to reject a message. If you
30433 really need to, you could set a value in an ACL variable here and reject based
30434 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30435 controls, and in particular, it can be used to set
30436 .code
30437 control = suppress_local_fixups
30438 .endd
30439 This cannot be used in the other non-SMTP ACLs because by the time they are
30440 run, it is too late.
30441
30442 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30443 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30444
30445 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30446 kind of rejection is treated as permanent, because there is no way of sending a
30447 temporary error for these kinds of message.
30448
30449
30450 .subsection "The SMTP connect ACL" SECID191
30451 .cindex "SMTP" "connection, ACL for"
30452 .oindex &%smtp_banner%&
30453 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30454 session, after the test specified by &%host_reject_connection%& (which is now
30455 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30456 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30457 the message override the banner message that is otherwise specified by the
30458 &%smtp_banner%& option.
30459
30460 For tls-on-connect connections, the ACL is run after the TLS connection
30461 is accepted (however, &%host_reject_connection%& is tested before).
30462
30463
30464 .subsection "The EHLO/HELO ACL" SECID192
30465 .cindex "EHLO" "ACL for"
30466 .cindex "HELO" "ACL for"
30467 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30468 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30469 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30470 Note that a client may issue more than one EHLO or HELO command in an SMTP
30471 session, and indeed is required to issue a new EHLO or HELO after successfully
30472 setting up encryption following a STARTTLS command.
30473
30474 Note also that a deny neither forces the client to go away nor means that
30475 mail will be refused on the connection.  Consider checking for
30476 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30477
30478 If the command is accepted by an &%accept%& verb that has a &%message%&
30479 modifier, the message may not contain more than one line (it will be truncated
30480 at the first newline and a panic logged if it does). Such a message cannot
30481 affect the EHLO options that are listed on the second and subsequent lines of
30482 an EHLO response.
30483
30484
30485 .subsection "The DATA ACLs" SECID193
30486 .cindex "DATA" "ACLs for"
30487 Two ACLs are associated with the DATA command, because it is two-stage
30488 command, with two responses being sent to the client.
30489 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30490 is obeyed. This gives you control after all the RCPT commands, but before
30491 the message itself is received. It offers the opportunity to give a negative
30492 response to the DATA command before the data is transmitted. Header lines
30493 added by MAIL or RCPT ACLs are not visible at this time, but any that
30494 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30495
30496 You cannot test the contents of the message, for example, to verify addresses
30497 in the headers, at RCPT time or when the DATA command is received. Such
30498 tests have to appear in the ACL that is run after the message itself has been
30499 received, before the final response to the DATA command is sent. This is
30500 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30501 associated with the DATA command.
30502
30503 .cindex CHUNKING "BDAT command"
30504 .cindex BDAT "SMTP command"
30505 .cindex "RFC 3030" CHUNKING
30506 If CHUNKING was advertised and a BDAT command sequence is received,
30507 the &%acl_smtp_predata%& ACL is not run.
30508 . XXX why not?  It should be possible, for the first BDAT.
30509 The &%acl_smtp_data%& is run after the last BDAT command and all of
30510 the data specified is received.
30511
30512 For both of these ACLs, it is not possible to reject individual recipients. An
30513 error response rejects the entire message. Unfortunately, it is known that some
30514 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30515 before or after the data) correctly &-- they keep the message on their queues
30516 and try again later, but that is their problem, though it does waste some of
30517 your resources.
30518
30519 The &%acl_smtp_data%& ACL is run after
30520 the &%acl_smtp_data_prdr%&,
30521 the &%acl_smtp_dkim%&
30522 and the &%acl_smtp_mime%& ACLs.
30523
30524 .subsection "The SMTP DKIM ACL" SECTDKIMACL
30525 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30526 enabled (which is the default).
30527
30528 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30529 received, and is executed for each DKIM signature found in a message.  If not
30530 otherwise specified, the default action is to accept.
30531
30532 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30533
30534 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30535
30536
30537 .subsection "The SMTP MIME ACL" SECID194
30538 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30539 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30540
30541 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30542
30543
30544 .subsection "The SMTP PRDR ACL" SECTPRDRACL
30545 .cindex "PRDR" "ACL for"
30546 .oindex "&%prdr_enable%&"
30547 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30548 with PRDR support enabled (which is the default).
30549 It becomes active only when the PRDR feature is negotiated between
30550 client and server for a message, and more than one recipient
30551 has been accepted.
30552
30553 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30554 has been received, and is executed once for each recipient of the message
30555 with &$local_part$& and &$domain$& valid.
30556 The test may accept, defer or deny for individual recipients.
30557 The &%acl_smtp_data%& will still be called after this ACL and
30558 can reject the message overall, even if this ACL has accepted it
30559 for some or all recipients.
30560
30561 PRDR may be used to support per-user content filtering.  Without it
30562 one must defer any recipient after the first that has a different
30563 content-filter configuration.  With PRDR, the RCPT-time check
30564 .cindex "PRDR" "variable for"
30565 for this can be disabled when the variable &$prdr_requested$&
30566 is &"yes"&.
30567 Any required difference in behaviour of the main DATA-time
30568 ACL should however depend on the PRDR-time ACL having run, as Exim
30569 will avoid doing so in some situations (e.g. single-recipient mails).
30570
30571 See also the &%prdr_enable%& global option
30572 and the &%hosts_try_prdr%& smtp transport option.
30573
30574 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30575 If the ACL is not defined, processing completes as if
30576 the feature was not requested by the client.
30577
30578 .subsection "The QUIT ACL" SECTQUITACL
30579 .cindex "QUIT, ACL for"
30580 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30581 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30582 does not in fact control any access.
30583 For this reason, it may only accept
30584 or warn as its final result.
30585
30586 This ACL can be used for tasks such as custom logging at the end of an SMTP
30587 session. For example, you can use ACL variables in other ACLs to count
30588 messages, recipients, etc., and log the totals at QUIT time using one or
30589 more &%logwrite%& modifiers on a &%warn%& verb.
30590
30591 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30592 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30593
30594 You do not need to have a final &%accept%&, but if you do, you can use a
30595 &%message%& modifier to specify custom text that is sent as part of the 221
30596 response to QUIT.
30597
30598 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30599 failure (for example, failure to open a log file, or when Exim is bombing out
30600 because it has detected an unrecoverable error), all SMTP commands from the
30601 client are given temporary error responses until QUIT is received or the
30602 connection is closed. In these special cases, the QUIT ACL does not run.
30603
30604
30605 .subsection "The not-QUIT ACL" SECTNOTQUITACL
30606 .vindex &$acl_smtp_notquit$&
30607 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30608 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30609 trouble, such as being unable to write to its log files, this ACL is not run,
30610 because it might try to do things (such as write to log files) that make the
30611 situation even worse.
30612
30613 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30614 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30615 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30616 and &%warn%&.
30617
30618 .vindex &$smtp_notquit_reason$&
30619 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30620 to a string that indicates the reason for the termination of the SMTP
30621 connection. The possible values are:
30622 .table2
30623 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30624 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30625 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30626 .irow &`connection-lost`&          "The SMTP connection has been lost"
30627 .irow &`data-timeout`&             "Timeout while reading message data"
30628 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30629 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30630 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30631 .irow &`synchronization-error`&    "SMTP synchronization error"
30632 .irow &`tls-failed`&               "TLS failed to start"
30633 .endtable
30634 In most cases when an SMTP connection is closed without having received QUIT,
30635 Exim sends an SMTP response message before actually closing the connection.
30636 With the exception of the &`acl-drop`& case, the default message can be
30637 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30638 &%drop%& verb in another ACL, it is the message from the other ACL that is
30639 used.
30640
30641
30642 .section "Finding an ACL to use" "SECID195"
30643 .cindex "&ACL;" "finding which to use"
30644 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30645 you can use different ACLs in different circumstances. For example,
30646 .code
30647 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30648                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30649 .endd
30650 In the default configuration file there are some example settings for
30651 providing an RFC 4409 message &"submission"& service on port 587 and
30652 an RFC 8314 &"submissions"& service on port 465. You can use a string
30653 expansion like this to choose an ACL for MUAs on these ports which is
30654 more appropriate for this purpose than the default ACL on port 25.
30655
30656 The expanded string does not have to be the name of an ACL in the
30657 configuration file; there are other possibilities. Having expanded the
30658 string, Exim searches for an ACL as follows:
30659
30660 .ilist
30661 If the string begins with a slash, Exim uses it as a filename, and reads its
30662 contents as an ACL. The lines are processed in the same way as lines in the
30663 Exim configuration file. In particular, continuation lines are supported, blank
30664 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30665 If the file does not exist or cannot be read, an error occurs (typically
30666 causing a temporary failure of whatever caused the ACL to be run). For example:
30667 .code
30668 acl_smtp_data = /etc/acls/\
30669   ${lookup{$sender_host_address}lsearch\
30670   {/etc/acllist}{$value}{default}}
30671 .endd
30672 This looks up an ACL file to use on the basis of the host's IP address, falling
30673 back to a default if the lookup fails. If an ACL is successfully read from a
30674 file, it is retained in memory for the duration of the Exim process, so that it
30675 can be re-used without having to re-read the file.
30676 .next
30677 If the string does not start with a slash, and does not contain any spaces,
30678 Exim searches the ACL section of the configuration for an ACL whose name
30679 matches the string.
30680 .next
30681 If no named ACL is found, or if the string contains spaces, Exim parses
30682 the string as an inline ACL. This can save typing in cases where you just
30683 want to have something like
30684 .code
30685 acl_smtp_vrfy = accept
30686 .endd
30687 in order to allow free use of the VRFY command. Such a string may contain
30688 newlines; it is processed in the same way as an ACL that is read from a file.
30689 .endlist
30690
30691
30692
30693
30694 .section "ACL return codes" "SECID196"
30695 .cindex "&ACL;" "return codes"
30696 Except for the QUIT ACL, which does not affect the SMTP return code (see
30697 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30698 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30699 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30700 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30701 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30702 This also causes a 4&'xx'& return code.
30703
30704 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30705 &"deny"&, because there is no mechanism for passing temporary errors to the
30706 submitters of non-SMTP messages.
30707
30708
30709 ACLs that are relevant to message reception may also return &"discard"&. This
30710 has the effect of &"accept"&, but causes either the entire message or an
30711 individual recipient address to be discarded. In other words, it is a
30712 blackholing facility. Use it with care.
30713
30714 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30715 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30716 RCPT ACL is to discard just the one recipient address. If there are no
30717 recipients left when the message's data is received, the DATA ACL is not
30718 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30719 remaining recipients. The &"discard"& return is not permitted for the
30720 &%acl_smtp_predata%& ACL.
30721
30722 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30723 is done on the address and the result determines the SMTP response.
30724
30725
30726 .cindex "&[local_scan()]& function" "when all recipients discarded"
30727 The &[local_scan()]& function is always run, even if there are no remaining
30728 recipients; it may create new recipients.
30729
30730
30731
30732 .section "Unset ACL options" "SECID197"
30733 .cindex "&ACL;" "unset options"
30734 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30735 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30736 not defined at all. For any defined ACL, the default action when control
30737 reaches the end of the ACL statements is &"deny"&.
30738
30739 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30740 these two are ACLs that are used only for their side effects. They cannot be
30741 used to accept or reject anything.
30742
30743 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30744 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30745 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30746 when the ACL is not defined is &"accept"&.
30747
30748 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30749 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30750 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30751 messages over an SMTP connection. For an example, see the ACL in the default
30752 configuration file.
30753
30754
30755
30756
30757 .section "Data for message ACLs" "SECID198"
30758 .cindex "&ACL;" "data for message ACL"
30759 .vindex &$domain$&
30760 .vindex &$local_part$&
30761 .vindex &$sender_address$&
30762 .vindex &$sender_host_address$&
30763 .vindex &$smtp_command$&
30764 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30765 that contain information about the host and the message's sender (for example,
30766 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30767 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30768 &$local_part$& are set from the argument address. The entire SMTP command
30769 is available in &$smtp_command$&.
30770
30771 When an ACL for the AUTH parameter of MAIL is running, the variables that
30772 contain information about the host are set, but &$sender_address$& is not yet
30773 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30774 how it is used.
30775
30776 .vindex "&$message_size$&"
30777 The &$message_size$& variable is set to the value of the SIZE parameter on
30778 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30779 that parameter is not given. The value is updated to the true message size by
30780 the time the final DATA ACL is run (after the message data has been
30781 received).
30782
30783 .vindex "&$rcpt_count$&"
30784 .vindex "&$recipients_count$&"
30785 The &$rcpt_count$& variable increases by one for each RCPT command received.
30786 The &$recipients_count$& variable increases by one each time a RCPT command is
30787 accepted, so while an ACL for RCPT is being processed, it contains the number
30788 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30789 &$rcpt_count$& contains the total number of RCPT commands, and
30790 &$recipients_count$& contains the total number of accepted recipients.
30791
30792
30793
30794
30795
30796 .section "Data for non-message ACLs" "SECTdatfornon"
30797 .cindex "&ACL;" "data for non-message ACL"
30798 .vindex &$smtp_command_argument$&
30799 .vindex &$smtp_command$&
30800 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30801 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30802 and the entire SMTP command is available in &$smtp_command$&.
30803 These variables can be tested using a &%condition%& condition. For example,
30804 here is an ACL for use with AUTH, which insists that either the session is
30805 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30806 does not permit authentication methods that use cleartext passwords on
30807 unencrypted connections.
30808 .code
30809 acl_check_auth:
30810   accept encrypted = *
30811   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30812                      {CRAM-MD5}}
30813   deny   message   = TLS encryption or CRAM-MD5 required
30814 .endd
30815 (Another way of applying this restriction is to arrange for the authenticators
30816 that use cleartext passwords not to be advertised when the connection is not
30817 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30818 option to do this.)
30819
30820
30821
30822 .section "Format of an ACL" "SECID199"
30823 .cindex "&ACL;" "format of"
30824 .cindex "&ACL;" "verbs, definition of"
30825 An individual ACL consists of a number of statements. Each statement starts
30826 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30827 Modifiers can change the way the verb operates, define error and log messages,
30828 set variables, insert delays, and vary the processing of accepted messages.
30829
30830 If all the conditions are met, the verb is obeyed. The same condition may be
30831 used (with different arguments) more than once in the same statement. This
30832 provides a means of specifying an &"and"& conjunction between conditions. For
30833 example:
30834 .code
30835 deny  dnslists = list1.example
30836       dnslists = list2.example
30837 .endd
30838 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30839 the conditions and modifiers when it reaches a condition that fails. What
30840 happens then depends on the verb (and in one case, on a special modifier). Not
30841 all the conditions make sense at every testing point. For example, you cannot
30842 test a sender address in the ACL that is run for a VRFY command.
30843
30844
30845 .section "ACL verbs" "SECID200"
30846 The ACL verbs are as follows:
30847
30848 .ilist
30849 .cindex "&%accept%& ACL verb"
30850 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
30851 of the conditions are not met, what happens depends on whether &%endpass%&
30852 appears among the conditions (for syntax see below). If the failing condition
30853 is before &%endpass%&, control is passed to the next ACL statement; if it is
30854 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
30855 check a RCPT command:
30856 .code
30857 accept domains = +local_domains
30858        endpass
30859        verify = recipient
30860 .endd
30861 If the recipient domain does not match the &%domains%& condition, control
30862 passes to the next statement. If it does match, the recipient is verified, and
30863 the command is accepted if verification succeeds. However, if verification
30864 fails, the ACL yields &"deny"&, because the failing condition is after
30865 &%endpass%&.
30866
30867 The &%endpass%& feature has turned out to be confusing to many people, so its
30868 use is not recommended nowadays. It is always possible to rewrite an ACL so
30869 that &%endpass%& is not needed, and it is no longer used in the default
30870 configuration.
30871
30872 .cindex "&%message%& ACL modifier" "with &%accept%&"
30873 If a &%message%& modifier appears on an &%accept%& statement, its action
30874 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
30875 (when an &%accept%& verb either accepts or passes control to the next
30876 statement), &%message%& can be used to vary the message that is sent when an
30877 SMTP command is accepted. For example, in a RCPT ACL you could have:
30878 .display
30879 &`accept  `&<&'some conditions'&>
30880 &`        message = OK, I will allow you through today`&
30881 .endd
30882 You can specify an SMTP response code, optionally followed by an &"extended
30883 response code"& at the start of the message, but the first digit must be the
30884 same as would be sent by default, which is 2 for an &%accept%& verb.
30885
30886 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
30887 an error message that is used when access is denied. This behaviour is retained
30888 for backward compatibility, but current &"best practice"& is to avoid the use
30889 of &%endpass%&.
30890
30891
30892 .next
30893 .cindex "&%defer%& ACL verb"
30894 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
30895 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
30896 &%defer%& is the same as &%deny%&, because there is no way of sending a
30897 temporary error. For a RCPT command, &%defer%& is much the same as using a
30898 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
30899 be used in any ACL, and even for a recipient it might be a simpler approach.
30900
30901
30902 .next
30903 .cindex "&%deny%& ACL verb"
30904 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
30905 the conditions are not met, control is passed to the next ACL statement. For
30906 example,
30907 .code
30908 deny dnslists = blackholes.mail-abuse.org
30909 .endd
30910 rejects commands from hosts that are on a DNS black list.
30911
30912
30913 .next
30914 .cindex "&%discard%& ACL verb"
30915 &%discard%&: This verb behaves like &%accept%&, except that it returns
30916 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
30917 that are concerned with receiving messages. When all the conditions are true,
30918 the sending entity receives a &"success"& response. However, &%discard%& causes
30919 recipients to be discarded. If it is used in an ACL for RCPT, just the one
30920 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
30921 message's recipients are discarded. Recipients that are discarded before DATA
30922 do not appear in the log line when the &%received_recipients%& log selector is set.
30923
30924 If the &%log_message%& modifier is set when &%discard%& operates,
30925 its contents are added to the line that is automatically written to the log.
30926 The &%message%& modifier operates exactly as it does for &%accept%&.
30927
30928
30929 .next
30930 .cindex "&%drop%& ACL verb"
30931 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
30932 forcibly closed after the 5&'xx'& error message has been sent. For example:
30933 .code
30934 drop   condition = ${if > {$rcpt_count}{20}}
30935        message   = I don't take more than 20 RCPTs
30936 .endd
30937 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
30938 The connection is always dropped after sending a 550 response.
30939
30940 .next
30941 .cindex "&%require%& ACL verb"
30942 &%require%&: If all the conditions are met, control is passed to the next ACL
30943 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
30944 example, when checking a RCPT command,
30945 .code
30946 require message = Sender did not verify
30947         verify  = sender
30948 .endd
30949 passes control to subsequent statements only if the message's sender can be
30950 verified. Otherwise, it rejects the command. Note the positioning of the
30951 &%message%& modifier, before the &%verify%& condition. The reason for this is
30952 discussed in section &<<SECTcondmodproc>>&.
30953
30954 .next
30955 .cindex "&%warn%& ACL verb"
30956 &%warn%&: If all the conditions are true, a line specified by the
30957 &%log_message%& modifier is written to Exim's main log. Control always passes
30958 to the next ACL statement. If any condition is false, the log line is not
30959 written. If an identical log line is requested several times in the same
30960 message, only one copy is actually written to the log. If you want to force
30961 duplicates to be written, use the &%logwrite%& modifier instead.
30962
30963 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
30964 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
30965 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
30966 first failing condition. There is more about adding header lines in section
30967 &<<SECTaddheadacl>>&.
30968
30969 If any condition on a &%warn%& statement cannot be completed (that is, there is
30970 some sort of defer), the log line specified by &%log_message%& is not written.
30971 This does not include the case of a forced failure from a lookup, which
30972 is considered to be a successful completion. After a defer, no further
30973 conditions or modifiers in the &%warn%& statement are processed. The incident
30974 is logged, and the ACL continues to be processed, from the next statement
30975 onwards.
30976
30977
30978 .vindex "&$acl_verify_message$&"
30979 When one of the &%warn%& conditions is an address verification that fails, the
30980 text of the verification failure message is in &$acl_verify_message$&. If you
30981 want this logged, you must set it up explicitly. For example:
30982 .code
30983 warn   !verify = sender
30984        log_message = sender verify failed: $acl_verify_message
30985 .endd
30986 .endlist
30987
30988 At the end of each ACL there is an implicit unconditional &%deny%&.
30989
30990 As you can see from the examples above, the conditions and modifiers are
30991 written one to a line, with the first one on the same line as the verb, and
30992 subsequent ones on following lines. If you have a very long condition, you can
30993 continue it onto several physical lines by the usual backslash continuation
30994 mechanism. It is conventional to align the conditions vertically.
30995
30996
30997
30998 .section "ACL variables" "SECTaclvariables"
30999 .cindex "&ACL;" "variables"
31000 There are some special variables that can be set during ACL processing. They
31001 can be used to pass information between different ACLs, different invocations
31002 of the same ACL in the same SMTP connection, and between ACLs and the routers,
31003 transports, and filters that are used to deliver a message. The names of these
31004 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
31005 an underscore, but the remainder of the name can be any sequence of
31006 alphanumeric characters and underscores that you choose. There is no limit on
31007 the number of ACL variables. The two sets act as follows:
31008 .ilist
31009 The values of those variables whose names begin with &$acl_c$& persist
31010 throughout an SMTP connection. They are never reset. Thus, a value that is set
31011 while receiving one message is still available when receiving the next message
31012 on the same SMTP connection.
31013 .next
31014 The values of those variables whose names begin with &$acl_m$& persist only
31015 while a message is being received. They are reset afterwards. They are also
31016 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
31017 .endlist
31018
31019 When a message is accepted, the current values of all the ACL variables are
31020 preserved with the message and are subsequently made available at delivery
31021 time. The ACL variables are set by a modifier called &%set%&. For example:
31022 .code
31023 accept hosts = whatever
31024        set acl_m4 = some value
31025 accept authenticated = *
31026        set acl_c_auth = yes
31027 .endd
31028 &*Note*&: A leading dollar sign is not used when naming a variable that is to
31029 be set. If you want to set a variable without taking any action, you can use a
31030 &%warn%& verb without any other modifiers or conditions.
31031
31032 .oindex &%strict_acl_vars%&
31033 What happens if a syntactically valid but undefined ACL variable is
31034 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
31035 false (the default), an empty string is substituted; if it is true, an
31036 error is generated.
31037
31038 Versions of Exim before 4.64 have a limited set of numbered variables, but
31039 their names are compatible, so there is no problem with upgrading.
31040
31041
31042 .section "Condition and modifier processing" "SECTcondmodproc"
31043 .cindex "&ACL;" "conditions; processing"
31044 .cindex "&ACL;" "modifiers; processing"
31045 An exclamation mark preceding a condition negates its result. For example:
31046 .code
31047 deny   domains = *.dom.example
31048       !verify  = recipient
31049 .endd
31050 causes the ACL to return &"deny"& if the recipient domain ends in
31051 &'dom.example'& and the recipient address cannot be verified. Sometimes
31052 negation can be used on the right-hand side of a condition. For example, these
31053 two statements are equivalent:
31054 .code
31055 deny  hosts = !192.168.3.4
31056 deny !hosts =  192.168.3.4
31057 .endd
31058 However, for many conditions (&%verify%& being a good example), only left-hand
31059 side negation of the whole condition is possible.
31060
31061 The arguments of conditions and modifiers are expanded. A forced failure
31062 of an expansion causes a condition to be ignored, that is, it behaves as if the
31063 condition is true. Consider these two statements:
31064 .code
31065 accept  senders = ${lookup{$host_name}lsearch\
31066                   {/some/file}{$value}fail}
31067 accept  senders = ${lookup{$host_name}lsearch\
31068                   {/some/file}{$value}{}}
31069 .endd
31070 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
31071 the returned list is searched, but if the lookup fails the behaviour is
31072 different in the two cases. The &%fail%& in the first statement causes the
31073 condition to be ignored, leaving no further conditions. The &%accept%& verb
31074 therefore succeeds. The second statement, however, generates an empty list when
31075 the lookup fails. No sender can match an empty list, so the condition fails,
31076 and therefore the &%accept%& also fails.
31077
31078 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
31079 specify actions that are taken as the conditions for a statement are checked;
31080 others specify text for messages that are used when access is denied or a
31081 warning is generated. The &%control%& modifier affects the way an incoming
31082 message is handled.
31083
31084 The positioning of the modifiers in an ACL statement is important, because the
31085 processing of a verb ceases as soon as its outcome is known. Only those
31086 modifiers that have already been encountered will take effect. For example,
31087 consider this use of the &%message%& modifier:
31088 .code
31089 require message = Can't verify sender
31090         verify  = sender
31091         message = Can't verify recipient
31092         verify  = recipient
31093         message = This message cannot be used
31094 .endd
31095 If sender verification fails, Exim knows that the result of the statement is
31096 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
31097 so its text is used as the error message. If sender verification succeeds, but
31098 recipient verification fails, the second message is used. If recipient
31099 verification succeeds, the third message becomes &"current"&, but is never used
31100 because there are no more conditions to cause failure.
31101
31102 For the &%deny%& verb, on the other hand, it is always the last &%message%&
31103 modifier that is used, because all the conditions must be true for rejection to
31104 happen. Specifying more than one &%message%& modifier does not make sense, and
31105 the message can even be specified after all the conditions. For example:
31106 .code
31107 deny   hosts = ...
31108       !senders = *@my.domain.example
31109        message = Invalid sender from client host
31110 .endd
31111 The &"deny"& result does not happen until the end of the statement is reached,
31112 by which time Exim has set up the message.
31113
31114
31115
31116 .section "ACL modifiers" "SECTACLmodi"
31117 .cindex "&ACL;" "modifiers; list of"
31118 The ACL modifiers are as follows:
31119
31120 .vlist
31121 .vitem &*add_header*&&~=&~<&'text'&>
31122 This modifier specifies one or more header lines that are to be added to an
31123 incoming message, assuming, of course, that the message is ultimately
31124 accepted. For details, see section &<<SECTaddheadacl>>&.
31125
31126 .vitem &*continue*&&~=&~<&'text'&>
31127 .cindex "&%continue%& ACL modifier"
31128 .cindex "database" "updating in ACL"
31129 This modifier does nothing of itself, and processing of the ACL always
31130 continues with the next condition or modifier. The value of &%continue%& is in
31131 the side effects of expanding its argument. Typically this could be used to
31132 update a database. It is really just a syntactic tidiness, to avoid having to
31133 write rather ugly lines like this:
31134 .display
31135 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
31136 .endd
31137 Instead, all you need is
31138 .display
31139 &`continue = `&<&'some expansion'&>
31140 .endd
31141
31142 .vitem &*control*&&~=&~<&'text'&>
31143 .cindex "&%control%& ACL modifier"
31144 This modifier affects the subsequent processing of the SMTP connection or of an
31145 incoming message that is accepted. The effect of the first type of control
31146 lasts for the duration of the connection, whereas the effect of the second type
31147 lasts only until the current message has been received. The message-specific
31148 controls always apply to the whole message, not to individual recipients,
31149 even if the &%control%& modifier appears in a RCPT ACL.
31150
31151 As there are now quite a few controls that can be applied, they are described
31152 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
31153 in several different ways. For example:
31154
31155 . ==== As this is a nested list, any displays it contains must be indented
31156 . ==== as otherwise they are too far to the left. That comment applies only
31157 . ==== when xmlto and fop are used; formatting with sdop gets it right either
31158 . ==== way.
31159
31160 .ilist
31161 It can be at the end of an &%accept%& statement:
31162 .code
31163     accept  ...some conditions
31164             control = queue
31165 .endd
31166 In this case, the control is applied when this statement yields &"accept"&, in
31167 other words, when the conditions are all true.
31168
31169 .next
31170 It can be in the middle of an &%accept%& statement:
31171 .code
31172     accept  ...some conditions...
31173             control = queue
31174             ...some more conditions...
31175 .endd
31176 If the first set of conditions are true, the control is applied, even if the
31177 statement does not accept because one of the second set of conditions is false.
31178 In this case, some subsequent statement must yield &"accept"& for the control
31179 to be relevant.
31180
31181 .next
31182 It can be used with &%warn%& to apply the control, leaving the
31183 decision about accepting or denying to a subsequent verb. For
31184 example:
31185 .code
31186     warn    ...some conditions...
31187             control = freeze
31188     accept  ...
31189 .endd
31190 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
31191 &%logwrite%&, so it does not add anything to the message and does not write a
31192 log entry.
31193
31194 .next
31195 If you want to apply a control unconditionally, you can use it with a
31196 &%require%& verb. For example:
31197 .code
31198     require  control = no_multiline_responses
31199 .endd
31200 .endlist
31201
31202 .vitem &*delay*&&~=&~<&'time'&>
31203 .cindex "&%delay%& ACL modifier"
31204 .oindex "&%-bh%&"
31205 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31206 the time interval before proceeding. However, when testing Exim using the
31207 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31208 output instead). The time is given in the usual Exim notation, and the delay
31209 happens as soon as the modifier is processed. In an SMTP session, pending
31210 output is flushed before the delay is imposed.
31211
31212 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31213 example:
31214 .code
31215 deny    ...some conditions...
31216         delay = 30s
31217 .endd
31218 The delay happens if all the conditions are true, before the statement returns
31219 &"deny"&. Compare this with:
31220 .code
31221 deny    delay = 30s
31222         ...some conditions...
31223 .endd
31224 which waits for 30s before processing the conditions. The &%delay%& modifier
31225 can also be used with &%warn%& and together with &%control%&:
31226 .code
31227 warn    ...some conditions...
31228         delay = 2m
31229         control = freeze
31230 accept  ...
31231 .endd
31232
31233 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31234 responses to several commands are no longer buffered and sent in one packet (as
31235 they would normally be) because all output is flushed before imposing the
31236 delay. This optimization is disabled so that a number of small delays do not
31237 appear to the client as one large aggregated delay that might provoke an
31238 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31239 using a &%control%& modifier to set &%no_delay_flush%&.
31240
31241
31242 .vitem &*endpass*&
31243 .cindex "&%endpass%& ACL modifier"
31244 This modifier, which has no argument, is recognized only in &%accept%& and
31245 &%discard%& statements. It marks the boundary between the conditions whose
31246 failure causes control to pass to the next statement, and the conditions whose
31247 failure causes the ACL to return &"deny"&. This concept has proved to be
31248 confusing to some people, so the use of &%endpass%& is no longer recommended as
31249 &"best practice"&. See the description of &%accept%& above for more details.
31250
31251
31252 .vitem &*log_message*&&~=&~<&'text'&>
31253 .cindex "&%log_message%& ACL modifier"
31254 This modifier sets up a message that is used as part of the log message if the
31255 ACL denies access or a &%warn%& statement's conditions are true. For example:
31256 .code
31257 require log_message = wrong cipher suite $tls_in_cipher
31258         encrypted   = DES-CBC3-SHA
31259 .endd
31260 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31261 example:
31262 .display
31263 &`discard `&<&'some conditions'&>
31264 &`        log_message = Discarded $local_part@$domain because...`&
31265 .endd
31266 When access is denied, &%log_message%& adds to any underlying error message
31267 that may exist because of a condition failure. For example, while verifying a
31268 recipient address, a &':fail:'& redirection might have already set up a
31269 message.
31270
31271 The message may be defined before the conditions to which it applies, because
31272 the string expansion does not happen until Exim decides that access is to be
31273 denied. This means that any variables that are set by the condition are
31274 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31275 variables are set after a DNS black list lookup succeeds. If the expansion of
31276 &%log_message%& fails, or if the result is an empty string, the modifier is
31277 ignored.
31278
31279 .vindex "&$acl_verify_message$&"
31280 If you want to use a &%warn%& statement to log the result of an address
31281 verification, you can use &$acl_verify_message$& to include the verification
31282 error message.
31283
31284 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31285 the start of the logged message. If the same warning log message is requested
31286 more than once while receiving  a single email message, only one copy is
31287 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31288 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31289 is logged for a successful &%warn%& statement.
31290
31291 If &%log_message%& is not present and there is no underlying error message (for
31292 example, from the failure of address verification), but &%message%& is present,
31293 the &%message%& text is used for logging rejections. However, if any text for
31294 logging contains newlines, only the first line is logged. In the absence of
31295 both &%log_message%& and &%message%&, a default built-in message is used for
31296 logging rejections.
31297
31298
31299 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31300 .cindex "&%log_reject_target%& ACL modifier"
31301 .cindex "logging in ACL" "specifying which log"
31302 This modifier makes it possible to specify which logs are used for messages
31303 about ACL rejections. Its argument is a colon-separated list of words that can
31304 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31305 may be empty, in which case a rejection is not logged at all. For example, this
31306 ACL fragment writes no logging information when access is denied:
31307 .display
31308 &`deny `&<&'some conditions'&>
31309 &`     log_reject_target =`&
31310 .endd
31311 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31312 permanent and temporary rejections. Its effect lasts for the rest of the
31313 current ACL.
31314
31315
31316 .vitem &*logwrite*&&~=&~<&'text'&>
31317 .cindex "&%logwrite%& ACL modifier"
31318 .cindex "logging in ACL" "immediate"
31319 This modifier writes a message to a log file as soon as it is encountered when
31320 processing an ACL. (Compare &%log_message%&, which, except in the case of
31321 &%warn%& and &%discard%&, is used only if the ACL statement denies
31322 access.) The &%logwrite%& modifier can be used to log special incidents in
31323 ACLs. For example:
31324 .display
31325 &`accept `&<&'some special conditions'&>
31326 &`       control  = freeze`&
31327 &`       logwrite = froze message because ...`&
31328 .endd
31329 By default, the message is written to the main log. However, it may begin
31330 with a colon, followed by a comma-separated list of log names, and then
31331 another colon, to specify exactly which logs are to be written. For
31332 example:
31333 .code
31334 logwrite = :main,reject: text for main and reject logs
31335 logwrite = :panic: text for panic log only
31336 .endd
31337
31338
31339 .vitem &*message*&&~=&~<&'text'&>
31340 .cindex "&%message%& ACL modifier"
31341 This modifier sets up a text string that is expanded and used as a response
31342 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31343 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31344 there is some complication if &%endpass%& is involved; see the description of
31345 &%accept%& for details.)
31346
31347 The expansion of the message happens at the time Exim decides that the ACL is
31348 to end, not at the time it processes &%message%&. If the expansion fails, or
31349 generates an empty string, the modifier is ignored. Here is an example where
31350 &%message%& must be specified first, because the ACL ends with a rejection if
31351 the &%hosts%& condition fails:
31352 .code
31353 require  message = Host not recognized
31354          hosts = 10.0.0.0/8
31355 .endd
31356 (Once a condition has failed, no further conditions or modifiers are
31357 processed.)
31358
31359 .cindex "SMTP" "error codes"
31360 .oindex "&%smtp_banner%&
31361 For ACLs that are triggered by SMTP commands, the message is returned as part
31362 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31363 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31364 is accepted. In the case of the connect ACL, accepting with a message modifier
31365 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31366 accept message may not contain more than one line (otherwise it will be
31367 truncated at the first newline and a panic logged), and it cannot affect the
31368 EHLO options.
31369
31370 When SMTP is involved, the message may begin with an overriding response code,
31371 consisting of three digits optionally followed by an &"extended response code"&
31372 of the form &'n.n.n'&, each code being followed by a space. For example:
31373 .code
31374 deny  message = 599 1.2.3 Host not welcome
31375       hosts = 192.168.34.0/24
31376 .endd
31377 The first digit of the supplied response code must be the same as would be sent
31378 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31379 access, but for the predata ACL, note that the default success code is 354, not
31380 2&'xx'&.
31381
31382 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31383 the message modifier cannot override the 221 response code.
31384
31385 The text in a &%message%& modifier is literal; any quotes are taken as
31386 literals, but because the string is expanded, backslash escapes are processed
31387 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
31388 response.
31389
31390 .vindex "&$acl_verify_message$&"
31391 While the text is being expanded, the &$acl_verify_message$& variable
31392 contains any message previously set.
31393 Afterwards, &$acl_verify_message$& is cleared.
31394
31395 If &%message%& is used on a statement that verifies an address, the message
31396 specified overrides any message that is generated by the verification process.
31397 However, the original message is available in the variable
31398 &$acl_verify_message$&, so you can incorporate it into your message if you
31399 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31400 routers to be passed back as part of the SMTP response, you should either not
31401 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31402
31403 For compatibility with previous releases of Exim, a &%message%& modifier that
31404 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31405 modifier, but this usage is now deprecated. However, &%message%& acts only when
31406 all the conditions are true, wherever it appears in an ACL command, whereas
31407 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31408 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31409 effect.
31410
31411
31412 .vitem &*queue*&&~=&~<&'text'&>
31413 .cindex "&%queue%& ACL modifier"
31414 .cindex "named queues" "selecting in ACL"
31415 This modifier specifies the use of a named queue for spool files
31416 for the message.
31417 It can only be used before the message is received (i.e. not in
31418 the DATA ACL).
31419 This could be used, for example, for known high-volume burst sources
31420 of traffic, or for quarantine of messages.
31421 Separate queue-runner processes will be needed for named queues.
31422 If the text after expansion is empty, the default queue is used.
31423
31424
31425 .vitem &*remove_header*&&~=&~<&'text'&>
31426 This modifier specifies one or more header names in a colon-separated list
31427  that are to be removed from an incoming message, assuming, of course, that
31428 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31429
31430
31431 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31432 .cindex "&%set%& ACL modifier"
31433 This modifier puts a value into one of the ACL variables (see section
31434 &<<SECTaclvariables>>&).
31435
31436
31437 .vitem &*udpsend*&&~=&~<&'parameters'&>
31438 .cindex "UDP communications"
31439 This modifier sends a UDP packet, for purposes such as statistics
31440 collection or behaviour monitoring. The parameters are expanded, and
31441 the result of the expansion must be a colon-separated list consisting
31442 of a destination server, port number, and the packet contents. The
31443 server can be specified as a host name or IPv4 or IPv6 address. The
31444 separator can be changed with the usual angle bracket syntax. For
31445 example, you might want to collect information on which hosts connect
31446 when:
31447 .code
31448 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31449              $tod_zulu $sender_host_address
31450 .endd
31451 .endlist
31452
31453
31454
31455
31456 .section "Use of the control modifier" "SECTcontrols"
31457 .cindex "&%control%& ACL modifier"
31458 The &%control%& modifier supports the following settings:
31459
31460 .vlist
31461 .vitem &*control&~=&~allow_auth_unadvertised*&
31462 This modifier allows a client host to use the SMTP AUTH command even when it
31463 has not been advertised in response to EHLO. Furthermore, because there are
31464 apparently some really broken clients that do this, Exim will accept AUTH after
31465 HELO (rather than EHLO) when this control is set. It should be used only if you
31466 really need it, and you should limit its use to those broken clients that do
31467 not work without it. For example:
31468 .code
31469 warn hosts   = 192.168.34.25
31470      control = allow_auth_unadvertised
31471 .endd
31472 Normally, when an Exim server receives an AUTH command, it checks the name of
31473 the authentication mechanism that is given in the command to ensure that it
31474 matches an advertised mechanism. When this control is set, the check that a
31475 mechanism has been advertised is bypassed. Any configured mechanism can be used
31476 by the client. This control is permitted only in the connection and HELO ACLs.
31477
31478
31479 .vitem &*control&~=&~caseful_local_part*& &&&
31480        &*control&~=&~caselower_local_part*&
31481 .cindex "&ACL;" "case of local part in"
31482 .cindex "case of local parts"
31483 .vindex "&$local_part$&"
31484 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31485 (that is, during RCPT processing). By default, the contents of &$local_part$&
31486 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31487 any uppercase letters in the original local part are restored in &$local_part$&
31488 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31489 is encountered.
31490
31491 These controls affect only the current recipient. Moreover, they apply only to
31492 local part handling that takes place directly in the ACL (for example, as a key
31493 in lookups). If a test to verify the recipient is obeyed, the case-related
31494 handling of the local part during the verification is controlled by the router
31495 configuration (see the &%caseful_local_part%& generic router option).
31496
31497 This facility could be used, for example, to add a spam score to local parts
31498 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31499 spam score:
31500 .code
31501 warn  control = caseful_local_part
31502       set acl_m4 = ${eval:\
31503                      $acl_m4 + \
31504                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31505                     }
31506       control = caselower_local_part
31507 .endd
31508 Notice that we put back the lower cased version afterwards, assuming that
31509 is what is wanted for subsequent tests.
31510
31511
31512 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31513 .cindex "&ACL;" "cutthrough routing"
31514 .cindex "cutthrough" "requesting"
31515 This option requests delivery be attempted while the item is being received.
31516
31517 The option is usable in the RCPT ACL.
31518 If enabled for a message received via smtp and routed to an smtp transport,
31519 and only one transport, interface, destination host and port combination
31520 is used for all recipients of the message,
31521 then the delivery connection is made while the receiving connection is open
31522 and data is copied from one to the other.
31523
31524 An attempt to set this option for any recipient but the first
31525 for a mail will be quietly ignored.
31526 If a recipient-verify callout
31527 (with use_sender)
31528 connection is subsequently
31529 requested in the same ACL it is held open and used for
31530 any subsequent recipients and the data,
31531 otherwise one is made after the initial RCPT ACL completes.
31532
31533 Note that routers are used in verify mode,
31534 and cannot depend on content of received headers.
31535 Note also that headers cannot be
31536 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31537 Headers may be modified by routers (subject to the above) and transports.
31538 The &'Received-By:'& header is generated as soon as the body reception starts,
31539 rather than the traditional time after the full message is received;
31540 this will affect the timestamp.
31541
31542 All the usual ACLs are called; if one results in the message being
31543 rejected, all effort spent in delivery (including the costs on
31544 the ultimate destination) will be wasted.
31545 Note that in the case of data-time ACLs this includes the entire
31546 message body.
31547
31548 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31549 of outgoing messages is done, because it sends data to the ultimate destination
31550 before the entire message has been received from the source.
31551 It is not supported for messages received with the SMTP PRDR
31552 or CHUNKING
31553 options in use.
31554
31555 Should the ultimate destination system positively accept or reject the mail,
31556 a corresponding indication is given to the source system and nothing is queued.
31557 If the item is successfully delivered in cutthrough mode
31558 the delivery log lines are tagged with ">>" rather than "=>" and appear
31559 before the acceptance "<=" line.
31560
31561 If there is a temporary error the item is queued for later delivery in the
31562 usual fashion.
31563 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31564 to the control; the default value is &"spool"& and the alternate value
31565 &"pass"& copies an SMTP defer response from the target back to the initiator
31566 and does not queue the message.
31567 Note that this is independent of any recipient verify conditions in the ACL.
31568
31569 Delivery in this mode avoids the generation of a bounce mail to a
31570 (possibly faked)
31571 sender when the destination system is doing content-scan based rejection.
31572
31573
31574 .vitem &*control&~=&~debug/*&<&'options'&>
31575 .cindex "&ACL;" "enabling debug logging"
31576 .cindex "debugging" "enabling from an ACL"
31577 This control turns on debug logging, almost as though Exim had been invoked
31578 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31579 by default called &'debuglog'&.
31580
31581 Logging set up by the control will be maintained across spool residency.
31582
31583 Options are a slash-separated list.
31584 If an option takes an argument, the option name and argument are separated by
31585 an equals character.
31586 Several options are supported:
31587 .display
31588 tag=<&'suffix'&>         The filename can be adjusted with thise option.
31589                      The argument, which may access any variables already defined,
31590                      is appended to the default name.
31591
31592 opts=<&'debug&~options'&> The argument specififes what is to be logged,
31593                      using the same values as the &`-d`& command-line option.
31594
31595 stop                 Logging started with this control may be
31596                      stopped by using this option.
31597
31598 kill                 Logging started with this control may be
31599                      stopped by using this option.
31600                      Additionally the debug file will be removed,
31601                      providing one means for speculative debug tracing.
31602
31603 pretrigger=<&'size'&>    This option specifies a memory buffuer to be used
31604                      for pre-trigger debug capture.
31605                      Debug lines are recorded in the buffer until
31606                      and if) a trigger occurs; at which time they are
31607                      dumped to the debug file.  Newer lines displace the
31608                      oldest if the buffer is full.  After a trigger,
31609                      immediate writes to file are done as normal.
31610
31611 trigger=<&'reason'&>     This option selects cause for the pretrigger buffer
31612                      see above) to be copied to file.  A reason of $*now*
31613                      take effect immediately; one of &*paniclog*& triggers
31614                      on a write to the panic log.
31615 .endd
31616
31617 Some examples (which depend on variables that don't exist in all
31618 contexts):
31619 .code
31620       control = debug
31621       control = debug/tag=.$sender_host_address
31622       control = debug/opts=+expand+acl
31623       control = debug/tag=.$message_exim_id/opts=+expand
31624       control = debug/kill
31625       control = debug/opts=+all/pretrigger=1024/trigger=paniclog
31626       control = debug/trigger=now
31627 .endd
31628
31629
31630 .vitem &*control&~=&~dkim_disable_verify*&
31631 .cindex "disable DKIM verify"
31632 .cindex "DKIM" "disable verify"
31633 This control turns off DKIM verification processing entirely.  For details on
31634 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31635
31636
31637 .vitem &*control&~=&~dmarc_disable_verify*&
31638 .cindex "disable DMARC verify"
31639 .cindex "DMARC" "disable verify"
31640 This control turns off DMARC verification processing entirely.  For details on
31641 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31642
31643
31644 .vitem &*control&~=&~dscp/*&<&'value'&>
31645 .cindex "&ACL;" "setting DSCP value"
31646 .cindex "DSCP" "inbound"
31647 This option causes the DSCP value associated with the socket for the inbound
31648 connection to be adjusted to a given value, given as one of a number of fixed
31649 strings or to numeric value.
31650 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31651 Common values include &`throughput`&, &`mincost`&, and on newer systems
31652 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31653
31654 The outbound packets from Exim will be marked with this value in the header
31655 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31656 that these values will have any effect, not be stripped by networking
31657 equipment, or do much of anything without cooperation with your Network
31658 Engineer and those of all network operators between the source and destination.
31659
31660
31661 .vitem &*control&~=&~enforce_sync*& &&&
31662        &*control&~=&~no_enforce_sync*&
31663 .cindex "SMTP" "synchronization checking"
31664 .cindex "synchronization checking in SMTP"
31665 These controls make it possible to be selective about when SMTP synchronization
31666 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31667 state of the switch (it is true by default). See the description of this option
31668 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31669
31670 The effect of these two controls lasts for the remainder of the SMTP
31671 connection. They can appear in any ACL except the one for the non-SMTP
31672 messages. The most straightforward place to put them is in the ACL defined by
31673 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31674 before the first synchronization check. The expected use is to turn off the
31675 synchronization checks for badly-behaved hosts that you nevertheless need to
31676 work with.
31677
31678
31679 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31680 .cindex "fake defer"
31681 .cindex "defer, fake"
31682 This control works in exactly the same way as &%fakereject%& (described below)
31683 except that it causes an SMTP 450 response after the message data instead of a
31684 550 response. You must take care when using &%fakedefer%& because it causes the
31685 messages to be duplicated when the sender retries. Therefore, you should not
31686 use &%fakedefer%& if the message is to be delivered normally.
31687
31688 .vitem &*control&~=&~fakereject/*&<&'message'&>
31689 .cindex "fake rejection"
31690 .cindex "rejection, fake"
31691 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31692 words, only when an SMTP message is being received. If Exim accepts the
31693 message, instead the final 250 response, a 550 rejection message is sent.
31694 However, Exim proceeds to deliver the message as normal. The control applies
31695 only to the current message, not to any subsequent ones that may be received in
31696 the same SMTP connection.
31697
31698 The text for the 550 response is taken from the &%control%& modifier. If no
31699 message is supplied, the following is used:
31700 .code
31701 550-Your message has been rejected but is being
31702 550-kept for evaluation.
31703 550-If it was a legitimate message, it may still be
31704 550 delivered to the target recipient(s).
31705 .endd
31706 This facility should be used with extreme caution.
31707
31708 .vitem &*control&~=&~freeze*&
31709 .cindex "frozen messages" "forcing in ACL"
31710 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31711 other words, only when a message is being received. If the message is accepted,
31712 it is placed on Exim's queue and frozen. The control applies only to the
31713 current message, not to any subsequent ones that may be received in the same
31714 SMTP connection.
31715
31716 This modifier can optionally be followed by &`/no_tell`&. If the global option
31717 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31718 is told about the freezing), provided all the &*control=freeze*& modifiers that
31719 are obeyed for the current message have the &`/no_tell`& option.
31720
31721 .vitem &*control&~=&~no_delay_flush*&
31722 .cindex "SMTP" "output flushing, disabling for delay"
31723 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31724 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31725 use. This control, as long as it is encountered before the &%delay%& modifier,
31726 disables such output flushing.
31727
31728 .vitem &*control&~=&~no_callout_flush*&
31729 .cindex "SMTP" "output flushing, disabling for callout"
31730 Exim normally flushes SMTP output before performing a callout in an ACL, to
31731 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31732 use. This control, as long as it is encountered before the &%verify%& condition
31733 that causes the callout, disables such output flushing.
31734
31735 .vitem &*control&~=&~no_mbox_unspool*&
31736 This control is available when Exim is compiled with the content scanning
31737 extension. Content scanning may require a copy of the current message, or parts
31738 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31739 or spam scanner. Normally, such copies are deleted when they are no longer
31740 needed. If this control is set, the copies are not deleted. The control applies
31741 only to the current message, not to any subsequent ones that may be received in
31742 the same SMTP connection. It is provided for debugging purposes and is unlikely
31743 to be useful in production.
31744
31745 .vitem &*control&~=&~no_multiline_responses*&
31746 .cindex "multiline responses, suppressing"
31747 This control is permitted for any ACL except the one for non-SMTP messages.
31748 It seems that there are broken clients in use that cannot handle multiline
31749 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31750
31751 If this control is set, multiline SMTP responses from ACL rejections are
31752 suppressed. One way of doing this would have been to put out these responses as
31753 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31754 (&"use multiline responses for more"& it says &-- ha!), and some of the
31755 responses might get close to that. So this facility, which is after all only a
31756 sop to broken clients, is implemented by doing two very easy things:
31757
31758 .ilist
31759 Extra information that is normally output as part of a rejection caused by
31760 sender verification failure is omitted. Only the final line (typically &"sender
31761 verification failed"&) is sent.
31762 .next
31763 If a &%message%& modifier supplies a multiline response, only the first
31764 line is output.
31765 .endlist
31766
31767 The setting of the switch can, of course, be made conditional on the
31768 calling host. Its effect lasts until the end of the SMTP connection.
31769
31770 .vitem &*control&~=&~no_pipelining*&
31771 .cindex "PIPELINING" "suppressing advertising"
31772 .cindex "ESMTP extensions" PIPELINING
31773 This control turns off the advertising of the PIPELINING extension to SMTP in
31774 the current session. To be useful, it must be obeyed before Exim sends its
31775 response to an EHLO command. Therefore, it should normally appear in an ACL
31776 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31777 &%pipelining_advertise_hosts%&.
31778
31779 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31780        &*control&~=&~queue_only*&
31781 .oindex "&%queue%&"
31782 .oindex "&%queue_only%&"
31783 .cindex "queueing incoming messages"
31784 .cindex queueing "forcing in ACL"
31785 .cindex "first pass routing"
31786 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31787 other words, only when a message is being received. If the message is accepted,
31788 it is placed on Exim's queue and left there for delivery by a subsequent queue
31789 runner.
31790 If used with no options set,
31791 no immediate delivery process is started. In other words, it has the
31792 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31793
31794 If the &'first_pass_route'& option is given then
31795 the behaviour is like the command-line &'-oqds'& option;
31796 a delivery process is started which stops short of making
31797 any SMTP delivery.  The benefit is that the hints database will be updated for
31798 the message being waiting for a specific host, and a later queue run will be
31799 able to send all such messages on a single connection.
31800
31801 The control only applies to the current message, not to any subsequent ones that
31802  may be received in the same SMTP connection.
31803
31804 .vitem &*control&~=&~submission/*&<&'options'&>
31805 .cindex "message" "submission"
31806 .cindex "submission mode"
31807 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31808 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31809 the current message is a submission from a local MUA. In this case, Exim
31810 operates in &"submission mode"&, and applies certain fixups to the message if
31811 necessary. For example, it adds a &'Date:'& header line if one is not present.
31812 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31813 late (the message has already been created).
31814
31815 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31816 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31817 submission mode; the available options for this control are described there.
31818 The control applies only to the current message, not to any subsequent ones
31819 that may be received in the same SMTP connection.
31820
31821 .vitem &*control&~=&~suppress_local_fixups*&
31822 .cindex "submission fixups, suppressing"
31823 This control applies to locally submitted (non TCP/IP) messages, and is the
31824 complement of &`control = submission`&. It disables the fixups that are
31825 normally applied to locally-submitted messages. Specifically:
31826
31827 .ilist
31828 Any &'Sender:'& header line is left alone (in this respect, it is a
31829 dynamic version of &%local_sender_retain%&).
31830 .next
31831 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
31832 .next
31833 There is no check that &'From:'& corresponds to the actual sender.
31834 .endlist ilist
31835
31836 This control may be useful when a remotely-originated message is accepted,
31837 passed to some scanning program, and then re-submitted for delivery. It can be
31838 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31839 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
31840 data is read.
31841
31842 &*Note:*& This control applies only to the current message, not to any others
31843 that are being submitted at the same time using &%-bs%& or &%-bS%&.
31844
31845 .vitem &*control&~=&~utf8_downconvert*&
31846 This control enables conversion of UTF-8 in message envelope addresses
31847 to a-label form.
31848 For details see section &<<SECTi18nMTA>>&.
31849 .endlist vlist
31850
31851
31852 .section "Summary of message fixup control" "SECTsummesfix"
31853 All four possibilities for message fixups can be specified:
31854
31855 .ilist
31856 Locally submitted, fixups applied: the default.
31857 .next
31858 Locally submitted, no fixups applied: use
31859 &`control = suppress_local_fixups`&.
31860 .next
31861 Remotely submitted, no fixups applied: the default.
31862 .next
31863 Remotely submitted, fixups applied: use &`control = submission`&.
31864 .endlist
31865
31866
31867
31868 .section "Adding header lines in ACLs" "SECTaddheadacl"
31869 .cindex "header lines" "adding in an ACL"
31870 .cindex "header lines" "position of added lines"
31871 .cindex "&%add_header%& ACL modifier"
31872 The &%add_header%& modifier can be used to add one or more extra header lines
31873 to an incoming message, as in this example:
31874 .code
31875 warn dnslists = sbl.spamhaus.org : \
31876                 dialup.mail-abuse.org
31877      add_header = X-blacklisted-at: $dnslist_domain
31878 .endd
31879 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31880 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31881 receiving a message). The message must ultimately be accepted for
31882 &%add_header%& to have any significant effect. You can use &%add_header%& with
31883 any ACL verb, including &%deny%& (though this is potentially useful only in a
31884 RCPT ACL).
31885
31886 Headers will not be added to the message if the modifier is used in
31887 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31888
31889 Leading and trailing newlines are removed from
31890 the data for the &%add_header%& modifier; if it then
31891 contains one or more newlines that
31892 are not followed by a space or a tab, it is assumed to contain multiple header
31893 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
31894 front of any line that is not a valid header line.
31895
31896 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
31897 They are added to the message before processing the DATA and MIME ACLs.
31898 However, if an identical header line is requested more than once, only one copy
31899 is actually added to the message. Further header lines may be accumulated
31900 during the DATA and MIME ACLs, after which they are added to the message, again
31901 with duplicates suppressed. Thus, it is possible to add two identical header
31902 lines to an SMTP message, but only if one is added before DATA and one after.
31903 In the case of non-SMTP messages, new headers are accumulated during the
31904 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
31905 message is rejected after DATA or by the non-SMTP ACL, all added header lines
31906 are included in the entry that is written to the reject log.
31907
31908 .cindex "header lines" "added; visibility of"
31909 Header lines are not visible in string expansions
31910 of message headers
31911 until they are added to the
31912 message. It follows that header lines defined in the MAIL, RCPT, and predata
31913 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
31914 header lines that are added by the DATA or MIME ACLs are not visible in those
31915 ACLs. Because of this restriction, you cannot use header lines as a way of
31916 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
31917 this, you can use ACL variables, as described in section
31918 &<<SECTaclvariables>>&.
31919
31920 The list of headers yet to be added is given by the &%$headers_added%& variable.
31921
31922 The &%add_header%& modifier acts immediately as it is encountered during the
31923 processing of an ACL. Notice the difference between these two cases:
31924 .display
31925 &`accept add_header = ADDED: some text`&
31926 &`       `&<&'some condition'&>
31927
31928 &`accept `&<&'some condition'&>
31929 &`       add_header = ADDED: some text`&
31930 .endd
31931 In the first case, the header line is always added, whether or not the
31932 condition is true. In the second case, the header line is added only if the
31933 condition is true. Multiple occurrences of &%add_header%& may occur in the same
31934 ACL statement. All those that are encountered before a condition fails are
31935 honoured.
31936
31937 .cindex "&%warn%& ACL verb"
31938 For compatibility with previous versions of Exim, a &%message%& modifier for a
31939 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
31940 effect only if all the conditions are true, even if it appears before some of
31941 them. Furthermore, only the last occurrence of &%message%& is honoured. This
31942 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
31943 are present on a &%warn%& verb, both are processed according to their
31944 specifications.
31945
31946 By default, new header lines are added to a message at the end of the existing
31947 header lines. However, you can specify that any particular header line should
31948 be added right at the start (before all the &'Received:'& lines), immediately
31949 after the first block of &'Received:'& lines, or immediately before any line
31950 that is not a &'Received:'& or &'Resent-something:'& header.
31951
31952 This is done by specifying &":at_start:"&, &":after_received:"&, or
31953 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
31954 header line, respectively. (Header text cannot start with a colon, as there has
31955 to be a header name first.) For example:
31956 .code
31957 warn add_header = \
31958        :after_received:X-My-Header: something or other...
31959 .endd
31960 If more than one header line is supplied in a single &%add_header%& modifier,
31961 each one is treated independently and can therefore be placed differently. If
31962 you add more than one line at the start, or after the Received: block, they end
31963 up in reverse order.
31964
31965 &*Warning*&: This facility currently applies only to header lines that are
31966 added in an ACL. It does NOT work for header lines that are added in a
31967 system filter or in a router or transport.
31968
31969
31970
31971 .section "Removing header lines in ACLs" "SECTremoveheadacl"
31972 .cindex "header lines" "removing in an ACL"
31973 .cindex "header lines" "position of removed lines"
31974 .cindex "&%remove_header%& ACL modifier"
31975 The &%remove_header%& modifier can be used to remove one or more header lines
31976 from an incoming message, as in this example:
31977 .code
31978 warn   message        = Remove internal headers
31979        remove_header  = x-route-mail1 : x-route-mail2
31980 .endd
31981 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31982 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31983 receiving a message). The message must ultimately be accepted for
31984 &%remove_header%& to have any significant effect. You can use &%remove_header%&
31985 with any ACL verb, including &%deny%&, though this is really not useful for
31986 any verb that doesn't result in a delivered message.
31987
31988 Headers will not be removed from the message if the modifier is used in
31989 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31990
31991 More than one header can be removed at the same time by using a colon separated
31992 list of header names. The header matching is case insensitive. Wildcards are
31993 not permitted, nor is list expansion performed, so you cannot use hostlists to
31994 create a list of headers, however both connection and message variable expansion
31995 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
31996 .code
31997 warn   hosts           = +internal_hosts
31998        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
31999 warn   message         = Remove internal headers
32000        remove_header   = $acl_c_ihdrs
32001 .endd
32002 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
32003 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
32004 If multiple header lines match, all are removed.
32005 There is no harm in attempting to remove the same header twice nor in removing
32006 a non-existent header. Further header lines to be removed may be accumulated
32007 during the DATA and MIME ACLs, after which they are removed from the message,
32008 if present. In the case of non-SMTP messages, headers to be removed are
32009 accumulated during the non-SMTP ACLs, and are removed from the message after
32010 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
32011 ACL, there really is no effect because there is no logging of what headers
32012 would have been removed.
32013
32014 .cindex "header lines" "removed; visibility of"
32015 Header lines are not visible in string expansions until the DATA phase when it
32016 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
32017 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
32018 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
32019 this restriction, you cannot use header lines as a way of controlling data
32020 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
32021 you should instead use ACL variables, as described in section
32022 &<<SECTaclvariables>>&.
32023
32024 The &%remove_header%& modifier acts immediately as it is encountered during the
32025 processing of an ACL. Notice the difference between these two cases:
32026 .display
32027 &`accept remove_header = X-Internal`&
32028 &`       `&<&'some condition'&>
32029
32030 &`accept `&<&'some condition'&>
32031 &`       remove_header = X-Internal`&
32032 .endd
32033 In the first case, the header line is always removed, whether or not the
32034 condition is true. In the second case, the header line is removed only if the
32035 condition is true. Multiple occurrences of &%remove_header%& may occur in the
32036 same ACL statement. All those that are encountered before a condition fails
32037 are honoured.
32038
32039 &*Warning*&: This facility currently applies only to header lines that are
32040 present during ACL processing. It does NOT remove header lines that are added
32041 in a system filter or in a router or transport.
32042
32043
32044
32045
32046 .section "ACL conditions" "SECTaclconditions"
32047 .cindex "&ACL;" "conditions; list of"
32048 Some of the conditions listed in this section are available only when Exim is
32049 compiled with the content-scanning extension. They are included here briefly
32050 for completeness. More detailed descriptions can be found in the discussion on
32051 content scanning in chapter &<<CHAPexiscan>>&.
32052
32053 Not all conditions are relevant in all circumstances. For example, testing
32054 senders and recipients does not make sense in an ACL that is being run as the
32055 result of the arrival of an ETRN command, and checks on message headers can be
32056 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
32057 can use the same condition (with different parameters) more than once in the
32058 same ACL statement. This provides a way of specifying an &"and"& conjunction.
32059 The conditions are as follows:
32060
32061
32062 .vlist
32063 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
32064 .cindex "&ACL;" "nested"
32065 .cindex "&ACL;" "indirect"
32066 .cindex "&ACL;" "arguments"
32067 .cindex "&%acl%& ACL condition"
32068 The possible values of the argument are the same as for the
32069 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
32070 &"accept"& the condition is true; if it returns &"deny"& the condition is
32071 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
32072 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
32073 condition false. This means that further processing of the &%warn%& verb
32074 ceases, but processing of the ACL continues.
32075
32076 If the argument is a named ACL, up to nine space-separated optional values
32077 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
32078 and $acl_narg is set to the count of values.
32079 Previous values of these variables are restored after the call returns.
32080 The name and values are expanded separately.
32081 Note that spaces in complex expansions which are used as arguments
32082 will act as argument separators.
32083
32084 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
32085 the connection is dropped. If it returns &"discard"&, the verb must be
32086 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
32087 conditions are tested.
32088
32089 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
32090 loops. This condition allows you to use different ACLs in different
32091 circumstances. For example, different ACLs can be used to handle RCPT commands
32092 for different local users or different local domains.
32093
32094 .vitem &*authenticated&~=&~*&<&'string&~list'&>
32095 .cindex "&%authenticated%& ACL condition"
32096 .cindex "authentication" "ACL checking"
32097 .cindex "&ACL;" "testing for authentication"
32098 If the SMTP connection is not authenticated, the condition is false. Otherwise,
32099 the name of the authenticator is tested against the list. To test for
32100 authentication by any authenticator, you can set
32101 .code
32102 authenticated = *
32103 .endd
32104
32105 .vitem &*condition&~=&~*&<&'string'&>
32106 .cindex "&%condition%& ACL condition"
32107 .cindex "customizing" "ACL condition"
32108 .cindex "&ACL;" "customized test"
32109 .cindex "&ACL;" "testing, customized"
32110 This feature allows you to make up custom conditions. If the result of
32111 expanding the string is an empty string, the number zero, or one of the strings
32112 &"no"& or &"false"&, the condition is false. If the result is any non-zero
32113 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
32114 any other value, some error is assumed to have occurred, and the ACL returns
32115 &"defer"&. However, if the expansion is forced to fail, the condition is
32116 ignored. The effect is to treat it as true, whether it is positive or
32117 negative.
32118
32119 .vitem &*decode&~=&~*&<&'location'&>
32120 .cindex "&%decode%& ACL condition"
32121 This condition is available only when Exim is compiled with the
32122 content-scanning extension, and it is allowed only in the ACL defined by
32123 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
32124 If all goes well, the condition is true. It is false only if there are
32125 problems such as a syntax error or a memory shortage. For more details, see
32126 chapter &<<CHAPexiscan>>&.
32127
32128 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
32129 .cindex "&%dnslists%& ACL condition"
32130 .cindex "DNS list" "in ACL"
32131 .cindex "black list (DNS)"
32132 .cindex "&ACL;" "testing a DNS list"
32133 This condition checks for entries in DNS black lists. These are also known as
32134 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
32135 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
32136 different variants of this condition to describe briefly here. See sections
32137 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
32138
32139 .vitem &*domains&~=&~*&<&'domain&~list'&>
32140 .cindex "&%domains%& ACL condition"
32141 .cindex "domain" "ACL checking"
32142 .cindex "&ACL;" "testing a recipient domain"
32143 .vindex "&$domain_data$&"
32144 This condition is relevant only in a RCPT ACL. It checks that the domain
32145 of the recipient address is in the domain list. If percent-hack processing is
32146 enabled, it is done before this test is done. If the check succeeds with a
32147 lookup, the result of the lookup is placed in &$domain_data$& until the next
32148 &%domains%& test.
32149
32150 &*Note carefully*& (because many people seem to fall foul of this): you cannot
32151 use &%domains%& in a DATA ACL.
32152
32153
32154 .vitem &*encrypted&~=&~*&<&'string&~list'&>
32155 .cindex "&%encrypted%& ACL condition"
32156 .cindex "encryption" "checking in an ACL"
32157 .cindex "&ACL;" "testing for encryption"
32158 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
32159 name of the cipher suite in use is tested against the list. To test for
32160 encryption without testing for any specific cipher suite(s), set
32161 .code
32162 encrypted = *
32163 .endd
32164
32165
32166 .vitem &*hosts&~=&~*&<&'host&~list'&>
32167 .cindex "&%hosts%& ACL condition"
32168 .cindex "host" "ACL checking"
32169 .cindex "&ACL;" "testing the client host"
32170 This condition tests that the calling host matches the host list. If you have
32171 name lookups or wildcarded host names and IP addresses in the same host list,
32172 you should normally put the IP addresses first. For example, you could have:
32173 .code
32174 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
32175 .endd
32176 The lookup in this example uses the host name for its key. This is implied by
32177 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
32178 and it wouldn't matter which way round you had these two items.)
32179
32180 The reason for the problem with host names lies in the left-to-right way that
32181 Exim processes lists. It can test IP addresses without doing any DNS lookups,
32182 but when it reaches an item that requires a host name, it fails if it cannot
32183 find a host name to compare with the pattern. If the above list is given in the
32184 opposite order, the &%accept%& statement fails for a host whose name cannot be
32185 found, even if its IP address is 10.9.8.7.
32186
32187 If you really do want to do the name check first, and still recognize the IP
32188 address even if the name lookup fails, you can rewrite the ACL like this:
32189 .code
32190 accept hosts = dbm;/etc/friendly/hosts
32191 accept hosts = 10.9.8.7
32192 .endd
32193 The default action on failing to find the host name is to assume that the host
32194 is not in the list, so the first &%accept%& statement fails. The second
32195 statement can then check the IP address.
32196
32197 .vindex "&$host_data$&"
32198 If a &%hosts%& condition is satisfied by means of a lookup, the result
32199 of the lookup is made available in the &$host_data$& variable. This
32200 allows you, for example, to set up a statement like this:
32201 .code
32202 deny  hosts = net-lsearch;/some/file
32203       message = $host_data
32204 .endd
32205 which gives a custom error message for each denied host.
32206
32207 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
32208 .cindex "&%local_parts%& ACL condition"
32209 .cindex "local part" "ACL checking"
32210 .cindex "&ACL;" "testing a local part"
32211 .vindex "&$local_part_data$&"
32212 This condition is relevant only in a RCPT ACL. It checks that the local
32213 part of the recipient address is in the list. If percent-hack processing is
32214 enabled, it is done before this test. If the check succeeds with a lookup, the
32215 result of the lookup is placed in &$local_part_data$&, which remains set until
32216 the next &%local_parts%& test.
32217
32218 .vitem &*malware&~=&~*&<&'option'&>
32219 .cindex "&%malware%& ACL condition"
32220 .cindex "&ACL;" "virus scanning"
32221 .cindex "&ACL;" "scanning for viruses"
32222 This condition is available only when Exim is compiled with the
32223 content-scanning extension
32224 and only after a DATA command.
32225 It causes the incoming message to be scanned for
32226 viruses. For details, see chapter &<<CHAPexiscan>>&.
32227
32228 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32229 .cindex "&%mime_regex%& ACL condition"
32230 .cindex "&ACL;" "testing by regex matching"
32231 This condition is available only when Exim is compiled with the
32232 content-scanning extension, and it is allowed only in the ACL defined by
32233 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32234 with any of the regular expressions. For details, see chapter
32235 &<<CHAPexiscan>>&.
32236
32237 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32238 .cindex "rate limiting"
32239 This condition can be used to limit the rate at which a user or host submits
32240 messages. Details are given in section &<<SECTratelimiting>>&.
32241
32242 .vitem &*recipients&~=&~*&<&'address&~list'&>
32243 .cindex "&%recipients%& ACL condition"
32244 .cindex "recipient" "ACL checking"
32245 .cindex "&ACL;" "testing a recipient"
32246 This condition is relevant only in a RCPT ACL. It checks the entire
32247 recipient address against a list of recipients.
32248
32249 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32250 .cindex "&%regex%& ACL condition"
32251 .cindex "&ACL;" "testing by regex matching"
32252 This condition is available only when Exim is compiled with the
32253 content-scanning extension, and is available only in the DATA, MIME, and
32254 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32255 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32256
32257 .vitem &*seen&~=&~*&<&'parameters'&>
32258 .cindex "&%seen%& ACL condition"
32259 This condition can be used to test if a situation has been previously met,
32260 for example for greylisting.
32261 Details are given in section &<<SECTseen>>&.
32262
32263 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32264 .cindex "&%sender_domains%& ACL condition"
32265 .cindex "sender" "ACL checking"
32266 .cindex "&ACL;" "testing a sender domain"
32267 .vindex "&$domain$&"
32268 .vindex "&$sender_address_domain$&"
32269 This condition tests the domain of the sender of the message against the given
32270 domain list. &*Note*&: The domain of the sender address is in
32271 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32272 of this condition. This is an exception to the general rule for testing domain
32273 lists. It is done this way so that, if this condition is used in an ACL for a
32274 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32275 influence the sender checking.
32276
32277 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32278 relaying, because sender addresses are easily, and commonly, forged.
32279
32280 .vitem &*senders&~=&~*&<&'address&~list'&>
32281 .cindex "&%senders%& ACL condition"
32282 .cindex "sender" "ACL checking"
32283 .cindex "&ACL;" "testing a sender"
32284 This condition tests the sender of the message against the given list. To test
32285 for a bounce message, which has an empty sender, set
32286 .code
32287 senders = :
32288 .endd
32289 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32290 relaying, because sender addresses are easily, and commonly, forged.
32291
32292 .vitem &*spam&~=&~*&<&'username'&>
32293 .cindex "&%spam%& ACL condition"
32294 .cindex "&ACL;" "scanning for spam"
32295 This condition is available only when Exim is compiled with the
32296 content-scanning extension. It causes the incoming message to be scanned by
32297 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32298
32299 .vitem &*verify&~=&~certificate*&
32300 .cindex "&%verify%& ACL condition"
32301 .cindex "TLS" "client certificate verification"
32302 .cindex "certificate" "verification of client"
32303 .cindex "&ACL;" "certificate verification"
32304 .cindex "&ACL;" "testing a TLS certificate"
32305 This condition is true in an SMTP session if the session is encrypted, and a
32306 certificate was received from the client, and the certificate was verified. The
32307 server requests a certificate only if the client matches &%tls_verify_hosts%&
32308 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32309
32310 .vitem &*verify&~=&~csa*&
32311 .cindex "CSA verification"
32312 This condition checks whether the sending host (the client) is authorized to
32313 send email. Details of how this works are given in section
32314 &<<SECTverifyCSA>>&.
32315
32316 .vitem &*verify&~=&~header_names_ascii*&
32317 .cindex "&%verify%& ACL condition"
32318 .cindex "&ACL;" "verifying header names only ASCII"
32319 .cindex "header lines" "verifying header names only ASCII"
32320 .cindex "verifying" "header names only ASCII"
32321 This condition is relevant only in an ACL that is run after a message has been
32322 received.
32323 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32324 It checks all header names (not the content) to make sure
32325 there are no non-ASCII characters, also excluding control characters.  The
32326 allowable characters are decimal ASCII values 33 through 126.
32327
32328 Exim itself will handle headers with non-ASCII characters, but it can cause
32329 problems for downstream applications, so this option will allow their
32330 detection and rejection in the DATA ACL's.
32331
32332 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32333 .cindex "&%verify%& ACL condition"
32334 .cindex "&ACL;" "verifying sender in the header"
32335 .cindex "header lines" "verifying the sender in"
32336 .cindex "sender" "verifying in header"
32337 .cindex "verifying" "sender in header"
32338 This condition is relevant only in an ACL that is run after a message has been
32339 received, that is, in an ACL specified by &%acl_smtp_data%& or
32340 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32341 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32342 is loosely thought of as a &"sender"& address (hence the name of the test).
32343 However, an address that appears in one of these headers need not be an address
32344 that accepts bounce messages; only sender addresses in envelopes are required
32345 to accept bounces. Therefore, if you use the callout option on this check, you
32346 might want to arrange for a non-empty address in the MAIL command.
32347
32348 Details of address verification and the options are given later, starting at
32349 section &<<SECTaddressverification>>& (callouts are described in section
32350 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32351 condition to restrict it to bounce messages only:
32352 .code
32353 deny    senders = :
32354        !verify  = header_sender
32355         message = A valid sender header is required for bounces
32356 .endd
32357
32358 .vitem &*verify&~=&~header_syntax*&
32359 .cindex "&%verify%& ACL condition"
32360 .cindex "&ACL;" "verifying header syntax"
32361 .cindex "header lines" "verifying syntax"
32362 .cindex "verifying" "header syntax"
32363 This condition is relevant only in an ACL that is run after a message has been
32364 received, that is, in an ACL specified by &%acl_smtp_data%& or
32365 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32366 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32367 and &'Bcc:'&), returning true if there are no problems.
32368 Unqualified addresses (local parts without domains) are
32369 permitted only in locally generated messages and from hosts that match
32370 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32371 appropriate.
32372
32373 Note that this condition is a syntax check only. However, a common spamming
32374 ploy used to be to send syntactically invalid headers such as
32375 .code
32376 To: @
32377 .endd
32378 and this condition can be used to reject such messages, though they are not as
32379 common as they used to be.
32380
32381 .vitem &*verify&~=&~helo*&
32382 .cindex "&%verify%& ACL condition"
32383 .cindex "&ACL;" "verifying HELO/EHLO"
32384 .cindex "HELO" "verifying"
32385 .cindex "EHLO" "verifying"
32386 .cindex "verifying" "EHLO"
32387 .cindex "verifying" "HELO"
32388 This condition is true if a HELO or EHLO command has been received from the
32389 client host, and its contents have been verified. If there has been no previous
32390 attempt to verify the HELO/EHLO contents, it is carried out when this
32391 condition is encountered. See the description of the &%helo_verify_hosts%& and
32392 &%helo_try_verify_hosts%& options for details of how to request verification
32393 independently of this condition, and for detail of the verification.
32394
32395 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32396 option), this condition is always true.
32397
32398
32399 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32400 .cindex "verifying" "not blind"
32401 .cindex "bcc recipients, verifying none"
32402 This condition checks that there are no blind (bcc) recipients in the message.
32403 Every envelope recipient must appear either in a &'To:'& header line or in a
32404 &'Cc:'& header line for this condition to be true. Local parts are checked
32405 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32406 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32407 used only in a DATA or non-SMTP ACL.
32408
32409 There is one possible option, &`case_insensitive`&.  If this is present then
32410 local parts are checked case-insensitively.
32411
32412 There are, of course, many legitimate messages that make use of blind (bcc)
32413 recipients. This check should not be used on its own for blocking messages.
32414
32415
32416 .vitem &*verify&~=&~recipient/*&<&'options'&>
32417 .cindex "&%verify%& ACL condition"
32418 .cindex "&ACL;" "verifying recipient"
32419 .cindex "recipient" "verifying"
32420 .cindex "verifying" "recipient"
32421 .vindex "&$address_data$&"
32422 This condition is relevant only after a RCPT command. It verifies the current
32423 recipient. Details of address verification are given later, starting at section
32424 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32425 of &$address_data$& is the last value that was set while routing the address.
32426 This applies even if the verification fails. When an address that is being
32427 verified is redirected to a single address, verification continues with the new
32428 address, and in that case, the subsequent value of &$address_data$& is the
32429 value for the child address.
32430
32431 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32432 .cindex "&%verify%& ACL condition"
32433 .cindex "&ACL;" "verifying host reverse lookup"
32434 .cindex "host" "verifying reverse lookup"
32435 This condition ensures that a verified host name has been looked up from the IP
32436 address of the client host. (This may have happened already if the host name
32437 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32438 Verification ensures that the host name obtained from a reverse DNS lookup, or
32439 one of its aliases, does, when it is itself looked up in the DNS, yield the
32440 original IP address.
32441
32442 There is one possible option, &`defer_ok`&.  If this is present and a
32443 DNS operation returns a temporary error, the verify condition succeeds.
32444
32445 If this condition is used for a locally generated message (that is, when there
32446 is no client host involved), it always succeeds.
32447
32448 .vitem &*verify&~=&~sender/*&<&'options'&>
32449 .cindex "&%verify%& ACL condition"
32450 .cindex "&ACL;" "verifying sender"
32451 .cindex "sender" "verifying"
32452 .cindex "verifying" "sender"
32453 This condition is relevant only after a MAIL or RCPT command, or after a
32454 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32455 the message's sender is empty (that is, this is a bounce message), the
32456 condition is true. Otherwise, the sender address is verified.
32457
32458 .vindex "&$address_data$&"
32459 .vindex "&$sender_address_data$&"
32460 If there is data in the &$address_data$& variable at the end of routing, its
32461 value is placed in &$sender_address_data$& at the end of verification. This
32462 value can be used in subsequent conditions and modifiers in the same ACL
32463 statement. It does not persist after the end of the current statement. If you
32464 want to preserve the value for longer, you can save it in an ACL variable.
32465
32466 Details of verification are given later, starting at section
32467 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32468 to avoid doing it more than once per message.
32469
32470 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32471 .cindex "&%verify%& ACL condition"
32472 This is a variation of the previous option, in which a modified address is
32473 verified as a sender.
32474
32475 Note that '/' is legal in local-parts; if the address may have such
32476 (eg. is generated from the received message)
32477 they must be protected from the options parsing by doubling:
32478 .code
32479 verify = sender=${listquote{/}{${address:$h_sender:}}}
32480 .endd
32481 .endlist
32482
32483
32484
32485 .section "Using DNS lists" "SECTmorednslists"
32486 .cindex "DNS list" "in ACL"
32487 .cindex "black list (DNS)"
32488 .cindex "&ACL;" "testing a DNS list"
32489 In its simplest form, the &%dnslists%& condition tests whether the calling host
32490 is on at least one of a number of DNS lists by looking up the inverted IP
32491 address in one or more DNS domains. (Note that DNS list domains are not mail
32492 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32493 special options instead.) For example, if the calling host's IP
32494 address is 192.168.62.43, and the ACL statement is
32495 .code
32496 deny dnslists = blackholes.mail-abuse.org : \
32497                 dialups.mail-abuse.org
32498 .endd
32499 the following records are looked up:
32500 .code
32501 43.62.168.192.blackholes.mail-abuse.org
32502 43.62.168.192.dialups.mail-abuse.org
32503 .endd
32504 As soon as Exim finds an existing DNS record, processing of the list stops.
32505 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32506 to test that a host is on more than one list (an &"and"& conjunction), you can
32507 use two separate conditions:
32508 .code
32509 deny dnslists = blackholes.mail-abuse.org
32510      dnslists = dialups.mail-abuse.org
32511 .endd
32512 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32513 behaves as if the host does not match the list item, that is, as if the DNS
32514 record does not exist. If there are further items in the DNS list, they are
32515 processed.
32516
32517 This is usually the required action when &%dnslists%& is used with &%deny%&
32518 (which is the most common usage), because it prevents a DNS failure from
32519 blocking mail. However, you can change this behaviour by putting one of the
32520 following special items in the list:
32521 .itable none 0 0 2 25* left 75* left
32522 .irow "+include_unknown"   "behave as if the item is on the list"
32523 .irow "+exclude_unknown"   "behave as if the item is not on the list (default)"
32524 .irow "+defer_unknown  "   "give a temporary error"
32525 .endtable
32526 .cindex "&`+include_unknown`&"
32527 .cindex "&`+exclude_unknown`&"
32528 .cindex "&`+defer_unknown`&"
32529 Each of these applies to any subsequent items on the list. For example:
32530 .code
32531 deny dnslists = +defer_unknown : foo.bar.example
32532 .endd
32533 Testing the list of domains stops as soon as a match is found. If you want to
32534 warn for one list and block for another, you can use two different statements:
32535 .code
32536 deny  dnslists = blackholes.mail-abuse.org
32537 warn  dnslists = dialups.mail-abuse.org
32538       message  = X-Warn: sending host is on dialups list
32539 .endd
32540 .cindex caching "of dns lookup"
32541 .cindex DNS TTL
32542 DNS list lookups are cached by Exim for the duration of the SMTP session
32543 (but limited by the DNS return TTL value),
32544 so a lookup based on the IP address is done at most once for any incoming
32545 connection (assuming long-enough TTL).
32546 Exim does not share information between multiple incoming
32547 connections (but your local name server cache should be active).
32548
32549 There are a number of DNS lists to choose from, some commercial, some free,
32550 or free for small deployments.  An overview can be found at
32551 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32552
32553
32554
32555 .subsection "Specifying the IP address for a DNS list lookup" SECID201
32556 .cindex "DNS list" "keyed by explicit IP address"
32557 By default, the IP address that is used in a DNS list lookup is the IP address
32558 of the calling host. However, you can specify another IP address by listing it
32559 after the domain name, introduced by a slash. For example:
32560 .code
32561 deny dnslists = black.list.tld/192.168.1.2
32562 .endd
32563 This feature is not very helpful with explicit IP addresses; it is intended for
32564 use with IP addresses that are looked up, for example, the IP addresses of the
32565 MX hosts or nameservers of an email sender address. For an example, see section
32566 &<<SECTmulkeyfor>>& below.
32567
32568
32569
32570
32571 .subsection "DNS lists keyed on domain names" SECID202
32572 .cindex "DNS list" "keyed by domain name"
32573 There are some lists that are keyed on domain names rather than inverted IP
32574 addresses (see, e.g., the &'domain based zones'& link at
32575 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32576 with these lists. You can change the name that is looked up in a DNS list by
32577 listing it after the domain name, introduced by a slash. For example,
32578 .code
32579 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32580       message  = Sender's domain is listed at $dnslist_domain
32581 .endd
32582 This particular example is useful only in ACLs that are obeyed after the
32583 RCPT or DATA commands, when a sender address is available. If (for
32584 example) the message's sender is &'user@tld.example'& the name that is looked
32585 up by this example is
32586 .code
32587 tld.example.dsn.rfc-ignorant.org
32588 .endd
32589 A single &%dnslists%& condition can contain entries for both names and IP
32590 addresses. For example:
32591 .code
32592 deny dnslists = sbl.spamhaus.org : \
32593                 dsn.rfc-ignorant.org/$sender_address_domain
32594 .endd
32595 The first item checks the sending host's IP address; the second checks a domain
32596 name. The whole condition is true if either of the DNS lookups succeeds.
32597
32598
32599
32600
32601 .subsection "Multiple explicit keys for a DNS list" SECTmulkeyfor
32602 .cindex "DNS list" "multiple keys for"
32603 The syntax described above for looking up explicitly-defined values (either
32604 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32605 name for the DNS list, what follows the slash can in fact be a list of items.
32606 As with all lists in Exim, the default separator is a colon. However, because
32607 this is a sublist within the list of DNS blacklist domains, it is necessary
32608 either to double the separators like this:
32609 .code
32610 dnslists = black.list.tld/name.1::name.2
32611 .endd
32612 or to change the separator character, like this:
32613 .code
32614 dnslists = black.list.tld/<;name.1;name.2
32615 .endd
32616 If an item in the list is an IP address, it is inverted before the DNS
32617 blacklist domain is appended. If it is not an IP address, no inversion
32618 occurs. Consider this condition:
32619 .code
32620 dnslists = black.list.tld/<;192.168.1.2;a.domain
32621 .endd
32622 The DNS lookups that occur are:
32623 .code
32624 2.1.168.192.black.list.tld
32625 a.domain.black.list.tld
32626 .endd
32627 Once a DNS record has been found (that matches a specific IP return
32628 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32629 are done. If there is a temporary DNS error, the rest of the sublist of domains
32630 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32631 only if no other DNS lookup in this sublist succeeds. In other words, a
32632 successful lookup for any of the items in the sublist overrides a temporary
32633 error for a previous item.
32634
32635 The ability to supply a list of items after the slash is in some sense just a
32636 syntactic convenience. These two examples have the same effect:
32637 .code
32638 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32639 dnslists = black.list.tld/a.domain::b.domain
32640 .endd
32641 However, when the data for the list is obtained from a lookup, the second form
32642 is usually much more convenient. Consider this example:
32643 .code
32644 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32645                                    ${lookup dnsdb {>|mxh=\
32646                                    $sender_address_domain} }} }
32647      message  = The mail servers for the domain \
32648                 $sender_address_domain \
32649                 are listed at $dnslist_domain ($dnslist_value); \
32650                 see $dnslist_text.
32651 .endd
32652 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32653 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32654 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32655 of expanding the condition might be something like this:
32656 .code
32657 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32658 .endd
32659 Thus, this example checks whether or not the IP addresses of the sender
32660 domain's mail servers are on the Spamhaus black list.
32661
32662 The key that was used for a successful DNS list lookup is put into the variable
32663 &$dnslist_matched$& (see section &<<SECID204>>&).
32664
32665
32666
32667
32668 .subsection "Data returned by DNS lists" SECID203
32669 .cindex "DNS list" "data returned from"
32670 DNS lists are constructed using address records in the DNS. The original RBL
32671 just used the address 127.0.0.1 on the right hand side of each record, but the
32672 RBL+ list and some other lists use a number of values with different meanings.
32673 The values used on the RBL+ list are:
32674 .itable none 0 0 2 20* left 80* left
32675 .irow 127.1.0.1  "RBL"
32676 .irow 127.1.0.2  "DUL"
32677 .irow 127.1.0.3  "DUL and RBL"
32678 .irow 127.1.0.4  "RSS"
32679 .irow 127.1.0.5  "RSS and RBL"
32680 .irow 127.1.0.6  "RSS and DUL"
32681 .irow 127.1.0.7  "RSS and DUL and RBL"
32682 .endtable
32683 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32684 different values. Some DNS lists may return more than one address record;
32685 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32686
32687 Values returned by a properly running DBSBL should be in the 127.0.0.0/8
32688 range. If a DNSBL operator loses control of the domain, lookups on it
32689 may start returning other addresses.  Because of this, Exim now ignores
32690 returned values outside the 127/8 region.
32691
32692
32693 .subsection "Variables set from DNS lists" SECID204
32694 .cindex "expansion" "variables, set from DNS list"
32695 .cindex "DNS list" "variables set from"
32696 .vindex "&$dnslist_domain$&"
32697 .vindex "&$dnslist_matched$&"
32698 .vindex "&$dnslist_text$&"
32699 .vindex "&$dnslist_value$&"
32700 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32701 the name of the overall domain that matched (for example,
32702 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32703 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32704 the DNS record. When the key is an IP address, it is not reversed in
32705 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32706 cases, for example:
32707 .code
32708 deny dnslists = spamhaus.example
32709 .endd
32710 the key is also available in another variable (in this case,
32711 &$sender_host_address$&). In more complicated cases, however, this is not true.
32712 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32713 might generate a dnslists lookup like this:
32714 .code
32715 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32716 .endd
32717 If this condition succeeds, the value in &$dnslist_matched$& might be
32718 &`192.168.6.7`& (for example).
32719
32720 If more than one address record is returned by the DNS lookup, all the IP
32721 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32722 The variable &$dnslist_text$& contains the contents of any associated TXT
32723 record. For lists such as RBL+ the TXT record for a merged entry is often not
32724 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32725 information.
32726
32727 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32728 &-- even if these appear before the condition in the ACL, they are not
32729 expanded until after it has failed. For example:
32730 .code
32731 deny    hosts = !+local_networks
32732         message = $sender_host_address is listed \
32733                   at $dnslist_domain
32734         dnslists = rbl-plus.mail-abuse.example
32735 .endd
32736
32737
32738
32739 .subsection "Additional matching conditions for DNS lists" SECTaddmatcon
32740 .cindex "DNS list" "matching specific returned data"
32741 You can add an equals sign and an IP address after a &%dnslists%& domain name
32742 in order to restrict its action to DNS records with a matching right hand side.
32743 For example,
32744 .code
32745 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32746 .endd
32747 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32748 any address record is considered to be a match. For the moment, we assume
32749 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32750 describes how multiple records are handled.
32751
32752 More than one IP address may be given for checking, using a comma as a
32753 separator. These are alternatives &-- if any one of them matches, the
32754 &%dnslists%& condition is true. For example:
32755 .code
32756 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32757 .endd
32758 If you want to specify a constraining address list and also specify names or IP
32759 addresses to be looked up, the constraining address list must be specified
32760 first. For example:
32761 .code
32762 deny dnslists = dsn.rfc-ignorant.org\
32763                 =127.0.0.2/$sender_address_domain
32764 .endd
32765
32766 If the character &`&&`& is used instead of &`=`&, the comparison for each
32767 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32768 In other words, the listed addresses are used as bit masks. The comparison is
32769 true if all the bits in the mask are present in the address that is being
32770 tested. For example:
32771 .code
32772 dnslists = a.b.c&0.0.0.3
32773 .endd
32774 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32775 want to test whether one bit or another bit is present (as opposed to both
32776 being present), you must use multiple values. For example:
32777 .code
32778 dnslists = a.b.c&0.0.0.1,0.0.0.2
32779 .endd
32780 matches if the final component of the address is an odd number or two times
32781 an odd number.
32782
32783
32784
32785 .subsection "Negated DNS matching conditions" SECID205
32786 You can supply a negative list of IP addresses as part of a &%dnslists%&
32787 condition. Whereas
32788 .code
32789 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32790 .endd
32791 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32792 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32793 .code
32794 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32795 .endd
32796 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32797 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32798 words, the result of the test is inverted if an exclamation mark appears before
32799 the &`=`& (or the &`&&`&) sign.
32800
32801 &*Note*&: This kind of negation is not the same as negation in a domain,
32802 host, or address list (which is why the syntax is different).
32803
32804 If you are using just one list, the negation syntax does not gain you much. The
32805 previous example is precisely equivalent to
32806 .code
32807 deny  dnslists = a.b.c
32808      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32809 .endd
32810 However, if you are using multiple lists, the negation syntax is clearer.
32811 Consider this example:
32812 .code
32813 deny  dnslists = sbl.spamhaus.org : \
32814                  list.dsbl.org : \
32815                  dnsbl.njabl.org!=127.0.0.3 : \
32816                  relays.ordb.org
32817 .endd
32818 Using only positive lists, this would have to be:
32819 .code
32820 deny  dnslists = sbl.spamhaus.org : \
32821                  list.dsbl.org
32822 deny  dnslists = dnsbl.njabl.org
32823      !dnslists = dnsbl.njabl.org=127.0.0.3
32824 deny  dnslists = relays.ordb.org
32825 .endd
32826 which is less clear, and harder to maintain.
32827
32828 Negation can also be used with a bitwise-and restriction.
32829 The dnslists condition with only be trus if a result is returned
32830 by the lookup which, anded with the restriction, is all zeroes.
32831 For example:
32832 .code
32833 deny dnslists = zen.spamhaus.org!&0.255.255.0
32834 .endd
32835
32836
32837
32838
32839 .subsection "Handling multiple DNS records from a DNS list" SECThanmuldnsrec
32840 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
32841 thereby providing more than one IP address. When an item in a &%dnslists%& list
32842 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
32843 the match to specific results from the DNS lookup, there are two ways in which
32844 the checking can be handled. For example, consider the condition:
32845 .code
32846 dnslists = a.b.c=127.0.0.1
32847 .endd
32848 What happens if the DNS lookup for the incoming IP address yields both
32849 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
32850 condition true because at least one given value was found, or is it false
32851 because at least one of the found values was not listed? And how does this
32852 affect negated conditions? Both possibilities are provided for with the help of
32853 additional separators &`==`& and &`=&&`&.
32854
32855 .ilist
32856 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
32857 IP addresses matches one of the listed addresses. For the example above, the
32858 condition is true because 127.0.0.1 matches.
32859 .next
32860 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
32861 looked up IP addresses matches one of the listed addresses. If the condition is
32862 changed to:
32863 .code
32864 dnslists = a.b.c==127.0.0.1
32865 .endd
32866 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32867 false because 127.0.0.2 is not listed. You would need to have:
32868 .code
32869 dnslists = a.b.c==127.0.0.1,127.0.0.2
32870 .endd
32871 for the condition to be true.
32872 .endlist
32873
32874 When &`!`& is used to negate IP address matching, it inverts the result, giving
32875 the precise opposite of the behaviour above. Thus:
32876 .ilist
32877 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
32878 addresses matches one of the listed addresses. Consider:
32879 .code
32880 dnslists = a.b.c!&0.0.0.1
32881 .endd
32882 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32883 false because 127.0.0.1 matches.
32884 .next
32885 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
32886 looked up IP address that does not match. Consider:
32887 .code
32888 dnslists = a.b.c!=&0.0.0.1
32889 .endd
32890 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32891 true, because 127.0.0.2 does not match. You would need to have:
32892 .code
32893 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
32894 .endd
32895 for the condition to be false.
32896 .endlist
32897 When the DNS lookup yields only a single IP address, there is no difference
32898 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
32899
32900
32901
32902
32903 .subsection "Detailed information from merged DNS lists" SECTmordetinf
32904 .cindex "DNS list" "information from merged"
32905 When the facility for restricting the matching IP values in a DNS list is used,
32906 the text from the TXT record that is set in &$dnslist_text$& may not reflect
32907 the true reason for rejection. This happens when lists are merged and the IP
32908 address in the A record is used to distinguish them; unfortunately there is
32909 only one TXT record. One way round this is not to use merged lists, but that
32910 can be inefficient because it requires multiple DNS lookups where one would do
32911 in the vast majority of cases when the host of interest is not on any of the
32912 lists.
32913
32914 A less inefficient way of solving this problem is available. If
32915 two domain names, comma-separated, are given, the second is used first to
32916 do an initial check, making use of any IP value restrictions that are set.
32917 If there is a match, the first domain is used, without any IP value
32918 restrictions, to get the TXT record. As a byproduct of this, there is also
32919 a check that the IP being tested is indeed on the first list. The first
32920 domain is the one that is put in &$dnslist_domain$&. For example:
32921 .code
32922 deny   dnslists = \
32923          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
32924          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32925        message  = \
32926          rejected because $sender_host_address is blacklisted \
32927          at $dnslist_domain\n$dnslist_text
32928 .endd
32929 For the first blacklist item, this starts by doing a lookup in
32930 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
32931 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
32932 value, and as long as something is found, it looks for the corresponding TXT
32933 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
32934 The second blacklist item is processed similarly.
32935
32936 If you are interested in more than one merged list, the same list must be
32937 given several times, but because the results of the DNS lookups are cached,
32938 the DNS calls themselves are not repeated. For example:
32939 .code
32940 deny dnslists = \
32941          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
32942          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
32943          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
32944          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32945 .endd
32946 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
32947 values matches (or if no record is found), this is the only lookup that is
32948 done. Only if there is a match is one of the more specific lists consulted.
32949
32950
32951
32952 .subsection "DNS lists and IPv6" SECTmorednslistslast
32953 .cindex "IPv6" "DNS black lists"
32954 .cindex "DNS list" "IPv6 usage"
32955 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
32956 nibble by nibble. For example, if the calling host's IP address is
32957 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
32958 .code
32959 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
32960   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
32961 .endd
32962 (split over two lines here to fit on the page). Unfortunately, some of the DNS
32963 lists contain wildcard records, intended for IPv4, that interact badly with
32964 IPv6. For example, the DNS entry
32965 .code
32966 *.3.some.list.example.    A    127.0.0.1
32967 .endd
32968 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
32969 Unfortunately, it also matches the entire 3::/4 IPv6 network.
32970
32971 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
32972 &%condition%& condition, as in this example:
32973 .code
32974 deny   condition = ${if isip4{$sender_host_address}}
32975        dnslists  = some.list.example
32976 .endd
32977
32978 If an explicit key is being used for a DNS lookup and it may be an IPv6
32979 address you should specify alternate list separators for both the outer
32980 (DNS list name) list and inner (lookup keys) list:
32981 .code
32982        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
32983 .endd
32984
32985
32986 .section "Previously seen user and hosts" "SECTseen"
32987 .cindex "&%seen%& ACL condition"
32988 .cindex greylisting
32989 The &%seen%& ACL condition can be used to test whether a
32990 situation has been previously met.
32991 It uses a hints database to record a timestamp against a key.
32992 The syntax of the condition is:
32993 .display
32994 &`seen =`& <&'optional flag'&><&'time interval'&> &`/`& <&'options'&>
32995 .endd
32996
32997 For example,
32998 .code
32999 defer   seen = -5m / key=${sender_host_address}_$local_part@$domain
33000 .endd
33001 in a RCPT ACL will implement simple greylisting.
33002
33003 The parameters for the condition are
33004 a possible minus sign,
33005 then an interval,
33006 then, slash-separated, a list of options.
33007 The interval is taken as an offset before the current time,
33008 and used for the test.
33009 If the interval is preceded by a minus sign then the condition returns
33010 whether a record is found which is before the test time.
33011 Otherwise, the condition returns whether one is found which is since the
33012 test time.
33013
33014 Options are read in order with later ones overriding earlier ones.
33015
33016 The default key is &$sender_host_address$&.
33017 An explicit key can be set using a &%key=value%& option.
33018
33019 If a &%readonly%& option is given then
33020 no record create or update is done.
33021 If a &%write%& option is given then
33022 a record create or update is always done.
33023 An update is done if the test is for &"since"&.
33024 If none of those hold and there was no existing record,
33025 a record is created.
33026
33027 Creates and updates are marked with the current time.
33028
33029 Finally, a &"before"& test which succeeds, and for which the record
33030 is old enough, will be refreshed with a timestamp of the test time.
33031 This can prevent tidying of the database from removing the entry.
33032 The interval for this is, by default, 10 days.
33033 An explicit interval can be set using a
33034 &%refresh=value%& option.
33035
33036 Note that &"seen"& should be added to the list of hints databases
33037 for maintenance if this ACL condition is used.
33038
33039
33040 .section "Rate limiting incoming messages" "SECTratelimiting"
33041 .cindex "rate limiting" "client sending"
33042 .cindex "limiting client sending rates"
33043 .oindex "&%smtp_ratelimit_*%&"
33044 The &%ratelimit%& ACL condition can be used to measure and control the rate at
33045 which clients can send email. This is more powerful than the
33046 &%smtp_ratelimit_*%& options, because those options control the rate of
33047 commands in a single SMTP session only, whereas the &%ratelimit%& condition
33048 works across all connections (concurrent and sequential) from the same client
33049 host. The syntax of the &%ratelimit%& condition is:
33050 .display
33051 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
33052 .endd
33053 If the average client sending rate is less than &'m'& messages per time
33054 period &'p'& then the condition is false; otherwise it is true.
33055
33056 As a side-effect, the &%ratelimit%& condition sets the expansion variable
33057 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
33058 configured value of &'m'&, and &$sender_rate_period$& to the configured value
33059 of &'p'&.
33060
33061 The parameter &'p'& is the smoothing time constant, in the form of an Exim
33062 time interval, for example, &`8h`& for eight hours. A larger time constant
33063 means that it takes Exim longer to forget a client's past behaviour. The
33064 parameter &'m'& is the maximum number of messages that a client is permitted to
33065 send in each time interval. It also specifies the number of messages permitted
33066 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
33067 constant, you can allow a client to send more messages in a burst without
33068 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
33069 both small, messages must be sent at an even rate.
33070
33071 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
33072 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
33073 when deploying the &%ratelimit%& ACL condition. The script prints usage
33074 instructions when it is run with no arguments.
33075
33076 The key is used to look up the data for calculating the client's average
33077 sending rate. This data is stored in Exim's spool directory, alongside the
33078 retry and other hints databases. The default key is &$sender_host_address$&,
33079 which means Exim computes the sending rate of each client host IP address.
33080 By changing the key you can change how Exim identifies clients for the purpose
33081 of ratelimiting. For example, to limit the sending rate of each authenticated
33082 user, independent of the computer they are sending from, set the key to
33083 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
33084 example, &$authenticated_id$& is only meaningful if the client has
33085 authenticated (which you can check with the &%authenticated%& ACL condition).
33086
33087 The lookup key does not have to identify clients: If you want to limit the
33088 rate at which a recipient receives messages, you can use the key
33089 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
33090 ACL.
33091
33092 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
33093 specifies what Exim measures the rate of, for example, messages or recipients
33094 or bytes. You can adjust the measurement using the &%unique=%& and/or
33095 &%count=%& options. You can also control when Exim updates the recorded rate
33096 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
33097 separated by a slash, like the other parameters. They may appear in any order.
33098
33099 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
33100 any options that alter the meaning of the stored data. The limit &'m'& is not
33101 stored, so you can alter the configured maximum rate and Exim will still
33102 remember clients' past behaviour. If you change the &%per_*%& mode or add or
33103 remove the &%unique=%& option, the lookup key changes so Exim will forget past
33104 behaviour. The lookup key is not affected by changes to the update mode and
33105 the &%count=%& option.
33106
33107
33108 .subsection "Ratelimit options for what is being measured" ratoptmea
33109 .cindex "rate limiting" "per_* options"
33110 .vlist
33111 .vitem per_conn
33112 .cindex "rate limiting" per_conn
33113 This option limits the client's connection rate. It is not
33114 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
33115 &%acl_not_smtp_start%& ACLs.
33116
33117 .vitem per_mail
33118 .cindex "rate limiting" per_conn
33119 This option limits the client's rate of sending messages. This is
33120 the default if none of the &%per_*%& options is specified. It can be used in
33121 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
33122 &%acl_smtp_data%&, or &%acl_not_smtp%&.
33123
33124 .vitem per_byte
33125 .cindex "rate limiting" per_conn
33126 This option limits the sender's email bandwidth. It can be used in
33127 the same ACLs as the &%per_mail%& option, though it is best to use this option
33128 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
33129 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
33130 in its MAIL command, which may be inaccurate or completely missing. You can
33131 follow the limit &'m'& in the configuration with K, M, or G to specify limits
33132 in kilobytes, megabytes, or gigabytes, respectively.
33133
33134 .vitem per_rcpt
33135 .cindex "rate limiting" per_rcpt
33136 This option causes Exim to limit the rate at which recipients are
33137 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
33138 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
33139 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
33140 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
33141 in either case the rate limiting engine will see a message with many
33142 recipients as a large high-speed burst.
33143
33144 .vitem per_addr
33145 .cindex "rate limiting" per_addr
33146 This option is like the &%per_rcpt%& option, except it counts the
33147 number of different recipients that the client has sent messages to in the
33148 last time period. That is, if the client repeatedly sends messages to the same
33149 recipient, its measured rate is not increased. This option can only be used in
33150 &%acl_smtp_rcpt%&.
33151
33152 .vitem per_cmd
33153 .cindex "rate limiting" per_cmd
33154 This option causes Exim to recompute the rate every time the
33155 condition is processed. This can be used to limit the rate of any SMTP
33156 command. If it is used in multiple ACLs it can limit the aggregate rate of
33157 multiple different commands.
33158
33159 .vitem count
33160 .cindex "rate limiting" count
33161 This option can be used to alter how much Exim adds to the client's
33162 measured rate.
33163 A value is required, after an equals sign.
33164 For example, the &%per_byte%& option is equivalent to
33165 &`per_mail/count=$message_size`&.
33166 If there is no &%count=%& option, Exim
33167 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
33168 other than &%acl_smtp_rcpt%&).
33169 The count does not have to be an integer.
33170
33171 .vitem unique
33172 .cindex "rate limiting" unique
33173 This option is described in section &<<ratoptuniq>>& below.
33174 .endlist
33175
33176
33177 .subsection "Ratelimit update modes" ratoptupd
33178 .cindex "rate limiting" "reading data without updating"
33179 You can specify one of three options with the &%ratelimit%& condition to
33180 control when its database is updated. This section describes the &%readonly%&
33181 mode, and the next section describes the &%strict%& and &%leaky%& modes.
33182
33183 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
33184 previously-computed rate to check against the limit.
33185
33186 For example, you can test the client's sending rate and deny it access (when
33187 it is too fast) in the connect ACL. If the client passes this check then it
33188 can go on to send a message, in which case its recorded rate will be updated
33189 in the MAIL ACL. Subsequent connections from the same client will check this
33190 new rate.
33191 .code
33192 acl_check_connect:
33193  deny ratelimit = 100 / 5m / readonly
33194       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
33195                   (max $sender_rate_limit)
33196 # ...
33197 acl_check_mail:
33198  warn ratelimit = 100 / 5m / strict
33199       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
33200                   (max $sender_rate_limit)
33201 .endd
33202
33203 If Exim encounters multiple &%ratelimit%& conditions with the same key when
33204 processing a message then it may increase the client's measured rate more than
33205 it should. For example, this will happen if you check the &%per_rcpt%& option
33206 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
33207 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
33208 multiple update problems by using the &%readonly%& option on later ratelimit
33209 checks.
33210
33211 The &%per_*%& options described above do not make sense in some ACLs. If you
33212 use a &%per_*%& option in an ACL where it is not normally permitted then the
33213 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
33214 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
33215 next section) so you must specify the &%readonly%& option explicitly.
33216
33217
33218 .subsection "Ratelimit options for handling fast clients" ratoptfast
33219 .cindex "rate limiting" "strict and leaky modes"
33220 If a client's average rate is greater than the maximum, the rate limiting
33221 engine can react in two possible ways, depending on the presence of the
33222 &%strict%& or &%leaky%& update modes. This is independent of the other
33223 counter-measures (such as rejecting the message) that may be specified by the
33224 rest of the ACL.
33225
33226 The &%leaky%& (default) option means that the client's recorded rate is not
33227 updated if it is above the limit. The effect of this is that Exim measures the
33228 client's average rate of successfully sent email,
33229 up to the given limit.
33230 This is appropriate if the countermeasure when the condition is true
33231 consists of refusing the message, and
33232 is generally the better choice if you have clients that retry automatically.
33233 If the action when true is anything more complex then this option is
33234 likely not what is wanted.
33235
33236 The &%strict%& option means that the client's recorded rate is always
33237 updated. The effect of this is that Exim measures the client's average rate
33238 of attempts to send email, which can be much higher than the maximum it is
33239 actually allowed. If the client is over the limit it may be subjected to
33240 counter-measures by the ACL. It must slow down and allow sufficient time to
33241 pass that its computed rate falls below the maximum before it can send email
33242 again. The time (the number of smoothing periods) it must wait and not
33243 attempt to send mail can be calculated with this formula:
33244 .code
33245         ln(peakrate/maxrate)
33246 .endd
33247
33248
33249 .subsection "Limiting the rate of different events" ratoptuniq
33250 .cindex "rate limiting" "counting unique events"
33251 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
33252 rate of different events. For example, the &%per_addr%& option uses this
33253 mechanism to count the number of different recipients that the client has
33254 sent messages to in the last time period; it is equivalent to
33255 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
33256 measure the rate that a client uses different sender addresses with the
33257 options &`per_mail/unique=$sender_address`&.
33258
33259 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
33260 has seen for that key. The whole set is thrown away when it is older than the
33261 rate smoothing period &'p'&, so each different event is counted at most once
33262 per period. In the &%leaky%& update mode, an event that causes the client to
33263 go over the limit is not added to the set, in the same way that the client's
33264 recorded rate is not updated in the same situation.
33265
33266 When you combine the &%unique=%& and &%readonly%& options, the specific
33267 &%unique=%& value is ignored, and Exim just retrieves the client's stored
33268 rate.
33269
33270 The &%unique=%& mechanism needs more space in the ratelimit database than the
33271 other &%ratelimit%& options in order to store the event set. The number of
33272 unique values is potentially as large as the rate limit, so the extra space
33273 required increases with larger limits.
33274
33275 The uniqueification is not perfect: there is a small probability that Exim
33276 will think a new event has happened before. If the sender's rate is less than
33277 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
33278 the measured rate can go above the limit, in which case Exim may under-count
33279 events by a significant margin. Fortunately, if the rate is high enough (2.7
33280 times the limit) that the false positive rate goes above 9%, then Exim will
33281 throw away the over-full event set before the measured rate falls below the
33282 limit. Therefore the only harm should be that exceptionally high sending rates
33283 are logged incorrectly; any countermeasures you configure will be as effective
33284 as intended.
33285
33286
33287 .subsection "Using rate limiting" useratlim
33288 Exim's other ACL facilities are used to define what counter-measures are taken
33289 when the rate limit is exceeded. This might be anything from logging a warning
33290 (for example, while measuring existing sending rates in order to define
33291 policy), through time delays to slow down fast senders, up to rejecting the
33292 message. For example:
33293 .code
33294 # Log all senders' rates
33295 warn ratelimit = 0 / 1h / strict
33296      log_message = Sender rate $sender_rate / $sender_rate_period
33297
33298 # Slow down fast senders; note the need to truncate $sender_rate
33299 # at the decimal point.
33300 warn ratelimit = 100 / 1h / per_rcpt / strict
33301      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
33302                    $sender_rate_limit }s
33303
33304 # Keep authenticated users under control
33305 deny authenticated = *
33306      ratelimit = 100 / 1d / strict / $authenticated_id
33307
33308 # System-wide rate limit
33309 defer ratelimit = 10 / 1s / $primary_hostname
33310       message = Sorry, too busy. Try again later.
33311
33312 # Restrict incoming rate from each host, with a default
33313 # set using a macro and special cases looked up in a table.
33314 defer ratelimit = ${lookup {$sender_host_address} \
33315                    cdb {DB/ratelimits.cdb} \
33316                    {$value} {RATELIMIT} }
33317       message = Sender rate exceeds $sender_rate_limit \
33318                messages per $sender_rate_period
33319 .endd
33320 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
33321 especially with the &%per_rcpt%& option, you may suffer from a performance
33322 bottleneck caused by locking on the ratelimit hints database. Apart from
33323 making your ACLs less complicated, you can reduce the problem by using a
33324 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
33325 this means that Exim will lose its hints data after a reboot (including retry
33326 hints, the callout cache, and ratelimit data).
33327
33328
33329
33330 .section "Address verification" "SECTaddressverification"
33331 .cindex "verifying address" "options for"
33332 .cindex "policy control" "address verification"
33333 Several of the &%verify%& conditions described in section
33334 &<<SECTaclconditions>>& cause addresses to be verified. Section
33335 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33336 The verification conditions can be followed by options that modify the
33337 verification process. The options are separated from the keyword and from each
33338 other by slashes, and some of them contain parameters. For example:
33339 .code
33340 verify = sender/callout
33341 verify = recipient/defer_ok/callout=10s,defer_ok
33342 .endd
33343 The first stage of address verification, which always happens, is to run the
33344 address through the routers, in &"verify mode"&. Routers can detect the
33345 difference between verification and routing for delivery, and their actions can
33346 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33347 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33348 The available options are as follows:
33349
33350 .ilist
33351 If the &%callout%& option is specified, successful routing to one or more
33352 remote hosts is followed by a &"callout"& to those hosts as an additional
33353 check. Callouts and their sub-options are discussed in the next section.
33354 .next
33355 If there is a defer error while doing verification routing, the ACL
33356 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33357 options, the condition is forced to be true instead. Note that this is a main
33358 verification option as well as a suboption for callouts.
33359 .next
33360 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33361 discusses the reporting of sender address verification failures.
33362 .next
33363 The &%success_on_redirect%& option causes verification always to succeed
33364 immediately after a successful redirection. By default, if a redirection
33365 generates just one address, that address is also verified. See further
33366 discussion in section &<<SECTredirwhilveri>>&.
33367 .next
33368 If the &%quota%& option is specified for recipient verify,
33369 successful routing to an appendfile transport is followed by a call into
33370 the transport to evaluate the quota status for the recipient.
33371 No actual delivery is done, but verification will succeed if the quota
33372 is sufficient for the message (if the sender gave a message size) or
33373 not already exceeded (otherwise).
33374 .endlist
33375
33376 .cindex "verifying address" "differentiating failures"
33377 .vindex "&$recipient_verify_failure$&"
33378 .vindex "&$sender_verify_failure$&"
33379 .vindex "&$acl_verify_message$&"
33380 After an address verification failure, &$acl_verify_message$& contains the
33381 error message that is associated with the failure. It can be preserved by
33382 coding like this:
33383 .code
33384 warn  !verify = sender
33385        set acl_m0 = $acl_verify_message
33386 .endd
33387 If you are writing your own custom rejection message or log message when
33388 denying access, you can use this variable to include information about the
33389 verification failure.
33390 This variable is cleared at the end of processing the ACL verb.
33391
33392 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33393 appropriate) contains one of the following words:
33394
33395 .ilist
33396 &%qualify%&: The address was unqualified (no domain), and the message
33397 was neither local nor came from an exempted host.
33398 .next
33399 &%route%&: Routing failed.
33400 .next
33401 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33402 occurred at or before the MAIL command (that is, on initial
33403 connection, HELO, or MAIL).
33404 .next
33405 &%recipient%&: The RCPT command in a callout was rejected.
33406 .next
33407 &%postmaster%&: The postmaster check in a callout was rejected.
33408 .next
33409 &%quota%&: The quota check for a local recipient did non pass.
33410 .endlist
33411
33412 The main use of these variables is expected to be to distinguish between
33413 rejections of MAIL and rejections of RCPT in callouts.
33414
33415 The above variables may also be set after a &*successful*&
33416 address verification to:
33417
33418 .ilist
33419 &%random%&: A random local-part callout succeeded
33420 .endlist
33421
33422
33423
33424
33425 .section "Callout verification" "SECTcallver"
33426 .cindex "verifying address" "by callout"
33427 .cindex "callout" "verification"
33428 .cindex "SMTP" "callout verification"
33429 For non-local addresses, routing verifies the domain, but is unable to do any
33430 checking of the local part. There are situations where some means of verifying
33431 the local part is desirable. One way this can be done is to make an SMTP
33432 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33433 a subsequent host for a recipient address, to see if the host accepts the
33434 address. We use the term &'callout'& to cover both cases. Note that for a
33435 sender address, the callback is not to the client host that is trying to
33436 deliver the message, but to one of the hosts that accepts incoming mail for the
33437 sender's domain.
33438
33439 Exim does not do callouts by default. If you want them to happen, you must
33440 request them by setting appropriate options on the &%verify%& condition, as
33441 described below. This facility should be used with care, because it can add a
33442 lot of resource usage to the cost of verifying an address. However, Exim does
33443 cache the results of callouts, which helps to reduce the cost. Details of
33444 caching are in section &<<SECTcallvercache>>&.
33445
33446 Recipient callouts are usually used only between hosts that are controlled by
33447 the same administration. For example, a corporate gateway host could use
33448 callouts to check for valid recipients on an internal mailserver. A successful
33449 callout does not guarantee that a real delivery to the address would succeed;
33450 on the other hand, a failing callout does guarantee that a delivery would fail.
33451
33452 If the &%callout%& option is present on a condition that verifies an address, a
33453 second stage of verification occurs if the address is successfully routed to
33454 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33455 &(manualroute)& router, where the router specifies the hosts. However, if a
33456 router that does not set up hosts routes to an &(smtp)& transport with a
33457 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33458 &%hosts_override%& set, its hosts are always used, whether or not the router
33459 supplies a host list.
33460 Callouts are only supported on &(smtp)& transports.
33461
33462 The port that is used is taken from the transport, if it is specified and is a
33463 remote transport. (For routers that do verification only, no transport need be
33464 specified.) Otherwise, the default SMTP port is used. If a remote transport
33465 specifies an outgoing interface, this is used; otherwise the interface is not
33466 specified. Likewise, the text that is used for the HELO command is taken from
33467 the transport's &%helo_data%& option; if there is no transport, the value of
33468 &$smtp_active_hostname$& is used.
33469
33470 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33471 test whether a bounce message could be delivered to the sender address. The
33472 following SMTP commands are sent:
33473 .display
33474 &`HELO `&<&'local host name'&>
33475 &`MAIL FROM:<>`&
33476 &`RCPT TO:`&<&'the address to be tested'&>
33477 &`QUIT`&
33478 .endd
33479 LHLO is used instead of HELO if the transport's &%protocol%& option is
33480 set to &"lmtp"&.
33481
33482 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33483 settings.
33484
33485 A recipient callout check is similar. By default, it also uses an empty address
33486 for the sender. This default is chosen because most hosts do not make use of
33487 the sender address when verifying a recipient. Using the same address means
33488 that a single cache entry can be used for each recipient. Some sites, however,
33489 do make use of the sender address when verifying. These are catered for by the
33490 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33491
33492 If the response to the RCPT command is a 2&'xx'& code, the verification
33493 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33494 Exim tries the next host, if any. If there is a problem with all the remote
33495 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33496 &%callout%& option is given, in which case the condition is forced to succeed.
33497
33498 .cindex "SMTP" "output flushing, disabling for callout"
33499 A callout may take a little time. For this reason, Exim normally flushes SMTP
33500 output before performing a callout in an ACL, to avoid unexpected timeouts in
33501 clients when the SMTP PIPELINING extension is in use. The flushing can be
33502 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33503
33504 .cindex "tainted data" "de-tainting"
33505 .cindex "de-tainting" "using recipient verify"
33506 A recipient callout which gets a 2&'xx'& code
33507 will assign untainted values to the
33508 &$domain_data$& and &$local_part_data$& variables,
33509 corresponding to the domain and local parts of the recipient address.
33510
33511
33512
33513
33514 .subsection "Additional parameters for callouts" CALLaddparcall
33515 .cindex "callout" "additional parameters for"
33516 The &%callout%& option can be followed by an equals sign and a number of
33517 optional parameters, separated by commas. For example:
33518 .code
33519 verify = recipient/callout=10s,defer_ok
33520 .endd
33521 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33522 separate verify options, is retained for backwards compatibility, but is now
33523 deprecated. The additional parameters for &%callout%& are as follows:
33524
33525
33526 .vlist
33527 .vitem <&'a&~time&~interval'&>
33528 .cindex "callout" "timeout, specifying"
33529 This specifies the timeout that applies for the callout attempt to each host.
33530 For example:
33531 .code
33532 verify = sender/callout=5s
33533 .endd
33534 The default is 30 seconds. The timeout is used for each response from the
33535 remote host. It is also used for the initial connection, unless overridden by
33536 the &%connect%& parameter.
33537
33538
33539 .vitem &*connect&~=&~*&<&'time&~interval'&>
33540 .cindex "callout" "connection timeout, specifying"
33541 This parameter makes it possible to set a different (usually smaller) timeout
33542 for making the SMTP connection. For example:
33543 .code
33544 verify = sender/callout=5s,connect=1s
33545 .endd
33546 If not specified, this timeout defaults to the general timeout value.
33547
33548 .vitem &*defer_ok*&
33549 .cindex "callout" "defer, action on"
33550 When this parameter is present, failure to contact any host, or any other kind
33551 of temporary error, is treated as success by the ACL. However, the cache is not
33552 updated in this circumstance.
33553
33554 .vitem &*fullpostmaster*&
33555 .cindex "callout" "full postmaster check"
33556 This operates like the &%postmaster%& option (see below), but if the check for
33557 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33558 accordance with the specification in RFC 2821. The RFC states that the
33559 unqualified address &'postmaster'& should be accepted.
33560
33561
33562 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
33563 .cindex "callout" "sender when verifying header"
33564 When verifying addresses in header lines using the &%header_sender%&
33565 verification option, Exim behaves by default as if the addresses are envelope
33566 sender addresses from a message. Callout verification therefore tests to see
33567 whether a bounce message could be delivered, by using an empty address in the
33568 MAIL command. However, it is arguable that these addresses might never be used
33569 as envelope senders, and could therefore justifiably reject bounce messages
33570 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
33571 address to use in the MAIL command. For example:
33572 .code
33573 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
33574 .endd
33575 This parameter is available only for the &%header_sender%& verification option.
33576
33577
33578 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33579 .cindex "callout" "overall timeout, specifying"
33580 This parameter sets an overall timeout for performing a callout verification.
33581 For example:
33582 .code
33583 verify = sender/callout=5s,maxwait=30s
33584 .endd
33585 This timeout defaults to four times the callout timeout for individual SMTP
33586 commands. The overall timeout applies when there is more than one host that can
33587 be tried. The timeout is checked before trying the next host. This prevents
33588 very long delays if there are a large number of hosts and all are timing out
33589 (for example, when network connections are timing out).
33590
33591
33592 .vitem &*no_cache*&
33593 .cindex "callout" "cache, suppressing"
33594 .cindex "caching callout, suppressing"
33595 When this parameter is given, the callout cache is neither read nor updated.
33596
33597 .vitem &*postmaster*&
33598 .cindex "callout" "postmaster; checking"
33599 When this parameter is set, a successful callout check is followed by a similar
33600 check for the local part &'postmaster'& at the same domain. If this address is
33601 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33602 the postmaster check is recorded in a cache record; if it is a failure, this is
33603 used to fail subsequent callouts for the domain without a connection being
33604 made, until the cache record expires.
33605
33606 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
33607 The postmaster check uses an empty sender in the MAIL command by default.
33608 You can use this parameter to do a postmaster check using a different address.
33609 For example:
33610 .code
33611 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33612 .endd
33613 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33614 one overrides. The &%postmaster%& parameter is equivalent to this example:
33615 .code
33616 require  verify = sender/callout=postmaster_mailfrom=
33617 .endd
33618 &*Warning*&: The caching arrangements for postmaster checking do not take
33619 account of the sender address. It is assumed that either the empty address or
33620 a fixed non-empty address will be used. All that Exim remembers is that the
33621 postmaster check for the domain succeeded or failed.
33622
33623
33624 .vitem &*random*&
33625 .cindex "callout" "&""random""& check"
33626 When this parameter is set, before doing the normal callout check, Exim does a
33627 check for a &"random"& local part at the same domain. The local part is not
33628 really random &-- it is defined by the expansion of the option
33629 &%callout_random_local_part%&, which defaults to
33630 .code
33631 $primary_hostname-$tod_epoch-testing
33632 .endd
33633 The idea here is to try to determine whether the remote host accepts all local
33634 parts without checking. If it does, there is no point in doing callouts for
33635 specific local parts. If the &"random"& check succeeds, the result is saved in
33636 a cache record, and used to force the current and subsequent callout checks to
33637 succeed without a connection being made, until the cache record expires.
33638
33639 .vitem &*use_postmaster*&
33640 .cindex "callout" "sender for recipient check"
33641 This parameter applies to recipient callouts only. For example:
33642 .code
33643 deny  !verify = recipient/callout=use_postmaster
33644 .endd
33645 .vindex "&$qualify_domain$&"
33646 It causes a non-empty postmaster address to be used in the MAIL command when
33647 performing the callout for the recipient, and also for a &"random"& check if
33648 that is configured. The local part of the address is &`postmaster`& and the
33649 domain is the contents of &$qualify_domain$&.
33650
33651 .vitem &*use_sender*&
33652 This option applies to recipient callouts only. For example:
33653 .code
33654 require  verify = recipient/callout=use_sender
33655 .endd
33656 It causes the message's actual sender address to be used in the MAIL
33657 command when performing the callout, instead of an empty address. There is no
33658 need to use this option unless you know that the called hosts make use of the
33659 sender when checking recipients. If used indiscriminately, it reduces the
33660 usefulness of callout caching.
33661
33662 .vitem &*hold*&
33663 This option applies to recipient callouts only. For example:
33664 .code
33665 require  verify = recipient/callout=use_sender,hold
33666 .endd
33667 It causes the connection to be held open and used for any further recipients
33668 and for eventual delivery (should that be done quickly).
33669 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33670 when that is used for the connections.
33671 The advantage is only gained if there are no callout cache hits
33672 (which could be enforced by the no_cache option),
33673 if the use_sender option is used,
33674 if neither the random nor the use_postmaster option is used,
33675 and if no other callouts intervene.
33676 .endlist
33677
33678 If you use any of the parameters that set a non-empty sender for the MAIL
33679 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33680 &%use_sender%&), you should think about possible loops. Recipient checking is
33681 usually done between two hosts that are under the same management, and the host
33682 that receives the callouts is not normally configured to do callouts itself.
33683 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33684 these circumstances.
33685
33686 However, if you use a non-empty sender address for a callout to an arbitrary
33687 host, there is the likelihood that the remote host will itself initiate a
33688 callout check back to your host. As it is checking what appears to be a message
33689 sender, it is likely to use an empty address in MAIL, thus avoiding a
33690 callout loop. However, to be on the safe side it would be best to set up your
33691 own ACLs so that they do not do sender verification checks when the recipient
33692 is the address you use for header sender or postmaster callout checking.
33693
33694 Another issue to think about when using non-empty senders for callouts is
33695 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33696 by the sender/recipient combination; thus, for any given recipient, many more
33697 actual callouts are performed than when an empty sender or postmaster is used.
33698
33699
33700
33701
33702 .subsection "Callout caching" SECTcallvercache
33703 .cindex "hints database" "callout cache"
33704 .cindex "callout" "cache, description of"
33705 .cindex "caching" "callout"
33706 Exim caches the results of callouts in order to reduce the amount of resources
33707 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33708 option. A hints database called &"callout"& is used for the cache. Two
33709 different record types are used: one records the result of a callout check for
33710 a specific address, and the other records information that applies to the
33711 entire domain (for example, that it accepts the local part &'postmaster'&).
33712
33713 When an original callout fails, a detailed SMTP error message is given about
33714 the failure. However, for subsequent failures that use the cache data, this message
33715 is not available.
33716
33717 The expiry times for negative and positive address cache records are
33718 independent, and can be set by the global options &%callout_negative_expire%&
33719 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33720
33721 If a host gives a negative response to an SMTP connection, or rejects any
33722 commands up to and including
33723 .code
33724 MAIL FROM:<>
33725 .endd
33726 (but not including the MAIL command with a non-empty address),
33727 any callout attempt is bound to fail. Exim remembers such failures in a
33728 domain cache record, which it uses to fail callouts for the domain without
33729 making new connections, until the domain record times out. There are two
33730 separate expiry times for domain cache records:
33731 &%callout_domain_negative_expire%& (default 3h) and
33732 &%callout_domain_positive_expire%& (default 7d).
33733
33734 Domain records expire when the negative expiry time is reached if callouts
33735 cannot be made for the domain, or if the postmaster check failed.
33736 Otherwise, they expire when the positive expiry time is reached. This
33737 ensures that, for example, a host that stops accepting &"random"& local parts
33738 will eventually be noticed.
33739
33740 The callout caching mechanism is based on the domain of the address that is
33741 being tested. If the domain routes to several hosts, it is assumed that their
33742 behaviour will be the same.
33743
33744
33745
33746 .section "Quota caching" "SECTquotacache"
33747 .cindex "hints database" "quota cache"
33748 .cindex "quota" "cache, description of"
33749 .cindex "caching" "quota"
33750 Exim caches the results of quota verification
33751 in order to reduce the amount of resources used.
33752 The &"callout"& hints database is used.
33753
33754 The default cache periods are five minutes for a positive (good) result
33755 and one hour for a negative result.
33756 To change the periods the &%quota%& option can be followed by an equals sign
33757 and a number of optional paramemters, separated by commas.
33758 For example:
33759 .code
33760 verify = recipient/quota=cachepos=1h,cacheneg=1d
33761 .endd
33762 Possible parameters are:
33763 .vlist
33764 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33765 .cindex "quota cache" "positive entry expiry, specifying"
33766 Set the lifetime for a positive cache entry.
33767 A value of zero seconds is legitimate.
33768
33769 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33770 .cindex "quota cache" "negative entry expiry, specifying"
33771 As above, for a negative entry.
33772
33773 .vitem &*no_cache*&
33774 Set both positive and negative lifetimes to zero.
33775
33776 .section "Sender address verification reporting" "SECTsenaddver"
33777 .cindex "verifying" "suppressing error details"
33778 See section &<<SECTaddressverification>>& for a general discussion of
33779 verification. When sender verification fails in an ACL, the details of the
33780 failure are given as additional output lines before the 550 response to the
33781 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33782 you might see:
33783 .code
33784 MAIL FROM:<xyz@abc.example>
33785 250 OK
33786 RCPT TO:<pqr@def.example>
33787 550-Verification failed for <xyz@abc.example>
33788 550-Called:   192.168.34.43
33789 550-Sent:     RCPT TO:<xyz@abc.example>
33790 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33791 550 Sender verification failed
33792 .endd
33793 If more than one RCPT command fails in the same way, the details are given
33794 only for the first of them. However, some administrators do not want to send
33795 out this much information. You can suppress the details by adding
33796 &`/no_details`& to the ACL statement that requests sender verification. For
33797 example:
33798 .code
33799 verify = sender/no_details
33800 .endd
33801
33802 .section "Redirection while verifying" "SECTredirwhilveri"
33803 .cindex "verifying" "redirection while"
33804 .cindex "address redirection" "while verifying"
33805 A dilemma arises when a local address is redirected by aliasing or forwarding
33806 during verification: should the generated addresses themselves be verified,
33807 or should the successful expansion of the original address be enough to verify
33808 it? By default, Exim takes the following pragmatic approach:
33809
33810 .ilist
33811 When an incoming address is redirected to just one child address, verification
33812 continues with the child address, and if that fails to verify, the original
33813 verification also fails.
33814 .next
33815 When an incoming address is redirected to more than one child address,
33816 verification does not continue. A success result is returned.
33817 .endlist
33818
33819 This seems the most reasonable behaviour for the common use of aliasing as a
33820 way of redirecting different local parts to the same mailbox. It means, for
33821 example, that a pair of alias entries of the form
33822 .code
33823 A.Wol:   aw123
33824 aw123:   :fail: Gone away, no forwarding address
33825 .endd
33826 work as expected, with both local parts causing verification failure. When a
33827 redirection generates more than one address, the behaviour is more like a
33828 mailing list, where the existence of the alias itself is sufficient for
33829 verification to succeed.
33830
33831 It is possible, however, to change the default behaviour so that all successful
33832 redirections count as successful verifications, however many new addresses are
33833 generated. This is specified by the &%success_on_redirect%& verification
33834 option. For example:
33835 .code
33836 require verify = recipient/success_on_redirect/callout=10s
33837 .endd
33838 In this example, verification succeeds if a router generates a new address, and
33839 the callout does not occur, because no address was routed to a remote host.
33840
33841 When verification is being tested via the &%-bv%& option, the treatment of
33842 redirections is as just described, unless the &%-v%& or any debugging option is
33843 also specified. In that case, full verification is done for every generated
33844 address and a report is output for each of them.
33845
33846
33847
33848 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
33849 .cindex "CSA" "verifying"
33850 Client SMTP Authorization is a system that allows a site to advertise
33851 which machines are and are not permitted to send email. This is done by placing
33852 special SRV records in the DNS; these are looked up using the client's HELO
33853 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
33854 Authorization checks in Exim are performed by the ACL condition:
33855 .code
33856 verify = csa
33857 .endd
33858 This fails if the client is not authorized. If there is a DNS problem, or if no
33859 valid CSA SRV record is found, or if the client is authorized, the condition
33860 succeeds. These three cases can be distinguished using the expansion variable
33861 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
33862 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
33863 be likely to cause problems for legitimate email.
33864
33865 The error messages produced by the CSA code include slightly more
33866 detail. If &$csa_status$& is &"defer"&, this may be because of problems
33867 looking up the CSA SRV record, or problems looking up the CSA target
33868 address record. There are four reasons for &$csa_status$& being &"fail"&:
33869
33870 .ilist
33871 The client's host name is explicitly not authorized.
33872 .next
33873 The client's IP address does not match any of the CSA target IP addresses.
33874 .next
33875 The client's host name is authorized but it has no valid target IP addresses
33876 (for example, the target's addresses are IPv6 and the client is using IPv4).
33877 .next
33878 The client's host name has no CSA SRV record but a parent domain has asserted
33879 that all subdomains must be explicitly authorized.
33880 .endlist
33881
33882 The &%csa%& verification condition can take an argument which is the domain to
33883 use for the DNS query. The default is:
33884 .code
33885 verify = csa/$sender_helo_name
33886 .endd
33887 This implementation includes an extension to CSA. If the query domain
33888 is an address literal such as [192.0.2.95], or if it is a bare IP
33889 address, Exim searches for CSA SRV records in the reverse DNS as if
33890 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
33891 meaningful to say:
33892 .code
33893 verify = csa/$sender_host_address
33894 .endd
33895 In fact, this is the check that Exim performs if the client does not say HELO.
33896 This extension can be turned off by setting the main configuration option
33897 &%dns_csa_use_reverse%& to be false.
33898
33899 If a CSA SRV record is not found for the domain itself, a search
33900 is performed through its parent domains for a record which might be
33901 making assertions about subdomains. The maximum depth of this search is limited
33902 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
33903 default. Exim does not look for CSA SRV records in a top level domain, so the
33904 default settings handle HELO domains as long as seven
33905 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
33906 of legitimate HELO domains.
33907
33908 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
33909 direct SRV lookups, this is not sufficient because of the extra parent domain
33910 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
33911 addresses into lookups in the reverse DNS space. The result of a successful
33912 lookup such as:
33913 .code
33914 ${lookup dnsdb {csa=$sender_helo_name}}
33915 .endd
33916 has two space-separated fields: an authorization code and a target host name.
33917 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
33918 authorization required but absent, or &"?"& for unknown.
33919
33920
33921
33922
33923 .section "Bounce address tag validation" "SECTverifyPRVS"
33924 .cindex "BATV, verifying"
33925 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
33926 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
33927 Genuine incoming bounce messages should therefore always be addressed to
33928 recipients that have a valid tag. This scheme is a way of detecting unwanted
33929 bounce messages caused by sender address forgeries (often called &"collateral
33930 spam"&), because the recipients of such messages do not include valid tags.
33931
33932 There are two expansion items to help with the implementation of the BATV
33933 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
33934 the original envelope sender address by using a simple key to add a hash of the
33935 address and some time-based randomizing information. The &%prvs%& expansion
33936 item creates a signed address, and the &%prvscheck%& expansion item checks one.
33937 The syntax of these expansion items is described in section
33938 &<<SECTexpansionitems>>&.
33939 The validity period on signed addresses is seven days.
33940
33941 As an example, suppose the secret per-address keys are stored in an MySQL
33942 database. A query to look up the key for an address could be defined as a macro
33943 like this:
33944 .code
33945 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
33946                 WHERE sender='${quote_mysql:$prvscheck_address}'\
33947                 }{$value}}
33948 .endd
33949 Suppose also that the senders who make use of BATV are defined by an address
33950 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
33951 use this:
33952 .code
33953 # Bounces: drop unsigned addresses for BATV senders
33954 deny senders = :
33955      recipients = +batv_senders
33956      message = This address does not send an unsigned reverse path
33957
33958 # Bounces: In case of prvs-signed address, check signature.
33959 deny senders = :
33960      condition  = ${prvscheck {$local_part@$domain}\
33961                   {PRVSCHECK_SQL}{1}}
33962      !condition = $prvscheck_result
33963      message = Invalid reverse path signature.
33964 .endd
33965 The first statement rejects recipients for bounce messages that are addressed
33966 to plain BATV sender addresses, because it is known that BATV senders do not
33967 send out messages with plain sender addresses. The second statement rejects
33968 recipients that are prvs-signed, but with invalid signatures (either because
33969 the key is wrong, or the signature has timed out).
33970
33971 A non-prvs-signed address is not rejected by the second statement, because the
33972 &%prvscheck%& expansion yields an empty string if its first argument is not a
33973 prvs-signed address, thus causing the &%condition%& condition to be false. If
33974 the first argument is a syntactically valid prvs-signed address, the yield is
33975 the third string (in this case &"1"&), whether or not the cryptographic and
33976 timeout checks succeed. The &$prvscheck_result$& variable contains the result
33977 of the checks (empty for failure, &"1"& for success).
33978
33979 There is one more issue you must consider when implementing prvs-signing:
33980 you have to ensure that the routers accept prvs-signed addresses and
33981 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
33982 router to remove the signature with a configuration along these lines:
33983 .code
33984 batv_redirect:
33985   driver = redirect
33986   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
33987 .endd
33988 This works because, if the third argument of &%prvscheck%& is empty, the result
33989 of the expansion of a prvs-signed address is the decoded value of the original
33990 address. This router should probably be the first of your routers that handles
33991 local addresses.
33992
33993 To create BATV-signed addresses in the first place, a transport of this form
33994 can be used:
33995 .code
33996 external_smtp_batv:
33997   driver = smtp
33998   return_path = ${prvs {$return_path} \
33999                        {${lookup mysql{SELECT \
34000                        secret FROM batv_prvs WHERE \
34001                        sender='${quote_mysql:$sender_address}'} \
34002                        {$value}fail}}}
34003 .endd
34004 If no key can be found for the existing return path, no signing takes place.
34005
34006
34007
34008 .section "Using an ACL to control relaying" "SECTrelaycontrol"
34009 .cindex "&ACL;" "relay control"
34010 .cindex "relaying" "control by ACL"
34011 .cindex "policy control" "relay control"
34012 An MTA is said to &'relay'& a message if it receives it from some host and
34013 delivers it directly to another host as a result of a remote address contained
34014 within it. Redirecting a local address via an alias or forward file and then
34015 passing the message on to another host is not relaying,
34016 .cindex "&""percent hack""&"
34017 but a redirection as a result of the &"percent hack"& is.
34018
34019 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
34020 A host which is acting as a gateway or an MX backup is concerned with incoming
34021 relaying from arbitrary hosts to a specific set of domains. On the other hand,
34022 a host which is acting as a smart host for a number of clients is concerned
34023 with outgoing relaying from those clients to the Internet at large. Often the
34024 same host is fulfilling both functions,
34025 . ///
34026 . as illustrated in the diagram below,
34027 . ///
34028 but in principle these two kinds of relaying are entirely independent. What is
34029 not wanted is the transmission of mail from arbitrary remote hosts through your
34030 system to arbitrary domains.
34031
34032
34033 You can implement relay control by means of suitable statements in the ACL that
34034 runs for each RCPT command. For convenience, it is often easiest to use
34035 Exim's named list facility to define the domains and hosts involved. For
34036 example, suppose you want to do the following:
34037
34038 .ilist
34039 Deliver a number of domains to mailboxes on the local host (or process them
34040 locally in some other way). Let's say these are &'my.dom1.example'& and
34041 &'my.dom2.example'&.
34042 .next
34043 Relay mail for a number of other domains for which you are the secondary MX.
34044 These might be &'friend1.example'& and &'friend2.example'&.
34045 .next
34046 Relay mail from the hosts on your local LAN, to whatever domains are involved.
34047 Suppose your LAN is 192.168.45.0/24.
34048 .endlist
34049
34050
34051 In the main part of the configuration, you put the following definitions:
34052 .code
34053 domainlist local_domains    = my.dom1.example : my.dom2.example
34054 domainlist relay_to_domains = friend1.example : friend2.example
34055 hostlist   relay_from_hosts = 192.168.45.0/24
34056 .endd
34057 Now you can use these definitions in the ACL that is run for every RCPT
34058 command:
34059 .code
34060 acl_check_rcpt:
34061   accept domains = +local_domains : +relay_to_domains
34062   accept hosts   = +relay_from_hosts
34063 .endd
34064 The first statement accepts any RCPT command that contains an address in
34065 the local or relay domains. For any other domain, control passes to the second
34066 statement, which accepts the command only if it comes from one of the relay
34067 hosts. In practice, you will probably want to make your ACL more sophisticated
34068 than this, for example, by including sender and recipient verification. The
34069 default configuration includes a more comprehensive example, which is described
34070 in chapter &<<CHAPdefconfil>>&.
34071
34072
34073
34074 .section "Checking a relay configuration" "SECTcheralcon"
34075 .cindex "relaying" "checking control of"
34076 You can check the relay characteristics of your configuration in the same way
34077 that you can test any ACL behaviour for an incoming SMTP connection, by using
34078 the &%-bh%& option to run a fake SMTP session with which you interact.
34079 .ecindex IIDacl
34080
34081
34082
34083 . ////////////////////////////////////////////////////////////////////////////
34084 . ////////////////////////////////////////////////////////////////////////////
34085
34086 .chapter "Content scanning at ACL time" "CHAPexiscan"
34087 .scindex IIDcosca "content scanning" "at ACL time"
34088 The extension of Exim to include content scanning at ACL time, formerly known
34089 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
34090 was integrated into the main source for Exim release 4.50, and Tom continues to
34091 maintain it. Most of the wording of this chapter is taken from Tom's
34092 specification.
34093
34094 It is also possible to scan the content of messages at other times. The
34095 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
34096 scanning after all the ACLs have run. A transport filter can be used to scan
34097 messages at delivery time (see the &%transport_filter%& option, described in
34098 chapter &<<CHAPtransportgeneric>>&).
34099
34100 If you want to include the ACL-time content-scanning features when you compile
34101 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
34102 &_Local/Makefile_&. When you do that, the Exim binary is built with:
34103
34104 .ilist
34105 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
34106 for all MIME parts for SMTP and non-SMTP messages, respectively.
34107 .next
34108 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
34109 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
34110 run at the end of message reception (the &%acl_smtp_data%& ACL).
34111 .next
34112 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
34113 of messages, or parts of messages, for debugging purposes.
34114 .next
34115 Additional expansion variables that are set in the new ACL and by the new
34116 conditions.
34117 .next
34118 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
34119 .endlist
34120
34121 Content-scanning is continually evolving, and new features are still being
34122 added. While such features are still unstable and liable to incompatible
34123 changes, they are made available in Exim by setting options whose names begin
34124 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
34125 this manual. You can find out about them by reading the file called
34126 &_doc/experimental.txt_&.
34127
34128 All the content-scanning facilities work on a MBOX copy of the message that is
34129 temporarily created in a file called:
34130 .display
34131 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
34132 .endd
34133 The &_.eml_& extension is a friendly hint to virus scanners that they can
34134 expect an MBOX-like structure inside that file. The file is created when the
34135 first content scanning facility is called. Subsequent calls to content
34136 scanning conditions open the same file again. The directory is recursively
34137 removed when the &%acl_smtp_data%& ACL has finished running, unless
34138 .code
34139 control = no_mbox_unspool
34140 .endd
34141 has been encountered. When the MIME ACL decodes files, they are put into the
34142 same directory by default.
34143
34144
34145
34146 .section "Scanning for viruses" "SECTscanvirus"
34147 .cindex "virus scanning"
34148 .cindex "content scanning" "for viruses"
34149 .cindex "content scanning" "the &%malware%& condition"
34150 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
34151 It supports a &"generic"& interface to scanners called via the shell, and
34152 specialized interfaces for &"daemon"& type virus scanners, which are resident
34153 in memory and thus are much faster.
34154
34155 Since message data needs to have arrived,
34156 the condition may be only called in ACL defined by
34157 &%acl_smtp_data%&,
34158 &%acl_smtp_data_prdr%&,
34159 &%acl_smtp_mime%& or
34160 &%acl_smtp_dkim%&
34161
34162 A timeout of 2 minutes is applied to a scanner call (by default);
34163 if it expires then a defer action is taken.
34164
34165 .oindex "&%av_scanner%&"
34166 You can set the &%av_scanner%& option in the main part of the configuration
34167 to specify which scanner to use, together with any additional options that
34168 are needed. The basic syntax is as follows:
34169 .display
34170 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
34171 .endd
34172 If you do not set &%av_scanner%&, it defaults to
34173 .code
34174 av_scanner = sophie:/var/run/sophie
34175 .endd
34176 If the value of &%av_scanner%& starts with a dollar character, it is expanded
34177 before use.
34178 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
34179 The following scanner types are supported in this release,
34180 though individual ones can be included or not at build time:
34181
34182 .vlist
34183 .vitem &%avast%&
34184 .cindex "virus scanners" "avast"
34185 This is the scanner daemon of Avast. It has been tested with Avast Core
34186 Security (currently at version 2.2.0).
34187 You can get a trial version at &url(https://www.avast.com) or for Linux
34188 at &url(https://www.avast.com/linux-server-antivirus).
34189 This scanner type takes one option,
34190 which can be either a full path to a UNIX socket,
34191 or host and port specifiers separated by white space.
34192 The host may be a name or an IP address; the port is either a
34193 single number or a pair of numbers with a dash between.
34194 A list of options may follow. These options are interpreted on the
34195 Exim's side of the malware scanner, or are given on separate lines to
34196 the daemon as options before the main scan command.
34197
34198 .cindex &`pass_unscanned`& "avast"
34199 If &`pass_unscanned`&
34200 is set, any files the Avast scanner can't scan (e.g.
34201 decompression bombs, or invalid archives) are considered clean. Use with
34202 care.
34203
34204 For example:
34205 .code
34206 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
34207 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
34208 av_scanner = avast:192.168.2.22 5036
34209 .endd
34210 If you omit the argument, the default path
34211 &_/var/run/avast/scan.sock_&
34212 is used.
34213 If you use a remote host,
34214 you need to make Exim's spool directory available to it,
34215 as the scanner is passed a file path, not file contents.
34216 For information about available commands and their options you may use
34217 .code
34218 $ socat UNIX:/var/run/avast/scan.sock STDIO:
34219     FLAGS
34220     SENSITIVITY
34221     PACK
34222 .endd
34223
34224 If the scanner returns a temporary failure (e.g. license issues, or
34225 permission problems), the message is deferred and a paniclog entry is
34226 written.  The usual &`defer_ok`& option is available.
34227
34228 .vitem &%aveserver%&
34229 .cindex "virus scanners" "Kaspersky"
34230 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
34231 at &url(https://www.kaspersky.com/). This scanner type takes one option,
34232 which is the path to the daemon's UNIX socket. The default is shown in this
34233 example:
34234 .code
34235 av_scanner = aveserver:/var/run/aveserver
34236 .endd
34237
34238
34239 .vitem &%clamd%&
34240 .cindex "virus scanners" "clamd"
34241 This daemon-type scanner is GPL and free. You can get it at
34242 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
34243 unpack MIME containers, so it used to be recommended to unpack MIME attachments
34244 in the MIME ACL. This is no longer believed to be necessary.
34245
34246 The options are a list of server specifiers, which may be
34247 a UNIX socket specification,
34248 a TCP socket specification,
34249 or a (global) option.
34250
34251 A socket specification consists of a space-separated list.
34252 For a Unix socket the first element is a full path for the socket,
34253 for a TCP socket the first element is the IP address
34254 and the second a port number,
34255 Any further elements are per-server (non-global) options.
34256 These per-server options are supported:
34257 .code
34258 retry=<timespec>        Retry on connect fail
34259 .endd
34260
34261 The &`retry`& option specifies a time after which a single retry for
34262 a failed connect is made.  The default is to not retry.
34263
34264 If a Unix socket file is specified, only one server is supported.
34265
34266 Examples:
34267 .code
34268 av_scanner = clamd:/opt/clamd/socket
34269 av_scanner = clamd:192.0.2.3 1234
34270 av_scanner = clamd:192.0.2.3 1234:local
34271 av_scanner = clamd:192.0.2.3 1234 retry=10s
34272 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
34273 .endd
34274 If the value of av_scanner points to a UNIX socket file or contains the
34275 &`local`&
34276 option, then the ClamAV interface will pass a filename containing the data
34277 to be scanned, which should normally result in less I/O happening and be
34278 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
34279 Exim does not assume that there is a common filesystem with the remote host.
34280
34281 The final example shows that multiple TCP targets can be specified.  Exim will
34282 randomly use one for each incoming email (i.e. it load balances them).  Note
34283 that only TCP targets may be used if specifying a list of scanners; a UNIX
34284 socket cannot be mixed in with TCP targets.  If one of the servers becomes
34285 unavailable, Exim will try the remaining one(s) until it finds one that works.
34286 When a clamd server becomes unreachable, Exim will log a message.  Exim does
34287 not keep track of scanner state between multiple messages, and the scanner
34288 selection is random, so the message will get logged in the mainlog for each
34289 email that the down scanner gets chosen first (message wrapped to be readable):
34290 .code
34291 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
34292    clamd: connection to localhost, port 3310 failed
34293    (Connection refused)
34294 .endd
34295
34296 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
34297 contributing the code for this scanner.
34298
34299 .vitem &%cmdline%&
34300 .cindex "virus scanners" "command line interface"
34301 This is the keyword for the generic command line scanner interface. It can be
34302 used to attach virus scanners that are invoked from the shell. This scanner
34303 type takes 3 mandatory options:
34304
34305 .olist
34306 The full path and name of the scanner binary, with all command line options,
34307 and a placeholder (&`%s`&) for the directory to scan.
34308
34309 .next
34310 A regular expression to match against the STDOUT and STDERR output of the
34311 virus scanner. If the expression matches, a virus was found. You must make
34312 absolutely sure that this expression matches on &"virus found"&. This is called
34313 the &"trigger"& expression.
34314
34315 .next
34316 Another regular expression, containing exactly one pair of parentheses, to
34317 match the name of the virus found in the scanners output. This is called the
34318 &"name"& expression.
34319 .endlist olist
34320
34321 For example, Sophos Sweep reports a virus on a line like this:
34322 .code
34323 Virus 'W32/Magistr-B' found in file ./those.bat
34324 .endd
34325 For the trigger expression, we can match the phrase &"found in file"&. For the
34326 name expression, we want to extract the W32/Magistr-B string, so we can match
34327 for the single quotes left and right of it. Altogether, this makes the
34328 configuration setting:
34329 .code
34330 av_scanner = cmdline:\
34331              /path/to/sweep -ss -all -rec -archive %s:\
34332              found in file:'(.+)'
34333 .endd
34334 .vitem &%drweb%&
34335 .cindex "virus scanners" "DrWeb"
34336 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34337 takes one option,
34338 either a full path to a UNIX socket,
34339 or host and port specifiers separated by white space.
34340 The host may be a name or an IP address; the port is either a
34341 single number or a pair of numbers with a dash between.
34342 For example:
34343 .code
34344 av_scanner = drweb:/var/run/drwebd.sock
34345 av_scanner = drweb:192.168.2.20 31337
34346 .endd
34347 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34348 is used. Thanks to Alex Miller for contributing the code for this scanner.
34349
34350 .vitem &%f-protd%&
34351 .cindex "virus scanners" "f-protd"
34352 The f-protd scanner is accessed via HTTP over TCP.
34353 One argument is taken, being a space-separated hostname and port number
34354 (or port-range).
34355 For example:
34356 .code
34357 av_scanner = f-protd:localhost 10200-10204
34358 .endd
34359 If you omit the argument, the default values shown above are used.
34360
34361 .vitem &%f-prot6d%&
34362 .cindex "virus scanners" "f-prot6d"
34363 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34364 One argument is taken, being a space-separated hostname and port number.
34365 For example:
34366 .code
34367 av_scanner = f-prot6d:localhost 10200
34368 .endd
34369 If you omit the argument, the default values show above are used.
34370
34371 .vitem &%fsecure%&
34372 .cindex "virus scanners" "F-Secure"
34373 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34374 argument which is the path to a UNIX socket. For example:
34375 .code
34376 av_scanner = fsecure:/path/to/.fsav
34377 .endd
34378 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34379 Thelmen for contributing the code for this scanner.
34380
34381 .vitem &%kavdaemon%&
34382 .cindex "virus scanners" "Kaspersky"
34383 This is the scanner daemon of Kaspersky Version 4. This version of the
34384 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34385 scanner type takes one option, which is the path to the daemon's UNIX socket.
34386 For example:
34387 .code
34388 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34389 .endd
34390 The default path is &_/var/run/AvpCtl_&.
34391
34392 .vitem &%mksd%&
34393 .cindex "virus scanners" "mksd"
34394 This was a daemon type scanner that is aimed mainly at Polish users,
34395 though some documentation was available in English.
34396 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34397 and this appears to be a candidate for removal from Exim, unless
34398 we are informed of other virus scanners which use the same protocol
34399 to integrate.
34400 The only option for this scanner type is
34401 the maximum number of processes used simultaneously to scan the attachments,
34402 provided that mksd has
34403 been run with at least the same number of child processes. For example:
34404 .code
34405 av_scanner = mksd:2
34406 .endd
34407 You can safely omit this option (the default value is 1).
34408
34409 .vitem &%sock%&
34410 .cindex "virus scanners" "simple socket-connected"
34411 This is a general-purpose way of talking to simple scanner daemons
34412 running on the local machine.
34413 There are four options:
34414 an address (which may be an IP address and port, or the path of a Unix socket),
34415 a commandline to send (may include a single %s which will be replaced with
34416 the path to the mail file to be scanned),
34417 an RE to trigger on from the returned data,
34418 and an RE to extract malware_name from the returned data.
34419 For example:
34420 .code
34421 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34422 .endd
34423 Note that surrounding whitespace is stripped from each option, meaning
34424 there is no way to specify a trailing newline.
34425 The socket specifier and both regular-expressions are required.
34426 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34427 specify an empty element to get this.
34428
34429 .vitem &%sophie%&
34430 .cindex "virus scanners" "Sophos and Sophie"
34431 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34432 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34433 for this scanner type is the path to the UNIX socket that Sophie uses for
34434 client communication. For example:
34435 .code
34436 av_scanner = sophie:/tmp/sophie
34437 .endd
34438 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34439 the option.
34440 .endlist
34441
34442 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34443 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34444 ACL.
34445
34446 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34447 makes it possible to use different scanners. See further below for an example.
34448 The &%malware%& condition caches its results, so when you use it multiple times
34449 for the same message, the actual scanning process is only carried out once.
34450 However, using expandable items in &%av_scanner%& disables this caching, in
34451 which case each use of the &%malware%& condition causes a new scan of the
34452 message.
34453
34454 The &%malware%& condition takes a right-hand argument that is expanded before
34455 use and taken as a list, slash-separated by default.
34456 The first element can then be one of
34457
34458 .ilist
34459 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34460 The condition succeeds if a virus was found, and fail otherwise. This is the
34461 recommended usage.
34462 .next
34463 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34464 the condition fails immediately.
34465 .next
34466 A regular expression, in which case the message is scanned for viruses. The
34467 condition succeeds if a virus is found and its name matches the regular
34468 expression. This allows you to take special actions on certain types of virus.
34469 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34470 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34471 .endlist
34472
34473 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34474 messages even if there is a problem with the virus scanner.
34475 Otherwise, such a problem causes the ACL to defer.
34476
34477 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34478 specify a non-default timeout.  The default is two minutes.
34479 For example:
34480 .code
34481 malware = * / defer_ok / tmo=10s
34482 .endd
34483 A timeout causes the ACL to defer.
34484
34485 .vindex "&$callout_address$&"
34486 When a connection is made to the scanner the expansion variable &$callout_address$&
34487 is set to record the actual address used.
34488
34489 .vindex "&$malware_name$&"
34490 When a virus is found, the condition sets up an expansion variable called
34491 &$malware_name$& that contains the name of the virus. You can use it in a
34492 &%message%& modifier that specifies the error returned to the sender, and/or in
34493 logging data.
34494
34495 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34496 imposed by your anti-virus scanner.
34497
34498 Here is a very simple scanning example:
34499 .code
34500 deny malware = *
34501      message = This message contains malware ($malware_name)
34502 .endd
34503 The next example accepts messages when there is a problem with the scanner:
34504 .code
34505 deny malware = */defer_ok
34506      message = This message contains malware ($malware_name)
34507 .endd
34508 The next example shows how to use an ACL variable to scan with both sophie and
34509 aveserver. It assumes you have set:
34510 .code
34511 av_scanner = $acl_m0
34512 .endd
34513 in the main Exim configuration.
34514 .code
34515 deny set acl_m0 = sophie
34516      malware = *
34517      message = This message contains malware ($malware_name)
34518
34519 deny set acl_m0 = aveserver
34520      malware = *
34521      message = This message contains malware ($malware_name)
34522 .endd
34523
34524
34525 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34526 .cindex "content scanning" "for spam"
34527 .cindex "spam scanning"
34528 .cindex "SpamAssassin"
34529 .cindex "Rspamd"
34530 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34531 score and a report for the message.
34532 Support is also provided for Rspamd.
34533
34534 For more information about installation and configuration of SpamAssassin or
34535 Rspamd refer to their respective websites at
34536 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34537
34538 SpamAssassin can be installed with CPAN by running:
34539 .code
34540 perl -MCPAN -e 'install Mail::SpamAssassin'
34541 .endd
34542 SpamAssassin has its own set of configuration files. Please review its
34543 documentation to see how you can tweak it. The default installation should work
34544 nicely, however.
34545
34546 .oindex "&%spamd_address%&"
34547 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34548 intend to use an instance running on the local host you do not need to set
34549 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34550 you must set the &%spamd_address%& option in the global part of the Exim
34551 configuration as follows (example):
34552 .code
34553 spamd_address = 192.168.99.45 783
34554 .endd
34555 The SpamAssassin protocol relies on a TCP half-close from the client.
34556 If your SpamAssassin client side is running a Linux system with an
34557 iptables firewall, consider setting
34558 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34559 timeout, Exim uses when waiting for a response from the SpamAssassin
34560 server (currently defaulting to 120s).  With a lower value the Linux
34561 connection tracking may consider your half-closed connection as dead too
34562 soon.
34563
34564
34565 To use Rspamd (which by default listens on all local addresses
34566 on TCP port 11333)
34567 you should add &%variant=rspamd%& after the address/port pair, for example:
34568 .code
34569 spamd_address = 127.0.0.1 11333 variant=rspamd
34570 .endd
34571
34572 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
34573 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34574 filename instead of an address/port pair:
34575 .code
34576 spamd_address = /var/run/spamd_socket
34577 .endd
34578 You can have multiple &%spamd%& servers to improve scalability. These can
34579 reside on other hardware reachable over the network. To specify multiple
34580 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34581 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34582 .code
34583 spamd_address = 192.168.2.10 783 : \
34584                 192.168.2.11 783 : \
34585                 192.168.2.12 783
34586 .endd
34587 Up to 32 &%spamd%& servers are supported.
34588 When a server fails to respond to the connection attempt, all other
34589 servers are tried until one succeeds. If no server responds, the &%spam%&
34590 condition defers.
34591
34592 Unix and TCP socket specifications may be mixed in any order.
34593 Each element of the list is a list itself, space-separated by default
34594 and changeable in the usual way (&<<SECTlistsepchange>>&);
34595 take care to not double the separator.
34596
34597 For TCP socket specifications a host name or IP (v4 or v6, but
34598 subject to list-separator quoting rules) address can be used,
34599 and the port can be one or a dash-separated pair.
34600 In the latter case, the range is tried in strict order.
34601
34602 Elements after the first for Unix sockets, or second for TCP socket,
34603 are options.
34604 The supported options are:
34605 .code
34606 pri=<priority>      Selection priority
34607 weight=<value>      Selection bias
34608 time=<start>-<end>  Use only between these times of day
34609 retry=<timespec>    Retry on connect fail
34610 tmo=<timespec>      Connection time limit
34611 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34612 .endd
34613
34614 The &`pri`& option specifies a priority for the server within the list,
34615 higher values being tried first.
34616 The default priority is 1.
34617
34618 The &`weight`& option specifies a selection bias.
34619 Within a priority set
34620 servers are queried in a random fashion, weighted by this value.
34621 The default value for selection bias is 1.
34622
34623 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34624 in the local time zone; each element being one or more digits.
34625 Either the seconds or both minutes and seconds, plus the leading &`.`&
34626 characters, may be omitted and will be taken as zero.
34627
34628 Timeout specifications for the &`retry`& and &`tmo`& options
34629 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34630
34631 The &`tmo`& option specifies an overall timeout for communication.
34632 The default value is two minutes.
34633
34634 The &`retry`& option specifies a time after which a single retry for
34635 a failed connect is made.
34636 The default is to not retry.
34637
34638 The &%spamd_address%& variable is expanded before use if it starts with
34639 a dollar sign. In this case, the expansion may return a string that is
34640 used as the list so that multiple spamd servers can be the result of an
34641 expansion.
34642
34643 .vindex "&$callout_address$&"
34644 When a connection is made to the server the expansion variable &$callout_address$&
34645 is set to record the actual address used.
34646
34647 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34648 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34649 .code
34650 deny spam = joe
34651      message = This message was classified as SPAM
34652 .endd
34653 The right-hand side of the &%spam%& condition specifies a name. This is
34654 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34655 to scan using a specific profile, but rather use the SpamAssassin system-wide
34656 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34657 Rspamd does not use this setting. However, you must put something on the
34658 right-hand side.
34659
34660 The name allows you to use per-domain or per-user antispam profiles in
34661 principle, but this is not straightforward in practice, because a message may
34662 have multiple recipients, not necessarily all in the same domain. Because the
34663 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34664 read the contents of the message, the variables &$local_part$& and &$domain$&
34665 are not set.
34666 Careful enforcement of single-recipient messages
34667 (e.g. by responding with defer in the recipient ACL for all recipients
34668 after the first),
34669 or the use of PRDR,
34670 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34671 are needed to use this feature.
34672
34673 The right-hand side of the &%spam%& condition is expanded before being used, so
34674 you can put lookups or conditions there. When the right-hand side evaluates to
34675 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34676
34677
34678 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34679 large ones may cause significant performance degradation. As most spam messages
34680 are quite small, it is recommended that you do not scan the big ones. For
34681 example:
34682 .code
34683 deny condition = ${if < {$message_size}{10K}}
34684      spam = nobody
34685      message = This message was classified as SPAM
34686 .endd
34687
34688 The &%spam%& condition returns true if the threshold specified in the user's
34689 SpamAssassin profile has been matched or exceeded. If you want to use the
34690 &%spam%& condition for its side effects (see the variables below), you can make
34691 it always return &"true"& by appending &`:true`& to the username.
34692
34693 .cindex "spam scanning" "returned variables"
34694 When the &%spam%& condition is run, it sets up a number of expansion
34695 variables.
34696 Except for &$spam_report$&,
34697 these variables are saved with the received message so are
34698 available for use at delivery time.
34699
34700 .vlist
34701 .vitem &$spam_score$&
34702 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34703 for inclusion in log or reject messages.
34704
34705 .vitem &$spam_score_int$&
34706 The spam score of the message, multiplied by ten, as an integer value. For
34707 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34708 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34709 The integer value is useful for numeric comparisons in conditions.
34710
34711 .vitem &$spam_bar$&
34712 A string consisting of a number of &"+"& or &"-"& characters, representing the
34713 integer part of the spam score value. A spam score of 4.4 would have a
34714 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34715 headers, since MUAs can match on such strings. The maximum length of the
34716 spam bar is 50 characters.
34717
34718 .vitem &$spam_report$&
34719 A multiline text table, containing the full SpamAssassin report for the
34720 message. Useful for inclusion in headers or reject messages.
34721 This variable is only usable in a DATA-time ACL.
34722 Beware that SpamAssassin may return non-ASCII characters, especially
34723 when running in country-specific locales, which are not legal
34724 unencoded in headers.
34725
34726 .vitem &$spam_action$&
34727 For SpamAssassin either 'reject' or 'no action' depending on the
34728 spam score versus threshold.
34729 For Rspamd, the recommended action.
34730
34731 .endlist
34732
34733 The &%spam%& condition caches its results unless expansion in
34734 spamd_address was used. If you call it again with the same user name, it
34735 does not scan again, but rather returns the same values as before.
34736
34737 The &%spam%& condition returns DEFER if there is any error while running
34738 the message through SpamAssassin or if the expansion of spamd_address
34739 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34740 statement block), append &`/defer_ok`& to the right-hand side of the
34741 spam condition, like this:
34742 .code
34743 deny spam    = joe/defer_ok
34744      message = This message was classified as SPAM
34745 .endd
34746 This causes messages to be accepted even if there is a problem with &%spamd%&.
34747
34748 Here is a longer, commented example of the use of the &%spam%&
34749 condition:
34750 .code
34751 # put headers in all messages (no matter if spam or not)
34752 warn  spam = nobody:true
34753       add_header = X-Spam-Score: $spam_score ($spam_bar)
34754       add_header = X-Spam-Report: $spam_report
34755
34756 # add second subject line with *SPAM* marker when message
34757 # is over threshold
34758 warn  spam = nobody
34759       add_header = Subject: *SPAM* $h_Subject:
34760
34761 # reject spam at high scores (> 12)
34762 deny  spam = nobody:true
34763       condition = ${if >{$spam_score_int}{120}{1}{0}}
34764       message = This message scored $spam_score spam points.
34765 .endd
34766
34767
34768
34769 .section "Scanning MIME parts" "SECTscanmimepart"
34770 .cindex "content scanning" "MIME parts"
34771 .cindex "MIME content scanning"
34772 .oindex "&%acl_smtp_mime%&"
34773 .oindex "&%acl_not_smtp_mime%&"
34774 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34775 each MIME part of an SMTP message, including multipart types, in the sequence
34776 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34777 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34778 options may both refer to the same ACL if you want the same processing in both
34779 cases.
34780
34781 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34782 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34783 the case of a non-SMTP message. However, a MIME ACL is called only if the
34784 message contains a &'Content-Type:'& header line. When a call to a MIME
34785 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
34786 result code is sent to the client. In the case of an SMTP message, the
34787 &%acl_smtp_data%& ACL is not called when this happens.
34788
34789 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34790 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34791 condition to match against the raw MIME part. You can also use the
34792 &%mime_regex%& condition to match against the decoded MIME part (see section
34793 &<<SECTscanregex>>&).
34794
34795 At the start of a MIME ACL, a number of variables are set from the header
34796 information for the relevant MIME part. These are described below. The contents
34797 of the MIME part are not by default decoded into a disk file except for MIME
34798 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
34799 part into a disk file, you can use the &%decode%& condition. The general
34800 syntax is:
34801 .display
34802 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
34803 .endd
34804 The right hand side is expanded before use. After expansion,
34805 the value can be:
34806
34807 .olist
34808 &"0"& or &"false"&, in which case no decoding is done.
34809 .next
34810 The string &"default"&. In that case, the file is put in the temporary
34811 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
34812 a sequential filename consisting of the message id and a sequence number. The
34813 full path and name is available in &$mime_decoded_filename$& after decoding.
34814 .next
34815 A full path name starting with a slash. If the full name is an existing
34816 directory, it is used as a replacement for the default directory. The filename
34817 is then sequentially assigned. If the path does not exist, it is used as
34818 the full path and filename.
34819 .next
34820 If the string does not start with a slash, it is used as the
34821 filename, and the default path is then used.
34822 .endlist
34823 The &%decode%& condition normally succeeds. It is only false for syntax
34824 errors or unusual circumstances such as memory shortages. You can easily decode
34825 a file with its original, proposed filename using
34826 .code
34827 decode = $mime_filename
34828 .endd
34829 However, you should keep in mind that &$mime_filename$& might contain
34830 anything. If you place files outside of the default path, they are not
34831 automatically unlinked.
34832
34833 For RFC822 attachments (these are messages attached to messages, with a
34834 content-type of &"message/rfc822"&), the ACL is called again in the same manner
34835 as for the primary message, only that the &$mime_is_rfc822$& expansion
34836 variable is set (see below). Attached messages are always decoded to disk
34837 before being checked, and the files are unlinked once the check is done.
34838
34839 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
34840 used to match regular expressions against raw and decoded MIME parts,
34841 respectively. They are described in section &<<SECTscanregex>>&.
34842
34843 .cindex "MIME content scanning" "returned variables"
34844 The following list describes all expansion variables that are
34845 available in the MIME ACL:
34846
34847 .vlist
34848 .vitem &$mime_anomaly_level$& &&&
34849        &$mime_anomaly_text$&
34850 .vindex &$mime_anomaly_level$&
34851 .vindex &$mime_anomaly_text$&
34852 If there are problems decoding, these variables contain information on
34853 the detected issue.
34854
34855 .vitem &$mime_boundary$&
34856 .vindex &$mime_boundary$&
34857 If the current part is a multipart (see &$mime_is_multipart$& below), it should
34858 have a boundary string, which is stored in this variable. If the current part
34859 has no boundary parameter in the &'Content-Type:'& header, this variable
34860 contains the empty string.
34861
34862 .vitem &$mime_charset$&
34863 .vindex &$mime_charset$&
34864 This variable contains the character set identifier, if one was found in the
34865 &'Content-Type:'& header. Examples for charset identifiers are:
34866 .code
34867 us-ascii
34868 gb2312 (Chinese)
34869 iso-8859-1
34870 .endd
34871 Please note that this value is not normalized, so you should do matches
34872 case-insensitively.
34873
34874 .vitem &$mime_content_description$&
34875 .vindex &$mime_content_description$&
34876 This variable contains the normalized content of the &'Content-Description:'&
34877 header. It can contain a human-readable description of the parts content. Some
34878 implementations repeat the filename for attachments here, but they are usually
34879 only used for display purposes.
34880
34881 .vitem &$mime_content_disposition$&
34882 .vindex &$mime_content_disposition$&
34883 This variable contains the normalized content of the &'Content-Disposition:'&
34884 header. You can expect strings like &"attachment"& or &"inline"& here.
34885
34886 .vitem &$mime_content_id$&
34887 .vindex &$mime_content_id$&
34888 This variable contains the normalized content of the &'Content-ID:'& header.
34889 This is a unique ID that can be used to reference a part from another part.
34890
34891 .vitem &$mime_content_size$&
34892 .vindex &$mime_content_size$&
34893 This variable is set only after the &%decode%& modifier (see above) has been
34894 successfully run. It contains the size of the decoded part in kilobytes. The
34895 size is always rounded up to full kilobytes, so only a completely empty part
34896 has a &$mime_content_size$& of zero.
34897
34898 .vitem &$mime_content_transfer_encoding$&
34899 .vindex &$mime_content_transfer_encoding$&
34900 This variable contains the normalized content of the
34901 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
34902 type. Typical values are &"base64"& and &"quoted-printable"&.
34903
34904 .vitem &$mime_content_type$&
34905 .vindex &$mime_content_type$&
34906 If the MIME part has a &'Content-Type:'& header, this variable contains its
34907 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
34908 are some examples of popular MIME types, as they may appear in this variable:
34909 .code
34910 text/plain
34911 text/html
34912 application/octet-stream
34913 image/jpeg
34914 audio/midi
34915 .endd
34916 If the MIME part has no &'Content-Type:'& header, this variable contains the
34917 empty string.
34918
34919 .vitem &$mime_decoded_filename$&
34920 .vindex &$mime_decoded_filename$&
34921 This variable is set only after the &%decode%& modifier (see above) has been
34922 successfully run. It contains the full path and filename of the file
34923 containing the decoded data.
34924 .endlist
34925
34926 .cindex "RFC 2047"
34927 .vlist
34928 .vitem &$mime_filename$&
34929 .vindex &$mime_filename$&
34930 This is perhaps the most important of the MIME variables. It contains a
34931 proposed filename for an attachment, if one was found in either the
34932 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
34933 RFC2047
34934 or RFC2231
34935 decoded, but no additional sanity checks are done.
34936  If no filename was
34937 found, this variable contains the empty string.
34938
34939 .vitem &$mime_is_coverletter$&
34940 .vindex &$mime_is_coverletter$&
34941 This variable attempts to differentiate the &"cover letter"& of an e-mail from
34942 attached data. It can be used to clamp down on flashy or unnecessarily encoded
34943 content in the cover letter, while not restricting attachments at all.
34944
34945 The variable contains 1 (true) for a MIME part believed to be part of the
34946 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
34947 follows:
34948
34949 .olist
34950 The outermost MIME part of a message is always a cover letter.
34951
34952 .next
34953 If a multipart/alternative or multipart/related MIME part is a cover letter,
34954 so are all MIME subparts within that multipart.
34955
34956 .next
34957 If any other multipart is a cover letter, the first subpart is a cover letter,
34958 and the rest are attachments.
34959
34960 .next
34961 All parts contained within an attachment multipart are attachments.
34962 .endlist olist
34963
34964 As an example, the following will ban &"HTML mail"& (including that sent with
34965 alternative plain text), while allowing HTML files to be attached. HTML
34966 coverletter mail attached to non-HTML coverletter mail will also be allowed:
34967 .code
34968 deny !condition = $mime_is_rfc822
34969      condition = $mime_is_coverletter
34970      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
34971      message = HTML mail is not accepted here
34972 .endd
34973
34974 .vitem &$mime_is_multipart$&
34975 .vindex &$mime_is_multipart$&
34976 This variable has the value 1 (true) when the current part has the main type
34977 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
34978 Since multipart entities only serve as containers for other parts, you may not
34979 want to carry out specific actions on them.
34980
34981 .vitem &$mime_is_rfc822$&
34982 .vindex &$mime_is_rfc822$&
34983 This variable has the value 1 (true) if the current part is not a part of the
34984 checked message itself, but part of an attached message. Attached message
34985 decoding is fully recursive.
34986
34987 .vitem &$mime_part_count$&
34988 .vindex &$mime_part_count$&
34989 This variable is a counter that is raised for each processed MIME part. It
34990 starts at zero for the very first part (which is usually a multipart). The
34991 counter is per-message, so it is reset when processing RFC822 attachments (see
34992 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
34993 complete, so you can use it in the DATA ACL to determine the number of MIME
34994 parts of a message. For non-MIME messages, this variable contains the value -1.
34995 .endlist
34996
34997
34998
34999 .section "Scanning with regular expressions" "SECTscanregex"
35000 .cindex "content scanning" "with regular expressions"
35001 .cindex "regular expressions" "content scanning with"
35002 You can specify your own custom regular expression matches on the full body of
35003 the message, or on individual MIME parts.
35004
35005 The &%regex%& condition takes one or more regular expressions as arguments and
35006 matches them against the full message (when called in the DATA ACL) or a raw
35007 MIME part (when called in the MIME ACL). The &%regex%& condition matches
35008 linewise, with a maximum line length of 32K characters. That means you cannot
35009 have multiline matches with the &%regex%& condition.
35010
35011 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
35012 to 32K of decoded content (the whole content at once, not linewise). If the
35013 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
35014 is decoded automatically when &%mime_regex%& is executed (using default path
35015 and filename values). If the decoded data is larger than  32K, only the first
35016 32K characters are checked.
35017
35018 The regular expressions are passed as a colon-separated list. To include a
35019 literal colon, you must double it. Since the whole right-hand side string is
35020 expanded before being used, you must also escape dollar signs and backslashes
35021 with more backslashes, or use the &`\N`& facility to disable expansion.
35022 Here is a simple example that contains two regular expressions:
35023 .code
35024 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
35025      message = contains blacklisted regex ($regex_match_string)
35026 .endd
35027 The conditions returns true if any one of the regular expressions matches. The
35028 &$regex_match_string$& expansion variable is then set up and contains the
35029 matching regular expression.
35030 The expansion variables &$regex1$& &$regex2$& etc
35031 are set to any substrings captured by the regular expression.
35032
35033 &*Warning*&: With large messages, these conditions can be fairly
35034 CPU-intensive.
35035
35036 .ecindex IIDcosca
35037
35038
35039
35040
35041 . ////////////////////////////////////////////////////////////////////////////
35042 . ////////////////////////////////////////////////////////////////////////////
35043
35044 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
35045          "Local scan function"
35046 .scindex IIDlosca "&[local_scan()]& function" "description of"
35047 .cindex "customizing" "input scan using C function"
35048 .cindex "policy control" "by local scan function"
35049 In these days of email worms, viruses, and ever-increasing spam, some sites
35050 want to apply a lot of checking to messages before accepting them.
35051
35052 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
35053 passing messages to external virus and spam scanning software. You can also do
35054 a certain amount in Exim itself through string expansions and the &%condition%&
35055 condition in the ACL that runs after the SMTP DATA command or the ACL for
35056 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
35057
35058 To allow for further customization to a site's own requirements, there is the
35059 possibility of linking Exim with a private message scanning function, written
35060 in C. If you want to run code that is written in something other than C, you
35061 can of course use a little C stub to call it.
35062
35063 The local scan function is run once for every incoming message, at the point
35064 when Exim is just about to accept the message.
35065 It can therefore be used to control non-SMTP messages from local processes as
35066 well as messages arriving via SMTP.
35067
35068 Exim applies a timeout to calls of the local scan function, and there is an
35069 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
35070 Zero means &"no timeout"&.
35071 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
35072 before calling the local scan function, so that the most common types of crash
35073 are caught. If the timeout is exceeded or one of those signals is caught, the
35074 incoming message is rejected with a temporary error if it is an SMTP message.
35075 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
35076 code. The incident is logged on the main and reject logs.
35077
35078
35079
35080 .section "Building Exim to use a local scan function" "SECID207"
35081 .cindex "&[local_scan()]& function" "building Exim to use"
35082 To make use of the local scan function feature, you must tell Exim where your
35083 function is before building Exim, by setting
35084 both HAVE_LOCAL_SCAN and
35085 LOCAL_SCAN_SOURCE in your
35086 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
35087 directory, so you might set
35088 .code
35089 HAVE_LOCAL_SCAN=yes
35090 LOCAL_SCAN_SOURCE=Local/local_scan.c
35091 .endd
35092 for example. The function must be called &[local_scan()]&;
35093 the source file(s) for it should first #define LOCAL_SCAN
35094 and then #include "local_scan.h".
35095 It is called by
35096 Exim after it has received a message, when the success return code is about to
35097 be sent. This is after all the ACLs have been run. The return code from your
35098 function controls whether the message is actually accepted or not. There is a
35099 commented template function (that just accepts the message) in the file
35100 _src/local_scan.c_.
35101
35102 If you want to make use of Exim's runtime configuration file to set options
35103 for your &[local_scan()]& function, you must also set
35104 .code
35105 LOCAL_SCAN_HAS_OPTIONS=yes
35106 .endd
35107 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
35108
35109
35110
35111
35112 .section "API for local_scan()" "SECTapiforloc"
35113 .cindex "&[local_scan()]& function" "API description"
35114 .cindex &%dlfunc%& "API description"
35115 You must include this line near the start of your code:
35116 .code
35117 #define LOCAL_SCAN
35118 #include "local_scan.h"
35119 .endd
35120 This header file defines a number of variables and other values, and the
35121 prototype for the function itself. Exim is coded to use unsigned char values
35122 almost exclusively, and one of the things this header defines is a shorthand
35123 for &`unsigned char`& called &`uschar`&.
35124 It also makes available the following macro definitions, to simplify casting character
35125 strings and pointers to character strings:
35126 .code
35127 #define CS   (char *)
35128 #define CCS  (const char *)
35129 #define CSS  (char **)
35130 #define US   (unsigned char *)
35131 #define CUS  (const unsigned char *)
35132 #define USS  (unsigned char **)
35133 .endd
35134 The function prototype for &[local_scan()]& is:
35135 .code
35136 extern int local_scan(int fd, uschar **return_text);
35137 .endd
35138 The arguments are as follows:
35139
35140 .ilist
35141 &%fd%& is a file descriptor for the file that contains the body of the message
35142 (the -D file). The file is open for reading and writing, but updating it is not
35143 recommended. &*Warning*&: You must &'not'& close this file descriptor.
35144
35145 The descriptor is positioned at character 19 of the file, which is the first
35146 character of the body itself, because the first 19 characters are the message
35147 id followed by &`-D`& and a newline. If you rewind the file, you should use the
35148 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
35149 case this changes in some future version.
35150 .next
35151 &%return_text%& is an address which you can use to return a pointer to a text
35152 string at the end of the function. The value it points to on entry is NULL.
35153 .endlist
35154
35155 The function must return an &%int%& value which is one of the following macros:
35156
35157 .vlist
35158 .vitem &`LOCAL_SCAN_ACCEPT`&
35159 .vindex "&$local_scan_data$&"
35160 The message is accepted. If you pass back a string of text, it is saved with
35161 the message, and made available in the variable &$local_scan_data$&. No
35162 newlines are permitted (if there are any, they are turned into spaces) and the
35163 maximum length of text is 1000 characters.
35164
35165 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
35166 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35167 queued without immediate delivery, and is frozen.
35168
35169 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
35170 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35171 queued without immediate delivery.
35172
35173 .vitem &`LOCAL_SCAN_REJECT`&
35174 The message is rejected; the returned text is used as an error message which is
35175 passed back to the sender and which is also logged. Newlines are permitted &--
35176 they cause a multiline response for SMTP rejections, but are converted to
35177 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
35178 used.
35179
35180 .vitem &`LOCAL_SCAN_TEMPREJECT`&
35181 The message is temporarily rejected; the returned text is used as an error
35182 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
35183 problem"& is used.
35184
35185 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
35186 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
35187 message is not written to the reject log. It has the effect of unsetting the
35188 &%rejected_header%& log selector for just this rejection. If
35189 &%rejected_header%& is already unset (see the discussion of the
35190 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
35191 same as LOCAL_SCAN_REJECT.
35192
35193 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
35194 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
35195 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
35196 .endlist
35197
35198 If the message is not being received by interactive SMTP, rejections are
35199 reported by writing to &%stderr%& or by sending an email, as configured by the
35200 &%-oe%& command line options.
35201
35202
35203
35204 .section "Configuration options for local_scan()" "SECTconoptloc"
35205 .cindex "&[local_scan()]& function" "configuration options"
35206 It is possible to have option settings in the main configuration file
35207 that set values in static variables in the &[local_scan()]& module. If you
35208 want to do this, you must have the line
35209 .code
35210 LOCAL_SCAN_HAS_OPTIONS=yes
35211 .endd
35212 in your &_Local/Makefile_& when you build Exim. (This line is in
35213 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
35214 file, you must define static variables to hold the option values, and a table
35215 to define them.
35216
35217 The table must be a vector called &%local_scan_options%&, of type
35218 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
35219 and a pointer to the variable that holds the value. The entries must appear in
35220 alphabetical order. Following &%local_scan_options%& you must also define a
35221 variable called &%local_scan_options_count%& that contains the number of
35222 entries in the table. Here is a short example, showing two kinds of option:
35223 .code
35224 static int my_integer_option = 42;
35225 static uschar *my_string_option = US"a default string";
35226
35227 optionlist local_scan_options[] = {
35228   { "my_integer", opt_int,       &my_integer_option },
35229   { "my_string",  opt_stringptr, &my_string_option }
35230 };
35231
35232 int local_scan_options_count =
35233   sizeof(local_scan_options)/sizeof(optionlist);
35234 .endd
35235 The values of the variables can now be changed from Exim's runtime
35236 configuration file by including a local scan section as in this example:
35237 .code
35238 begin local_scan
35239 my_integer = 99
35240 my_string = some string of text...
35241 .endd
35242 The available types of option data are as follows:
35243
35244 .vlist
35245 .vitem &*opt_bool*&
35246 This specifies a boolean (true/false) option. The address should point to a
35247 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
35248 that are defined as &"1"& and &"0"&, respectively. If you want to detect
35249 whether such a variable has been set at all, you can initialize it to
35250 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
35251 values.)
35252
35253 .vitem &*opt_fixed*&
35254 This specifies a fixed point number, such as is used for load averages.
35255 The address should point to a variable of type &`int`&. The value is stored
35256 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
35257
35258 .vitem &*opt_int*&
35259 This specifies an integer; the address should point to a variable of type
35260 &`int`&. The value may be specified in any of the integer formats accepted by
35261 Exim.
35262
35263 .vitem &*opt_mkint*&
35264 This is the same as &%opt_int%&, except that when such a value is output in a
35265 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
35266 printed with the suffix K or M.
35267
35268 .vitem &*opt_octint*&
35269 This also specifies an integer, but the value is always interpreted as an
35270 octal integer, whether or not it starts with the digit zero, and it is
35271 always output in octal.
35272
35273 .vitem &*opt_stringptr*&
35274 This specifies a string value; the address must be a pointer to a
35275 variable that points to a string (for example, of type &`uschar *`&).
35276
35277 .vitem &*opt_time*&
35278 This specifies a time interval value. The address must point to a variable of
35279 type &`int`&. The value that is placed there is a number of seconds.
35280 .endlist
35281
35282 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
35283 out the values of all the &[local_scan()]& options.
35284
35285
35286
35287 .section "Available Exim variables" "SECID208"
35288 .cindex "&[local_scan()]& function" "available Exim variables"
35289 The header &_local_scan.h_& gives you access to a number of C variables. These
35290 are the only ones that are guaranteed to be maintained from release to release.
35291 Note, however, that you can obtain the value of any Exim expansion variable,
35292 including &$recipients$&, by calling &'expand_string()'&. The exported
35293 C variables are as follows:
35294
35295 .vlist
35296 .vitem &*int&~body_linecount*&
35297 This variable contains the number of lines in the message's body.
35298 It is not valid if the &%spool_wireformat%& option is used.
35299
35300 .vitem &*int&~body_zerocount*&
35301 This variable contains the number of binary zero bytes in the message's body.
35302 It is not valid if the &%spool_wireformat%& option is used.
35303
35304 .vitem &*unsigned&~int&~debug_selector*&
35305 This variable is set to zero when no debugging is taking place. Otherwise, it
35306 is a bitmap of debugging selectors. Two bits are identified for use in
35307 &[local_scan()]&; they are defined as macros:
35308
35309 .ilist
35310 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
35311 testing option that is not privileged &-- any caller may set it. All the
35312 other selector bits can be set only by admin users.
35313
35314 .next
35315 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
35316 by the &`+local_scan`& debug selector. It is not included in the default set
35317 of debugging bits.
35318 .endlist ilist
35319
35320 Thus, to write to the debugging output only when &`+local_scan`& has been
35321 selected, you should use code like this:
35322 .code
35323 if ((debug_selector & D_local_scan) != 0)
35324   debug_printf("xxx", ...);
35325 .endd
35326 .vitem &*uschar&~*expand_string_message*&
35327 After a failing call to &'expand_string()'& (returned value NULL), the
35328 variable &%expand_string_message%& contains the error message, zero-terminated.
35329
35330 .vitem &*header_line&~*header_list*&
35331 A pointer to a chain of header lines. The &%header_line%& structure is
35332 discussed below.
35333
35334 .vitem &*header_line&~*header_last*&
35335 A pointer to the last of the header lines.
35336
35337 .vitem &*const&~uschar&~*headers_charset*&
35338 The value of the &%headers_charset%& configuration option.
35339
35340 .vitem &*BOOL&~host_checking*&
35341 This variable is TRUE during a host checking session that is initiated by the
35342 &%-bh%& command line option.
35343
35344 .vitem &*uschar&~*interface_address*&
35345 The IP address of the interface that received the message, as a string. This
35346 is NULL for locally submitted messages.
35347
35348 .vitem &*int&~interface_port*&
35349 The port on which this message was received. When testing with the &%-bh%&
35350 command line option, the value of this variable is -1 unless a port has been
35351 specified via the &%-oMi%& option.
35352
35353 .vitem &*uschar&~*message_id*&
35354 This variable contains Exim's message id for the incoming message (the value of
35355 &$message_exim_id$&) as a zero-terminated string.
35356
35357 .vitem &*uschar&~*received_protocol*&
35358 The name of the protocol by which the message was received.
35359
35360 .vitem &*int&~recipients_count*&
35361 The number of accepted recipients.
35362
35363 .vitem &*recipient_item&~*recipients_list*&
35364 .cindex "recipient" "adding in local scan"
35365 .cindex "recipient" "removing in local scan"
35366 The list of accepted recipients, held in a vector of length
35367 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35368 can add additional recipients by calling &'receive_add_recipient()'& (see
35369 below). You can delete recipients by removing them from the vector and
35370 adjusting the value in &%recipients_count%&. In particular, by setting
35371 &%recipients_count%& to zero you remove all recipients. If you then return the
35372 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35373 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35374 and then call &'receive_add_recipient()'& as often as needed.
35375
35376 .vitem &*uschar&~*sender_address*&
35377 The envelope sender address. For bounce messages this is the empty string.
35378
35379 .vitem &*uschar&~*sender_host_address*&
35380 The IP address of the sending host, as a string. This is NULL for
35381 locally-submitted messages.
35382
35383 .vitem &*uschar&~*sender_host_authenticated*&
35384 The name of the authentication mechanism that was used, or NULL if the message
35385 was not received over an authenticated SMTP connection.
35386
35387 .vitem &*uschar&~*sender_host_name*&
35388 The name of the sending host, if known.
35389
35390 .vitem &*int&~sender_host_port*&
35391 The port on the sending host.
35392
35393 .vitem &*BOOL&~smtp_input*&
35394 This variable is TRUE for all SMTP input, including BSMTP.
35395
35396 .vitem &*BOOL&~smtp_batched_input*&
35397 This variable is TRUE for BSMTP input.
35398
35399 .vitem &*int&~store_pool*&
35400 The contents of this variable control which pool of memory is used for new
35401 requests. See section &<<SECTmemhanloc>>& for details.
35402 .endlist
35403
35404
35405 .section "Structure of header lines" "SECID209"
35406 The &%header_line%& structure contains the members listed below.
35407 You can add additional header lines by calling the &'header_add()'& function
35408 (see below). You can cause header lines to be ignored (deleted) by setting
35409 their type to *.
35410
35411
35412 .vlist
35413 .vitem &*struct&~header_line&~*next*&
35414 A pointer to the next header line, or NULL for the last line.
35415
35416 .vitem &*int&~type*&
35417 A code identifying certain headers that Exim recognizes. The codes are printing
35418 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35419 Notice in particular that any header line whose type is * is not transmitted
35420 with the message. This flagging is used for header lines that have been
35421 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35422 lines.) Effectively, * means &"deleted"&.
35423
35424 .vitem &*int&~slen*&
35425 The number of characters in the header line, including the terminating and any
35426 internal newlines.
35427
35428 .vitem &*uschar&~*text*&
35429 A pointer to the text of the header. It always ends with a newline, followed by
35430 a zero byte. Internal newlines are preserved.
35431 .endlist
35432
35433
35434
35435 .section "Structure of recipient items" "SECID210"
35436 The &%recipient_item%& structure contains these members:
35437
35438 .vlist
35439 .vitem &*uschar&~*address*&
35440 This is a pointer to the recipient address as it was received.
35441
35442 .vitem &*int&~pno*&
35443 This is used in later Exim processing when top level addresses are created by
35444 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35445 and must always contain -1 at this stage.
35446
35447 .vitem &*uschar&~*errors_to*&
35448 If this value is not NULL, bounce messages caused by failing to deliver to the
35449 recipient are sent to the address it contains. In other words, it overrides the
35450 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35451 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35452 an unqualified address, Exim qualifies it using the domain from
35453 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35454 is NULL for all recipients.
35455 .endlist
35456
35457
35458
35459 .section "Available Exim functions" "SECID211"
35460 .cindex "&[local_scan()]& function" "available Exim functions"
35461 The header &_local_scan.h_& gives you access to a number of Exim functions.
35462 These are the only ones that are guaranteed to be maintained from release to
35463 release:
35464
35465 .vlist
35466 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35467        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35468
35469 This function creates a child process that runs the command specified by
35470 &%argv%&. The environment for the process is specified by &%envp%&, which can
35471 be NULL if no environment variables are to be passed. A new umask is supplied
35472 for the process in &%newumask%&.
35473
35474 Pipes to the standard input and output of the new process are set up
35475 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35476 standard error is cloned to the standard output. If there are any file
35477 descriptors &"in the way"& in the new process, they are closed. If the final
35478 argument is TRUE, the new process is made into a process group leader.
35479
35480 The function returns the pid of the new process, or -1 if things go wrong.
35481
35482 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35483 This function waits for a child process to terminate, or for a timeout (in
35484 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35485 return value is as follows:
35486
35487 .ilist
35488 >= 0
35489
35490 The process terminated by a normal exit and the value is the process
35491 ending status.
35492
35493 .next
35494 < 0 and > &--256
35495
35496 The process was terminated by a signal and the value is the negation of the
35497 signal number.
35498
35499 .next
35500 &--256
35501
35502 The process timed out.
35503 .next
35504 &--257
35505
35506 The was some other error in wait(); &%errno%& is still set.
35507 .endlist
35508
35509 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35510 This function provide you with a means of submitting a new message to
35511 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35512 want, but this packages it all up for you.) The function creates a pipe,
35513 forks a subprocess that is running
35514 .code
35515 exim -t -oem -oi -f <>
35516 .endd
35517 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35518 that is connected to the standard input. The yield of the function is the PID
35519 of the subprocess. You can then write a message to the file descriptor, with
35520 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35521
35522 When you have finished, call &'child_close()'& to wait for the process to
35523 finish and to collect its ending status. A timeout value of zero is usually
35524 fine in this circumstance. Unless you have made a mistake with the recipient
35525 addresses, you should get a return code of zero.
35526
35527
35528 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35529        *sender_authentication)*&
35530 This function is a more sophisticated version of &'child_open()'&. The command
35531 that it runs is:
35532 .display
35533 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35534 .endd
35535 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35536
35537
35538 .vitem &*void&~debug_printf(char&~*,&~...)*&
35539 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35540 output is written to the standard error stream. If no debugging is selected,
35541 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35542 conditional on the &`local_scan`& debug selector by coding like this:
35543 .code
35544 if ((debug_selector & D_local_scan) != 0)
35545   debug_printf("xxx", ...);
35546 .endd
35547
35548 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35549 This is an interface to Exim's string expansion code. The return value is the
35550 expanded string, or NULL if there was an expansion failure.
35551 The C variable &%expand_string_message%& contains an error message after an
35552 expansion failure. If expansion does not change the string, the return value is
35553 the pointer to the input string. Otherwise, the return value points to a new
35554 block of memory that was obtained by a call to &'store_get()'&. See section
35555 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35556
35557 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35558 This function allows you to an add additional header line at the end of the
35559 existing ones. The first argument is the type, and should normally be a space
35560 character. The second argument is a format string and any number of
35561 substitution arguments as for &[sprintf()]&. You may include internal newlines
35562 if you want, and you must ensure that the string ends with a newline.
35563
35564 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
35565         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
35566 This function adds a new header line at a specified point in the header
35567 chain. The header itself is specified as for &'header_add()'&.
35568
35569 If &%name%& is NULL, the new header is added at the end of the chain if
35570 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
35571 NULL, the header lines are searched for the first non-deleted header that
35572 matches the name. If one is found, the new header is added before it if
35573 &%after%& is false. If &%after%& is true, the new header is added after the
35574 found header and any adjacent subsequent ones with the same name (even if
35575 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35576 option controls where the header is added. If it is true, addition is at the
35577 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35578 headers, or at the top if there are no &'Received:'& headers, you could use
35579 .code
35580 header_add_at_position(TRUE, US"Received", TRUE,
35581   ' ', "X-xxx: ...");
35582 .endd
35583 Normally, there is always at least one non-deleted &'Received:'& header, but
35584 there may not be if &%received_header_text%& expands to an empty string.
35585
35586
35587 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35588 This function removes header lines. If &%occurrence%& is zero or negative, all
35589 occurrences of the header are removed. If occurrence is greater than zero, that
35590 particular instance of the header is removed. If no header(s) can be found that
35591 match the specification, the function does nothing.
35592
35593
35594 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35595         int&~length,&~BOOL&~notdel)*&"
35596 This function tests whether the given header has the given name. It is not just
35597 a string comparison, because white space is permitted between the name and the
35598 colon. If the &%notdel%& argument is true, a false return is forced for all
35599 &"deleted"& headers; otherwise they are not treated specially. For example:
35600 .code
35601 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35602 .endd
35603 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35604 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35605 This function base64-encodes a string, which is passed by address and length.
35606 The text may contain bytes of any value, including zero. The result is passed
35607 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35608 zero-terminated.
35609
35610 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35611 This function decodes a base64-encoded string. Its arguments are a
35612 zero-terminated base64-encoded string and the address of a variable that is set
35613 to point to the result, which is in dynamic memory. The length of the decoded
35614 string is the yield of the function. If the input is invalid base64 data, the
35615 yield is -1. A zero byte is added to the end of the output string to make it
35616 easy to interpret as a C string (assuming it contains no zeros of its own). The
35617 added zero byte is not included in the returned count.
35618
35619 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35620 This function checks for a match in a domain list. Domains are always
35621 matched caselessly. The return value is one of the following:
35622 .itable none 0 0 2 15* left 85* left
35623 .irow &`OK`&    "match succeeded"
35624 .irow &`FAIL`&  "match failed"
35625 .irow &`DEFER`& "match deferred"
35626 .endtable
35627 DEFER is usually caused by some kind of lookup defer, such as the
35628 inability to contact a database.
35629
35630 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35631         BOOL&~caseless)*&"
35632 This function checks for a match in a local part list. The third argument
35633 controls case-sensitivity. The return values are as for
35634 &'lss_match_domain()'&.
35635
35636 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35637         BOOL&~caseless)*&"
35638 This function checks for a match in an address list. The third argument
35639 controls the case-sensitivity of the local part match. The domain is always
35640 matched caselessly. The return values are as for &'lss_match_domain()'&.
35641
35642 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35643         uschar&~*list)*&"
35644 This function checks for a match in a host list. The most common usage is
35645 expected to be
35646 .code
35647 lss_match_host(sender_host_name, sender_host_address, ...)
35648 .endd
35649 .vindex "&$sender_host_address$&"
35650 An empty address field matches an empty item in the host list. If the host name
35651 is NULL, the name corresponding to &$sender_host_address$& is automatically
35652 looked up if a host name is required to match an item in the list. The return
35653 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35654 returns ERROR in the case when it had to look up a host name, but the lookup
35655 failed.
35656
35657 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35658         *format,&~...)*&"
35659 This function writes to Exim's log files. The first argument should be zero (it
35660 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35661 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35662 them. It specifies to which log or logs the message is written. The remaining
35663 arguments are a format and relevant insertion arguments. The string should not
35664 contain any newlines, not even at the end.
35665
35666
35667 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35668 This function adds an additional recipient to the message. The first argument
35669 is the recipient address. If it is unqualified (has no domain), it is qualified
35670 with the &%qualify_recipient%& domain. The second argument must always be -1.
35671
35672 This function does not allow you to specify a private &%errors_to%& address (as
35673 described with the structure of &%recipient_item%& above), because it pre-dates
35674 the addition of that field to the structure. However, it is easy to add such a
35675 value afterwards. For example:
35676 .code
35677  receive_add_recipient(US"monitor@mydom.example", -1);
35678  recipients_list[recipients_count-1].errors_to =
35679    US"postmaster@mydom.example";
35680 .endd
35681
35682 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35683 This is a convenience function to remove a named recipient from the list of
35684 recipients. It returns true if a recipient was removed, and false if no
35685 matching recipient could be found. The argument must be a complete email
35686 address.
35687 .endlist
35688
35689
35690 .cindex "RFC 2047"
35691 .vlist
35692 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35693   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35694 This function decodes strings that are encoded according to RFC 2047. Typically
35695 these are the contents of header lines. First, each &"encoded word"& is decoded
35696 from the Q or B encoding into a byte-string. Then, if provided with the name of
35697 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35698 made  to translate the result to the named character set. If this fails, the
35699 binary string is returned with an error message.
35700
35701 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35702 maximum MIME word length is enforced. The third argument is the target
35703 encoding, or NULL if no translation is wanted.
35704
35705 .cindex "binary zero" "in RFC 2047 decoding"
35706 .cindex "RFC 2047" "binary zero in"
35707 If a binary zero is encountered in the decoded string, it is replaced by the
35708 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35709 not be 0 because header lines are handled as zero-terminated strings.
35710
35711 The function returns the result of processing the string, zero-terminated; if
35712 &%lenptr%& is not NULL, the length of the result is set in the variable to
35713 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35714
35715 If an error is encountered, the function returns NULL and uses the &%error%&
35716 argument to return an error message. The variable pointed to by &%error%& is
35717 set to NULL if there is no error; it may be set non-NULL even when the function
35718 returns a non-NULL value if decoding was successful, but there was a problem
35719 with translation.
35720
35721
35722 .vitem &*int&~smtp_fflush(void)*&
35723 This function is used in conjunction with &'smtp_printf()'&, as described
35724 below.
35725
35726 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35727 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35728 output stream. You should use this function only when there is an SMTP output
35729 stream, that is, when the incoming message is being received via interactive
35730 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35731 is FALSE. If you want to test for an incoming message from another host (as
35732 opposed to a local process that used the &%-bs%& command line option), you can
35733 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35734 is involved.
35735
35736 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35737 output function, so it can be used for all forms of SMTP connection.
35738
35739 The second argument is used to request that the data be buffered
35740 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35741 This is advisory only, but likely to save on system-calls and packets
35742 sent when a sequence of calls to the function are made.
35743
35744 The argument was added in Exim version 4.90 - changing the API/ABI.
35745 Nobody noticed until 4.93 was imminent, at which point the
35746 ABI version number was incremented.
35747
35748 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35749 must start with an appropriate response code: 550 if you are going to return
35750 LOCAL_SCAN_REJECT, 451 if you are going to return
35751 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35752 initial lines of a multi-line response, the code must be followed by a hyphen
35753 to indicate that the line is not the final response line. You must also ensure
35754 that the lines you write terminate with CRLF. For example:
35755 .code
35756 smtp_printf("550-this is some extra info\r\n");
35757 return LOCAL_SCAN_REJECT;
35758 .endd
35759 Note that you can also create multi-line responses by including newlines in
35760 the data returned via the &%return_text%& argument. The added value of using
35761 &'smtp_printf()'& is that, for instance, you could introduce delays between
35762 multiple output lines.
35763
35764 The &'smtp_printf()'& function does not return any error indication, because it
35765 does not
35766 guarantee a flush of
35767 pending output, and therefore does not test
35768 the state of the stream. (In the main code of Exim, flushing and error
35769 detection is done when Exim is ready for the next SMTP input command.) If
35770 you want to flush the output and check for an error (for example, the
35771 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35772 arguments. It flushes the output stream, and returns a non-zero value if there
35773 is an error.
35774
35775 .vitem &*void&~*store_get(int,BOOL)*&
35776 This function accesses Exim's internal store (memory) manager. It gets a new
35777 chunk of memory whose size is given by the first argument.
35778 The second argument should be given as TRUE if the memory will be used for
35779 data possibly coming from an attacker (eg. the message content),
35780 FALSE if it is locally-sourced.
35781 Exim bombs out if it ever
35782 runs out of memory. See the next section for a discussion of memory handling.
35783
35784 .vitem &*void&~*store_get_perm(int,BOOL)*&
35785 This function is like &'store_get()'&, but it always gets memory from the
35786 permanent pool. See the next section for a discussion of memory handling.
35787
35788 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35789 See below.
35790
35791 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35792 See below.
35793
35794 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
35795 These three functions create strings using Exim's dynamic memory facilities.
35796 The first makes a copy of an entire string. The second copies up to a maximum
35797 number of characters, indicated by the second argument. The third uses a format
35798 and insertion arguments to create a new string. In each case, the result is a
35799 pointer to a new string in the current memory pool. See the next section for
35800 more discussion.
35801 .endlist
35802
35803
35804
35805 .section "More about Exim's memory handling" "SECTmemhanloc"
35806 .cindex "&[local_scan()]& function" "memory handling"
35807 No function is provided for freeing memory, because that is never needed.
35808 The dynamic memory that Exim uses when receiving a message is automatically
35809 recycled if another message is received by the same process (this applies only
35810 to incoming SMTP connections &-- other input methods can supply only one
35811 message at a time). After receiving the last message, a reception process
35812 terminates.
35813
35814 Because it is recycled, the normal dynamic memory cannot be used for holding
35815 data that must be preserved over a number of incoming messages on the same SMTP
35816 connection. However, Exim in fact uses two pools of dynamic memory; the second
35817 one is not recycled, and can be used for this purpose.
35818
35819 If you want to allocate memory that remains available for subsequent messages
35820 in the same SMTP connection, you should set
35821 .code
35822 store_pool = POOL_PERM
35823 .endd
35824 before calling the function that does the allocation. There is no need to
35825 restore the value if you do not need to; however, if you do want to revert to
35826 the normal pool, you can either restore the previous value of &%store_pool%& or
35827 set it explicitly to POOL_MAIN.
35828
35829 The pool setting applies to all functions that get dynamic memory, including
35830 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
35831 There is also a convenience function called &'store_get_perm()'& that gets a
35832 block of memory from the permanent pool while preserving the value of
35833 &%store_pool%&.
35834 .ecindex IIDlosca
35835
35836
35837
35838
35839 . ////////////////////////////////////////////////////////////////////////////
35840 . ////////////////////////////////////////////////////////////////////////////
35841
35842 .chapter "System-wide message filtering" "CHAPsystemfilter"
35843 .scindex IIDsysfil1 "filter" "system filter"
35844 .scindex IIDsysfil2 "filtering all mail"
35845 .scindex IIDsysfil3 "system filter"
35846 The previous chapters (on ACLs and the local scan function) describe checks
35847 that can be applied to messages before they are accepted by a host. There is
35848 also a mechanism for checking messages once they have been received, but before
35849 they are delivered. This is called the &'system filter'&.
35850
35851 The system filter operates in a similar manner to users' filter files, but it
35852 is run just once per message (however many recipients the message has).
35853 It should not normally be used as a substitute for routing, because &%deliver%&
35854 commands in a system router provide new envelope recipient addresses.
35855 The system filter must be an Exim filter. It cannot be a Sieve filter.
35856
35857 The system filter is run at the start of a delivery attempt, before any routing
35858 is done. If a message fails to be completely delivered at the first attempt,
35859 the system filter is run again at the start of every retry.
35860 If you want your filter to do something only once per message, you can make use
35861 of the &%first_delivery%& condition in an &%if%& command in the filter to
35862 prevent it happening on retries.
35863
35864 .vindex "&$domain$&"
35865 .vindex "&$local_part$&"
35866 &*Warning*&: Because the system filter runs just once, variables that are
35867 specific to individual recipient addresses, such as &$local_part$& and
35868 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
35869 you want to run a centrally-specified filter for each recipient address
35870 independently, you can do so by setting up a suitable &(redirect)& router, as
35871 described in section &<<SECTperaddfil>>& below.
35872
35873
35874 .section "Specifying a system filter" "SECID212"
35875 .cindex "uid (user id)" "system filter"
35876 .cindex "gid (group id)" "system filter"
35877 The name of the file that contains the system filter must be specified by
35878 setting &%system_filter%&. If you want the filter to run under a uid and gid
35879 other than root, you must also set &%system_filter_user%& and
35880 &%system_filter_group%& as appropriate. For example:
35881 .code
35882 system_filter = /etc/mail/exim.filter
35883 system_filter_user = exim
35884 .endd
35885 If a system filter generates any deliveries directly to files or pipes (via the
35886 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
35887 specified by setting &%system_filter_file_transport%& and
35888 &%system_filter_pipe_transport%&, respectively. Similarly,
35889 &%system_filter_reply_transport%& must be set to handle any messages generated
35890 by the &%reply%& command.
35891
35892
35893 .section "Testing a system filter" "SECID213"
35894 You can run simple tests of a system filter in the same way as for a user
35895 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
35896 are permitted only in system filters are recognized.
35897
35898 If you want to test the combined effect of a system filter and a user filter,
35899 you can use both &%-bF%& and &%-bf%& on the same command line.
35900
35901
35902
35903 .section "Contents of a system filter" "SECID214"
35904 The language used to specify system filters is the same as for users' filter
35905 files. It is described in the separate end-user document &'Exim's interface to
35906 mail filtering'&. However, there are some additional features that are
35907 available only in system filters; these are described in subsequent sections.
35908 If they are encountered in a user's filter file or when testing with &%-bf%&,
35909 they cause errors.
35910
35911 .cindex "frozen messages" "manual thaw; testing in filter"
35912 There are two special conditions which, though available in users' filter
35913 files, are designed for use in system filters. The condition &%first_delivery%&
35914 is true only for the first attempt at delivering a message, and
35915 &%manually_thawed%& is true only if the message has been frozen, and
35916 subsequently thawed by an admin user. An explicit forced delivery counts as a
35917 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
35918
35919 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
35920 specify an &"unseen"& (non-significant) delivery, and that delivery does not
35921 succeed, it will not be tried again.
35922 If you want Exim to retry an unseen delivery until it succeeds, you should
35923 arrange to set it up every time the filter runs.
35924
35925 When a system filter finishes running, the values of the variables &$n0$& &--
35926 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
35927 users' filter files. Thus a system filter can, for example, set up &"scores"&
35928 to which users' filter files can refer.
35929
35930
35931
35932 .section "Additional variable for system filters" "SECID215"
35933 .vindex "&$recipients$&"
35934 The expansion variable &$recipients$&, containing a list of all the recipients
35935 of the message (separated by commas and white space), is available in system
35936 filters. It is not available in users' filters for privacy reasons.
35937
35938
35939
35940 .section "Defer, freeze, and fail commands for system filters" "SECID216"
35941 .cindex "freezing messages"
35942 .cindex "message" "freezing"
35943 .cindex "message" "forced failure"
35944 .cindex "&%fail%&" "in system filter"
35945 .cindex "&%freeze%& in system filter"
35946 .cindex "&%defer%& in system filter"
35947 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
35948 always available in system filters, but are not normally enabled in users'
35949 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
35950 for the &(redirect)& router.) These commands can optionally be followed by the
35951 word &%text%& and a string containing an error message, for example:
35952 .code
35953 fail text "this message looks like spam to me"
35954 .endd
35955 The keyword &%text%& is optional if the next character is a double quote.
35956
35957 The &%defer%& command defers delivery of the original recipients of the
35958 message. The &%fail%& command causes all the original recipients to be failed,
35959 and a bounce message to be created. The &%freeze%& command suspends all
35960 delivery attempts for the original recipients. In all cases, any new deliveries
35961 that are specified by the filter are attempted as normal after the filter has
35962 run.
35963
35964 The &%freeze%& command is ignored if the message has been manually unfrozen and
35965 not manually frozen since. This means that automatic freezing by a system
35966 filter can be used as a way of checking out suspicious messages. If a message
35967 is found to be all right, manually unfreezing it allows it to be delivered.
35968
35969 .cindex "log" "&%fail%& command log line"
35970 .cindex "&%fail%&" "log line; reducing"
35971 The text given with a fail command is used as part of the bounce message as
35972 well as being written to the log. If the message is quite long, this can fill
35973 up a lot of log space when such failures are common. To reduce the size of the
35974 log message, Exim interprets the text in a special way if it starts with the
35975 two characters &`<<`& and contains &`>>`& later. The text between these two
35976 strings is written to the log, and the rest of the text is used in the bounce
35977 message. For example:
35978 .code
35979 fail "<<filter test 1>>Your message is rejected \
35980      because it contains attachments that we are \
35981      not prepared to receive."
35982 .endd
35983
35984 .cindex "loop" "caused by &%fail%&"
35985 Take great care with the &%fail%& command when basing the decision to fail on
35986 the contents of the message, because the bounce message will of course include
35987 the contents of the original message and will therefore trigger the &%fail%&
35988 command again (causing a mail loop) unless steps are taken to prevent this.
35989 Testing the &%error_message%& condition is one way to prevent this. You could
35990 use, for example
35991 .code
35992 if $message_body contains "this is spam" and not error_message
35993 then fail text "spam is not wanted here" endif
35994 .endd
35995 though of course that might let through unwanted bounce messages. The
35996 alternative is clever checking of the body and/or headers to detect bounces
35997 generated by the filter.
35998
35999 The interpretation of a system filter file ceases after a
36000 &%defer%&,
36001 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
36002 set up earlier in the filter file are honoured, so you can use a sequence such
36003 as
36004 .code
36005 mail ...
36006 freeze
36007 .endd
36008 to send a specified message when the system filter is freezing (or deferring or
36009 failing) a message. The normal deliveries for the message do not, of course,
36010 take place.
36011
36012
36013
36014 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
36015 .cindex "header lines" "adding; in system filter"
36016 .cindex "header lines" "removing; in system filter"
36017 .cindex "filter" "header lines; adding/removing"
36018 Two filter commands that are available only in system filters are:
36019 .code
36020 headers add <string>
36021 headers remove <string>
36022 .endd
36023 The argument for the &%headers add%& is a string that is expanded and then
36024 added to the end of the message's headers. It is the responsibility of the
36025 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
36026 space is ignored, and if the string is otherwise empty, or if the expansion is
36027 forced to fail, the command has no effect.
36028
36029 You can use &"\n"& within the string, followed by white space, to specify
36030 continued header lines. More than one header may be added in one command by
36031 including &"\n"& within the string without any following white space. For
36032 example:
36033 .code
36034 headers add "X-header-1: ....\n  \
36035              continuation of X-header-1 ...\n\
36036              X-header-2: ...."
36037 .endd
36038 Note that the header line continuation white space after the first newline must
36039 be placed before the backslash that continues the input string, because white
36040 space after input continuations is ignored.
36041
36042 The argument for &%headers remove%& is a colon-separated list of header names.
36043 This command applies only to those headers that are stored with the message;
36044 those that are added at delivery time (such as &'Envelope-To:'& and
36045 &'Return-Path:'&) cannot be removed by this means. If there is more than one
36046 header with the same name, they are all removed.
36047
36048 The &%headers%& command in a system filter makes an immediate change to the set
36049 of header lines that was received with the message (with possible additions
36050 from ACL processing). Subsequent commands in the system filter operate on the
36051 modified set, which also forms the basis for subsequent message delivery.
36052 Unless further modified during routing or transporting, this set of headers is
36053 used for all recipients of the message.
36054
36055 During routing and transporting, the variables that refer to the contents of
36056 header lines refer only to those lines that are in this set. Thus, header lines
36057 that are added by a system filter are visible to users' filter files and to all
36058 routers and transports. This contrasts with the manipulation of header lines by
36059 routers and transports, which is not immediate, but which instead is saved up
36060 until the message is actually being written (see section
36061 &<<SECTheadersaddrem>>&).
36062
36063 If the message is not delivered at the first attempt, header lines that were
36064 added by the system filter are stored with the message, and so are still
36065 present at the next delivery attempt. Header lines that were removed are still
36066 present, but marked &"deleted"& so that they are not transported with the
36067 message. For this reason, it is usual to make the &%headers%& command
36068 conditional on &%first_delivery%& so that the set of header lines is not
36069 modified more than once.
36070
36071 Because header modification in a system filter acts immediately, you have to
36072 use an indirect approach if you want to modify the contents of a header line.
36073 For example:
36074 .code
36075 headers add "Old-Subject: $h_subject:"
36076 headers remove "Subject"
36077 headers add "Subject: new subject (was: $h_old-subject:)"
36078 headers remove "Old-Subject"
36079 .endd
36080
36081
36082
36083 .section "Setting an errors address in a system filter" "SECID217"
36084 .cindex "envelope from"
36085 .cindex "envelope sender"
36086 In a system filter, if a &%deliver%& command is followed by
36087 .code
36088 errors_to <some address>
36089 .endd
36090 in order to change the envelope sender (and hence the error reporting) for that
36091 delivery, any address may be specified. (In a user filter, only the current
36092 user's address can be set.) For example, if some mail is being monitored, you
36093 might use
36094 .code
36095 unseen deliver monitor@spying.example errors_to root@local.example
36096 .endd
36097 to take a copy which would not be sent back to the normal error reporting
36098 address if its delivery failed.
36099
36100
36101
36102 .section "Per-address filtering" "SECTperaddfil"
36103 .vindex "&$domain_data$&"
36104 .vindex "&$local_part_data$&"
36105 In contrast to the system filter, which is run just once per message for each
36106 delivery attempt, it is also possible to set up a system-wide filtering
36107 operation that runs once for each recipient address. In this case, variables
36108 such as &$local_part_data$& and &$domain_data$& can be used,
36109 and indeed, the choice of filter file could be made dependent on them.
36110 This is an example of a router which implements such a filter:
36111 .code
36112 central_filter:
36113   check_local_user
36114   driver = redirect
36115   domains = +local_domains
36116   file = /central/filters/$local_part_data
36117   no_verify
36118   allow_filter
36119   allow_freeze
36120 .endd
36121 The filter is run in a separate process under its own uid. Therefore, either
36122 &%check_local_user%& must be set (as above), in which case the filter is run as
36123 the local user, or the &%user%& option must be used to specify which user to
36124 use. If both are set, &%user%& overrides.
36125
36126 Care should be taken to ensure that none of the commands in the filter file
36127 specify a significant delivery if the message is to go on to be delivered to
36128 its intended recipient. The router will not then claim to have dealt with the
36129 address, so it will be passed on to subsequent routers to be delivered in the
36130 normal way.
36131 .ecindex IIDsysfil1
36132 .ecindex IIDsysfil2
36133 .ecindex IIDsysfil3
36134
36135
36136
36137
36138
36139
36140 . ////////////////////////////////////////////////////////////////////////////
36141 . ////////////////////////////////////////////////////////////////////////////
36142
36143 .chapter "Message processing" "CHAPmsgproc"
36144 .scindex IIDmesproc "message" "general processing"
36145 Exim performs various transformations on the sender and recipient addresses of
36146 all messages that it handles, and also on the messages' header lines. Some of
36147 these are optional and configurable, while others always take place. All of
36148 this processing, except rewriting as a result of routing, and the addition or
36149 removal of header lines while delivering, happens when a message is received,
36150 before it is placed on Exim's queue.
36151
36152 Some of the automatic processing takes place by default only for
36153 &"locally-originated"& messages. This adjective is used to describe messages
36154 that are not received over TCP/IP, but instead are passed to an Exim process on
36155 its standard input. This includes the interactive &"local SMTP"& case that is
36156 set up by the &%-bs%& command line option.
36157
36158 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
36159 or ::1) are not considered to be locally-originated. Exim does not treat the
36160 loopback interface specially in any way.
36161
36162 If you want the loopback interface to be treated specially, you must ensure
36163 that there are appropriate entries in your ACLs.
36164
36165
36166
36167
36168 .section "Submission mode for non-local messages" "SECTsubmodnon"
36169 .cindex "message" "submission"
36170 .cindex "submission mode"
36171 Processing that happens automatically for locally-originated messages (unless
36172 &%suppress_local_fixups%& is set) can also be requested for messages that are
36173 received over TCP/IP. The term &"submission mode"& is used to describe this
36174 state. Submission mode is set by the modifier
36175 .code
36176 control = submission
36177 .endd
36178 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
36179 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
36180 a local submission, and is normally used when the source of the message is
36181 known to be an MUA running on a client host (as opposed to an MTA). For
36182 example, to set submission mode for messages originating on the IPv4 loopback
36183 interface, you could include the following in the MAIL ACL:
36184 .code
36185 warn  hosts = 127.0.0.1
36186       control = submission
36187 .endd
36188 .cindex "&%sender_retain%& submission option"
36189 There are some options that can be used when setting submission mode. A slash
36190 is used to separate options. For example:
36191 .code
36192 control = submission/sender_retain
36193 .endd
36194 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
36195 true and &%local_from_check%& false for the current incoming message. The first
36196 of these allows an existing &'Sender:'& header in the message to remain, and
36197 the second suppresses the check to ensure that &'From:'& matches the
36198 authenticated sender. With this setting, Exim still fixes up messages by adding
36199 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
36200 attempt to check sender authenticity in header lines.
36201
36202 When &%sender_retain%& is not set, a submission mode setting may specify a
36203 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
36204 example:
36205 .code
36206 control = submission/domain=some.domain
36207 .endd
36208 The domain may be empty. How this value is used is described in sections
36209 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
36210 that allows you to specify the user's full name for inclusion in a created
36211 &'Sender:'& or &'From:'& header line. For example:
36212 .code
36213 accept authenticated = *
36214        control = submission/domain=wonderland.example/\
36215                             name=${lookup {$authenticated_id} \
36216                                    lsearch {/etc/exim/namelist}}
36217 .endd
36218 Because the name may contain any characters, including slashes, the &%name%&
36219 option must be given last. The remainder of the string is used as the name. For
36220 the example above, if &_/etc/exim/namelist_& contains:
36221 .code
36222 bigegg:  Humpty Dumpty
36223 .endd
36224 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
36225 line would be:
36226 .code
36227 Sender: Humpty Dumpty <bigegg@wonderland.example>
36228 .endd
36229 .cindex "return path" "in submission mode"
36230 By default, submission mode forces the return path to the same address as is
36231 used to create the &'Sender:'& header. However, if &%sender_retain%& is
36232 specified, the return path is also left unchanged.
36233
36234 &*Note*&: The changes caused by submission mode take effect after the predata
36235 ACL. This means that any sender checks performed before the fix-ups use the
36236 untrusted sender address specified by the user, not the trusted sender address
36237 specified by submission mode. Although this might be slightly unexpected, it
36238 does mean that you can configure ACL checks to spot that a user is trying to
36239 spoof another's address.
36240
36241 .section "Line endings" "SECTlineendings"
36242 .cindex "line endings"
36243 .cindex "carriage return"
36244 .cindex "linefeed"
36245 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
36246 linefeed) is the line ending for messages transmitted over the Internet using
36247 SMTP over TCP/IP. However, within individual operating systems, different
36248 conventions are used. For example, Unix-like systems use just LF, but others
36249 use CRLF or just CR.
36250
36251 Exim was designed for Unix-like systems, and internally, it stores messages
36252 using the system's convention of a single LF as a line terminator. When
36253 receiving a message, all line endings are translated to this standard format.
36254 Originally, it was thought that programs that passed messages directly to an
36255 MTA within an operating system would use that system's convention. Experience
36256 has shown that this is not the case; for example, there are Unix applications
36257 that use CRLF in this circumstance. For this reason, and for compatibility with
36258 other MTAs, the way Exim handles line endings for all messages is now as
36259 follows:
36260
36261 .ilist
36262 LF not preceded by CR is treated as a line ending.
36263 .next
36264 CR is treated as a line ending; if it is immediately followed by LF, the LF
36265 is ignored.
36266 .next
36267 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
36268 nor a local message in the state where a line containing only a dot is a
36269 terminator.
36270 .next
36271 If a bare CR is encountered within a header line, an extra space is added after
36272 the line terminator so as not to end the header line. The reasoning behind this
36273 is that bare CRs in header lines are most likely either to be mistakes, or
36274 people trying to play silly games.
36275 .next
36276 If the first header line received in a message ends with CRLF, a subsequent
36277 bare LF in a header line is treated in the same way as a bare CR in a header
36278 line.
36279 .endlist
36280
36281
36282
36283
36284
36285 .section "Unqualified addresses" "SECID218"
36286 .cindex "unqualified addresses"
36287 .cindex "address" "qualification"
36288 By default, Exim expects every envelope address it receives from an external
36289 host to be fully qualified. Unqualified addresses cause negative responses to
36290 SMTP commands. However, because SMTP is used as a means of transporting
36291 messages from MUAs running on personal workstations, there is sometimes a
36292 requirement to accept unqualified addresses from specific hosts or IP networks.
36293
36294 Exim has two options that separately control which hosts may send unqualified
36295 sender or recipient addresses in SMTP commands, namely
36296 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
36297 cases, if an unqualified address is accepted, it is qualified by adding the
36298 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
36299
36300 .oindex "&%qualify_domain%&"
36301 .oindex "&%qualify_recipient%&"
36302 Unqualified addresses in header lines are automatically qualified for messages
36303 that are locally originated, unless the &%-bnq%& option is given on the command
36304 line. For messages received over SMTP, unqualified addresses in header lines
36305 are qualified only if unqualified addresses are permitted in SMTP commands. In
36306 other words, such qualification is also controlled by
36307 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
36308
36309
36310
36311
36312 .section "The UUCP From line" "SECID219"
36313 .cindex "&""From""& line"
36314 .cindex "UUCP" "&""From""& line"
36315 .cindex "sender" "address"
36316 .oindex "&%uucp_from_pattern%&"
36317 .oindex "&%uucp_from_sender%&"
36318 .cindex "envelope from"
36319 .cindex "envelope sender"
36320 .cindex "Sendmail compatibility" "&""From""& line"
36321 Messages that have come from UUCP (and some other applications) often begin
36322 with a line containing the envelope sender and a timestamp, following the word
36323 &"From"&. Examples of two common formats are:
36324 .code
36325 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
36326 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
36327 .endd
36328 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
36329 Exim recognizes such lines at the start of messages that are submitted to it
36330 via the command line (that is, on the standard input). It does not recognize
36331 such lines in incoming SMTP messages, unless the sending host matches
36332 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36333 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36334 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36335 default value matches the two common cases shown above and puts the address
36336 that follows &"From"& into &$1$&.
36337
36338 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36339 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36340 a trusted user, the message's sender address is constructed by expanding the
36341 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36342 then parsed as an RFC 2822 address. If there is no domain, the local part is
36343 qualified with &%qualify_domain%& unless it is the empty string. However, if
36344 the command line &%-f%& option is used, it overrides the &"From"& line.
36345
36346 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36347 sender address is not changed. This is also the case for incoming SMTP messages
36348 that are permitted to contain &"From"& lines.
36349
36350 Only one &"From"& line is recognized. If there is more than one, the second is
36351 treated as a data line that starts the body of the message, as it is not valid
36352 as a header line. This also happens if a &"From"& line is present in an
36353 incoming SMTP message from a source that is not permitted to send them.
36354
36355
36356
36357 .section "Header lines"
36358 .subsection "Resent- header lines" SECID220
36359 .chindex Resent-
36360 RFC 2822 makes provision for sets of header lines starting with the string
36361 &`Resent-`& to be added to a message when it is resent by the original
36362 recipient to somebody else. These headers are &'Resent-Date:'&,
36363 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36364 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36365
36366 .blockquote
36367 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36368 processing of replies or other such automatic actions on messages.'&
36369 .endblockquote
36370
36371 This leaves things a bit vague as far as other processing actions such as
36372 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36373 follows:
36374
36375 .ilist
36376 A &'Resent-From:'& line that just contains the login id of the submitting user
36377 is automatically rewritten in the same way as &'From:'& (see below).
36378 .next
36379 If there's a rewriting rule for a particular header line, it is also applied to
36380 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36381 &'From:'& also rewrites &'Resent-From:'&.
36382 .next
36383 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36384 also removed.
36385 .next
36386 For a locally-submitted message,
36387 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36388 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36389 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36390 included in log lines in this case.
36391 .next
36392 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36393 &%Resent-%& header lines are present.
36394 .endlist
36395
36396
36397
36398
36399 .subsection Auto-Submitted: SECID221
36400 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36401 includes the header line:
36402 .code
36403 Auto-Submitted: auto-replied
36404 .endd
36405
36406 .subsection Bcc: SECID222
36407 .cindex "&'Bcc:'& header line"
36408 If Exim is called with the &%-t%& option, to take recipient addresses from a
36409 message's header, it removes any &'Bcc:'& header line that may exist (after
36410 extracting its addresses). If &%-t%& is not present on the command line, any
36411 existing &'Bcc:'& is not removed.
36412
36413
36414 .subsection Date: SECID223
36415 .cindex Date:
36416 If a locally-generated or submission-mode message has no &'Date:'& header line,
36417 Exim adds one, using the current date and time, unless the
36418 &%suppress_local_fixups%& control has been specified.
36419
36420 .subsection Delivery-date: SECID224
36421 .cindex "&'Delivery-date:'& header line"
36422 .oindex "&%delivery_date_remove%&"
36423 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36424 set. Exim can be configured to add them to the final delivery of messages. (See
36425 the generic &%delivery_date_add%& transport option.) They should not be present
36426 in messages in transit. If the &%delivery_date_remove%& configuration option is
36427 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36428 messages.
36429
36430
36431 .subsection Envelope-to: SECID225
36432 .chindex Envelope-to:
36433 .oindex "&%envelope_to_remove%&"
36434 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36435 Exim can be configured to add them to the final delivery of messages. (See the
36436 generic &%envelope_to_add%& transport option.) They should not be present in
36437 messages in transit. If the &%envelope_to_remove%& configuration option is set
36438 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36439 messages.
36440
36441
36442 .subsection From: SECTthefrohea
36443 .chindex From:
36444 .cindex "Sendmail compatibility" "&""From""& line"
36445 .cindex "message" "submission"
36446 .cindex "submission mode"
36447 If a submission-mode message does not contain a &'From:'& header line, Exim
36448 adds one if either of the following conditions is true:
36449
36450 .ilist
36451 The envelope sender address is not empty (that is, this is not a bounce
36452 message). The added header line copies the envelope sender address.
36453 .next
36454 .vindex "&$authenticated_id$&"
36455 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36456 .olist
36457 .vindex "&$qualify_domain$&"
36458 If no domain is specified by the submission control, the local part is
36459 &$authenticated_id$& and the domain is &$qualify_domain$&.
36460 .next
36461 If a non-empty domain is specified by the submission control, the local
36462 part is &$authenticated_id$&, and the domain is the specified domain.
36463 .next
36464 If an empty domain is specified by the submission control,
36465 &$authenticated_id$& is assumed to be the complete address.
36466 .endlist
36467 .endlist
36468
36469 A non-empty envelope sender takes precedence.
36470
36471 If a locally-generated incoming message does not contain a &'From:'& header
36472 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36473 containing the sender's address. The calling user's login name and full name
36474 are used to construct the address, as described in section &<<SECTconstr>>&.
36475 They are obtained from the password data by calling &[getpwuid()]& (but see the
36476 &%unknown_login%& configuration option). The address is qualified with
36477 &%qualify_domain%&.
36478
36479 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36480 &'From:'& header line containing just the unqualified login name of the calling
36481 user, this is replaced by an address containing the user's login name and full
36482 name as described in section &<<SECTconstr>>&.
36483
36484
36485 .subsection Message-ID: SECID226
36486 .chindex Message-ID:
36487 .cindex "message" "submission"
36488 .oindex "&%message_id_header_text%&"
36489 If a locally-generated or submission-mode incoming message does not contain a
36490 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36491 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36492 to the message. If there are any &'Resent-:'& headers in the message, it
36493 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36494 message id, preceded by the letter E to ensure it starts with a letter, and
36495 followed by @ and the primary host name. Additional information can be included
36496 in this header line by setting the &%message_id_header_text%& and/or
36497 &%message_id_header_domain%& options.
36498
36499
36500 .subsection Received: SECID227
36501 .chindex Received:
36502 A &'Received:'& header line is added at the start of every message. The
36503 contents are defined by the &%received_header_text%& configuration option, and
36504 Exim automatically adds a semicolon and a timestamp to the configured string.
36505
36506 The &'Received:'& header is generated as soon as the message's header lines
36507 have been received. At this stage, the timestamp in the &'Received:'& header
36508 line is the time that the message started to be received. This is the value
36509 that is seen by the DATA ACL and by the &[local_scan()]& function.
36510
36511 Once a message is accepted, the timestamp in the &'Received:'& header line is
36512 changed to the time of acceptance, which is (apart from a small delay while the
36513 -H spool file is written) the earliest time at which delivery could start.
36514
36515
36516 .subsection References: SECID228
36517 .chindex References:
36518 Messages created by the &(autoreply)& transport include a &'References:'&
36519 header line. This is constructed according to the rules that are described in
36520 section 3.64 of RFC 2822 (which states that replies should contain such a
36521 header line), and section 3.14 of RFC 3834 (which states that automatic
36522 responses are not different in this respect). However, because some mail
36523 processing software does not cope well with very long header lines, no more
36524 than 12 message IDs are copied from the &'References:'& header line in the
36525 incoming message. If there are more than 12, the first one and then the final
36526 11 are copied, before adding the message ID of the incoming message.
36527
36528
36529
36530 .subsection Return-path: SECID229
36531 .chindex Return-path:
36532 .oindex "&%return_path_remove%&"
36533 &'Return-path:'& header lines are defined as something an MTA may insert when
36534 it does the final delivery of messages. (See the generic &%return_path_add%&
36535 transport option.) Therefore, they should not be present in messages in
36536 transit. If the &%return_path_remove%& configuration option is set (the
36537 default), Exim removes &'Return-path:'& header lines from incoming messages.
36538
36539
36540
36541 .subsection Sender: SECTthesenhea
36542 .cindex "&'Sender:'& header line"
36543 .cindex "message" "submission"
36544 .chindex Sender:
36545 For a locally-originated message from an untrusted user, Exim may remove an
36546 existing &'Sender:'& header line, and it may add a new one. You can modify
36547 these actions by setting the &%local_sender_retain%& option true, the
36548 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36549 control setting.
36550
36551 When a local message is received from an untrusted user and
36552 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36553 control has not been set, a check is made to see if the address given in the
36554 &'From:'& header line is the correct (local) sender of the message. The address
36555 that is expected has the login name as the local part and the value of
36556 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36557 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36558 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36559 line is added to the message.
36560
36561 If you set &%local_from_check%& false, this checking does not occur. However,
36562 the removal of an existing &'Sender:'& line still happens, unless you also set
36563 &%local_sender_retain%& to be true. It is not possible to set both of these
36564 options true at the same time.
36565
36566 .cindex "submission mode"
36567 By default, no processing of &'Sender:'& header lines is done for messages
36568 received over TCP/IP or for messages submitted by trusted users. However, when
36569 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36570 not specified on the submission control, the following processing takes place:
36571
36572 .vindex "&$authenticated_id$&"
36573 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36574 authenticated, and &$authenticated_id$& is not empty, a sender address is
36575 created as follows:
36576
36577 .ilist
36578 .vindex "&$qualify_domain$&"
36579 If no domain is specified by the submission control, the local part is
36580 &$authenticated_id$& and the domain is &$qualify_domain$&.
36581 .next
36582 If a non-empty domain is specified by the submission control, the local part
36583 is &$authenticated_id$&, and the domain is the specified domain.
36584 .next
36585 If an empty domain is specified by the submission control,
36586 &$authenticated_id$& is assumed to be the complete address.
36587 .endlist
36588
36589 This address is compared with the address in the &'From:'& header line. If they
36590 are different, a &'Sender:'& header line containing the created address is
36591 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36592 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36593
36594 .cindex "return path" "created from &'Sender:'&"
36595 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36596 the message (the envelope sender address) is changed to be the same address,
36597 except in the case of submission mode when &%sender_retain%& is specified.
36598
36599
36600
36601 .section "Adding and removing header lines in routers and transports" &&&
36602          "SECTheadersaddrem"
36603 .cindex "header lines" "adding; in router or transport"
36604 .cindex "header lines" "removing; in router or transport"
36605 When a message is delivered, the addition and removal of header lines can be
36606 specified in a system filter, or on any of the routers and transports that
36607 process the message. Section &<<SECTaddremheasys>>& contains details about
36608 modifying headers in a system filter. Header lines can also be added in an ACL
36609 as a message is received (see section &<<SECTaddheadacl>>&).
36610
36611 In contrast to what happens in a system filter, header modifications that are
36612 specified on routers and transports apply only to the particular recipient
36613 addresses that are being processed by those routers and transports. These
36614 changes do not actually take place until a copy of the message is being
36615 transported. Therefore, they do not affect the basic set of header lines, and
36616 they do not affect the values of the variables that refer to header lines.
36617
36618 &*Note*&: In particular, this means that any expansions in the configuration of
36619 the transport cannot refer to the modified header lines, because such
36620 expansions all occur before the message is actually transported.
36621
36622 For both routers and transports, the argument of a &%headers_add%&
36623 option must be in the form of one or more RFC 2822 header lines, separated by
36624 newlines (coded as &"\n"&). For example:
36625 .code
36626 headers_add = X-added-header: added by $primary_hostname\n\
36627               X-added-second: another added header line
36628 .endd
36629 Exim does not check the syntax of these added header lines.
36630
36631 Multiple &%headers_add%& options for a single router or transport can be
36632 specified; the values will append to a single list of header lines.
36633 Each header-line is separately expanded.
36634
36635 The argument of a &%headers_remove%& option must consist of a colon-separated
36636 list of header names. This is confusing, because header names themselves are
36637 often terminated by colons. In this case, the colons are the list separators,
36638 not part of the names. For example:
36639 .code
36640 headers_remove = return-receipt-to:acknowledge-to
36641 .endd
36642
36643 Multiple &%headers_remove%& options for a single router or transport can be
36644 specified; the arguments will append to a single header-names list.
36645 Each item is separately expanded.
36646 Note that colons in complex expansions which are used to
36647 form all or part of a &%headers_remove%& list
36648 will act as list separators.
36649
36650 When &%headers_add%& or &%headers_remove%& is specified on a router,
36651 items are expanded at routing time,
36652 and then associated with all addresses that are
36653 accepted by that router, and also with any new addresses that it generates. If
36654 an address passes through several routers as a result of aliasing or
36655 forwarding, the changes are cumulative.
36656
36657 .oindex "&%unseen%&"
36658 However, this does not apply to multiple routers that result from the use of
36659 the &%unseen%& option. Any header modifications that were specified by the
36660 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36661
36662 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36663 settings cannot be delivered together in a batch, so a transport is always
36664 dealing with a set of addresses that have the same header-processing
36665 requirements.
36666
36667 The transport starts by writing the original set of header lines that arrived
36668 with the message, possibly modified by the system filter. As it writes out
36669 these lines, it consults the list of header names that were attached to the
36670 recipient address(es) by &%headers_remove%& options in routers, and it also
36671 consults the transport's own &%headers_remove%& option. Header lines whose
36672 names are on either of these lists are not written out. If there are multiple
36673 instances of any listed header, they are all skipped.
36674
36675 After the remaining original header lines have been written, new header
36676 lines that were specified by routers' &%headers_add%& options are written, in
36677 the order in which they were attached to the address. These are followed by any
36678 header lines specified by the transport's &%headers_add%& option.
36679
36680 This way of handling header line modifications in routers and transports has
36681 the following consequences:
36682
36683 .ilist
36684 The original set of header lines, possibly modified by the system filter,
36685 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36686 to it, at all times.
36687 .next
36688 Header lines that are added by a router's
36689 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36690 expansion syntax in subsequent routers or the transport.
36691 .next
36692 Conversely, header lines that are specified for removal by &%headers_remove%&
36693 in a router remain visible to subsequent routers and the transport.
36694 .next
36695 Headers added to an address by &%headers_add%& in a router cannot be removed by
36696 a later router or by a transport.
36697 .next
36698 An added header can refer to the contents of an original header that is to be
36699 removed, even it has the same name as the added header. For example:
36700 .code
36701 headers_remove = subject
36702 headers_add = Subject: new subject (was: $h_subject:)
36703 .endd
36704 .endlist
36705
36706 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36707 for a &(redirect)& router that has the &%one_time%& option set.
36708
36709
36710
36711
36712
36713 .section "Constructed addresses" "SECTconstr"
36714 .cindex "address" "constructed"
36715 .cindex "constructed address"
36716 When Exim constructs a sender address for a locally-generated message, it uses
36717 the form
36718 .display
36719 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36720 .endd
36721 For example:
36722 .code
36723 Zaphod Beeblebrox <zaphod@end.univ.example>
36724 .endd
36725 The user name is obtained from the &%-F%& command line option if set, or
36726 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36727 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36728 ampersand character, this is replaced by the login name with the first letter
36729 upper cased, as is conventional in a number of operating systems. See the
36730 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36731 The &%unknown_username%& option can be used to specify user names in cases when
36732 there is no password file entry.
36733
36734 .cindex "RFC 2047"
36735 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36736 parts of it if necessary. In addition, if it contains any non-printing
36737 characters, it is encoded as described in RFC 2047, which defines a way of
36738 including non-ASCII characters in header lines. The value of the
36739 &%headers_charset%& option specifies the name of the encoding that is used (the
36740 characters are assumed to be in this encoding). The setting of
36741 &%print_topbitchars%& controls whether characters with the top bit set (that
36742 is, with codes greater than 127) count as printing characters or not.
36743
36744
36745
36746 .section "Case of local parts" "SECID230"
36747 .cindex "case of local parts"
36748 .cindex "local part" "case of"
36749 RFC 2822 states that the case of letters in the local parts of addresses cannot
36750 be assumed to be non-significant. Exim preserves the case of local parts of
36751 addresses, but by default it uses a lower-cased form when it is routing,
36752 because on most Unix systems, usernames are in lower case and case-insensitive
36753 routing is required. However, any particular router can be made to use the
36754 original case for local parts by setting the &%caseful_local_part%& generic
36755 router option.
36756
36757 .cindex "mixed-case login names"
36758 If you must have mixed-case user names on your system, the best way to proceed,
36759 assuming you want case-independent handling of incoming email, is to set up
36760 your first router to convert incoming local parts in your domains to the
36761 correct case by means of a file lookup. For example:
36762 .code
36763 correct_case:
36764   driver = redirect
36765   domains = +local_domains
36766   data = ${lookup{$local_part}cdb\
36767               {/etc/usercased.cdb}{$value}fail}\
36768               @$domain
36769 .endd
36770 For this router, the local part is forced to lower case by the default action
36771 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36772 up a new local part in the correct case. If you then set &%caseful_local_part%&
36773 on any subsequent routers which process your domains, they will operate on
36774 local parts with the correct case in a case-sensitive manner.
36775
36776
36777
36778 .section "Dots in local parts" "SECID231"
36779 .cindex "dot" "in local part"
36780 .cindex "local part" "dots in"
36781 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36782 part may not begin or end with a dot, nor have two consecutive dots in the
36783 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36784 empty components for compatibility.
36785
36786
36787
36788 .section "Rewriting addresses" "SECID232"
36789 .cindex "rewriting" "addresses"
36790 Rewriting of sender and recipient addresses, and addresses in headers, can
36791 happen automatically, or as the result of configuration options, as described
36792 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
36793 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
36794
36795 Automatic rewriting includes qualification, as mentioned above. The other case
36796 in which it can happen is when an incomplete non-local domain is given. The
36797 routing process may cause this to be expanded into the full domain name. For
36798 example, a header such as
36799 .code
36800 To: hare@teaparty
36801 .endd
36802 might get rewritten as
36803 .code
36804 To: hare@teaparty.wonderland.fict.example
36805 .endd
36806 Rewriting as a result of routing is the one kind of message processing that
36807 does not happen at input time, as it cannot be done until the address has
36808 been routed.
36809
36810 Strictly, one should not do &'any'& deliveries of a message until all its
36811 addresses have been routed, in case any of the headers get changed as a
36812 result of routing. However, doing this in practice would hold up many
36813 deliveries for unreasonable amounts of time, just because one address could not
36814 immediately be routed. Exim therefore does not delay other deliveries when
36815 routing of one or more addresses is deferred.
36816 .ecindex IIDmesproc
36817
36818
36819
36820 . ////////////////////////////////////////////////////////////////////////////
36821 . ////////////////////////////////////////////////////////////////////////////
36822
36823 .chapter "SMTP processing" "CHAPSMTP"
36824 .scindex IIDsmtpproc1 "SMTP" "processing details"
36825 .scindex IIDsmtpproc2 "LMTP" "processing details"
36826 Exim supports a number of different ways of using the SMTP protocol, and its
36827 LMTP variant, which is an interactive protocol for transferring messages into a
36828 closed mail store application. This chapter contains details of how SMTP is
36829 processed. For incoming mail, the following are available:
36830
36831 .ilist
36832 SMTP over TCP/IP (Exim daemon or &'inetd'&);
36833 .next
36834 SMTP over the standard input and output (the &%-bs%& option);
36835 .next
36836 Batched SMTP on the standard input (the &%-bS%& option).
36837 .endlist
36838
36839 For mail delivery, the following are available:
36840
36841 .ilist
36842 SMTP over TCP/IP (the &(smtp)& transport);
36843 .next
36844 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
36845 &"lmtp"&);
36846 .next
36847 LMTP over a pipe to a process running in the local host (the &(lmtp)&
36848 transport);
36849 .next
36850 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
36851 the &%use_bsmtp%& option set).
36852 .endlist
36853
36854 &'Batched SMTP'& is the name for a process in which batches of messages are
36855 stored in or read from files (or pipes), in a format in which SMTP commands are
36856 used to contain the envelope information.
36857
36858
36859
36860 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
36861 .cindex "SMTP" "outgoing over TCP/IP"
36862 .cindex "outgoing SMTP over TCP/IP"
36863 .cindex "LMTP" "over TCP/IP"
36864 .cindex "outgoing LMTP over TCP/IP"
36865 .cindex "EHLO"
36866 .cindex "HELO"
36867 .cindex "SIZE" "option on MAIL command"
36868 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
36869 The &%protocol%& option selects which protocol is to be used, but the actual
36870 processing is the same in both cases.
36871
36872 .cindex "ESMTP extensions" SIZE
36873 If, in response to its EHLO command, Exim is told that the SIZE
36874 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
36875 command. The value of <&'n'&> is the message size plus the value of the
36876 &%size_addition%& option (default 1024) to allow for additions to the message
36877 such as per-transport header lines, or changes made in a
36878 .cindex "transport" "filter"
36879 .cindex "filter" "transport filter"
36880 transport filter. If &%size_addition%& is set negative, the use of SIZE is
36881 suppressed.
36882
36883 If the remote server advertises support for PIPELINING, Exim uses the
36884 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
36885 required for the transaction.
36886
36887 If the remote server advertises support for the STARTTLS command, and Exim
36888 was built to support TLS encryption, it tries to start a TLS session unless the
36889 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
36890 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
36891 is called for verification.
36892
36893 If the remote server advertises support for the AUTH command, Exim scans
36894 the authenticators configuration for any suitable client settings, as described
36895 in chapter &<<CHAPSMTPAUTH>>&.
36896
36897 .cindex "carriage return"
36898 .cindex "linefeed"
36899 Responses from the remote host are supposed to be terminated by CR followed by
36900 LF. However, there are known to be hosts that do not send CR characters, so in
36901 order to be able to interwork with such hosts, Exim treats LF on its own as a
36902 line terminator.
36903
36904 If a message contains a number of different addresses, all those with the same
36905 characteristics (for example, the same envelope sender) that resolve to the
36906 same set of hosts, in the same order, are sent in a single SMTP transaction,
36907 even if they are for different domains, unless there are more than the setting
36908 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
36909 they are split into groups containing no more than &%max_rcpt%&s addresses
36910 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
36911 in parallel sessions. The order of hosts with identical MX values is not
36912 significant when checking whether addresses can be batched in this way.
36913
36914 When the &(smtp)& transport suffers a temporary failure that is not
36915 message-related, Exim updates its transport-specific database, which contains
36916 records indexed by host name that remember which messages are waiting for each
36917 particular host. It also updates the retry database with new retry times.
36918
36919 .cindex "hints database" "retry keys"
36920 Exim's retry hints are based on host name plus IP address, so if one address of
36921 a multi-homed host is broken, it will soon be skipped most of the time.
36922 See the next section for more detail about error handling.
36923
36924 .cindex "SMTP" "passed connection"
36925 .cindex "SMTP" "batching over TCP/IP"
36926 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
36927 looks in the hints database for the transport to see if there are any queued
36928 messages waiting for the host to which it is connected. If it finds one, it
36929 creates a new Exim process using the &%-MC%& option (which can only be used by
36930 a process running as root or the Exim user) and passes the TCP/IP socket to it
36931 so that it can deliver another message using the same socket. The new process
36932 does only those deliveries that are routed to the connected host, and may in
36933 turn pass the socket on to a third process, and so on.
36934
36935 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
36936 limit the number of messages sent down a single TCP/IP connection.
36937
36938 .cindex "asterisk" "after IP address"
36939 The second and subsequent messages delivered down an existing connection are
36940 identified in the main log by the addition of an asterisk after the closing
36941 square bracket of the IP address.
36942
36943
36944
36945
36946 .subsection "Errors in outgoing SMTP" SECToutSMTPerr
36947 .cindex "error" "in outgoing SMTP"
36948 .cindex "SMTP" "errors in outgoing"
36949 .cindex "host" "error"
36950 Three different kinds of error are recognized for outgoing SMTP: host errors,
36951 message errors, and recipient errors.
36952
36953 .vlist
36954 .vitem "&*Host errors*&"
36955 A host error is not associated with a particular message or with a
36956 particular recipient of a message. The host errors are:
36957
36958 .ilist
36959 Connection refused or timed out,
36960 .next
36961 Any error response code on connection,
36962 .next
36963 Any error response code to EHLO or HELO,
36964 .next
36965 Loss of connection at any time, except after &"."&,
36966 .next
36967 I/O errors at any time,
36968 .next
36969 Timeouts during the session, other than in response to MAIL, RCPT or
36970 the &"."& at the end of the data.
36971 .endlist ilist
36972
36973 For a host error, a permanent error response on connection, or in response to
36974 EHLO, causes all addresses routed to the host to be failed. Any other host
36975 error causes all addresses to be deferred, and retry data to be created for the
36976 host. It is not tried again, for any message, until its retry time arrives. If
36977 the current set of addresses are not all delivered in this run (to some
36978 alternative host), the message is added to the list of those waiting for this
36979 host, so if it is still undelivered when a subsequent successful delivery is
36980 made to the host, it will be sent down the same SMTP connection.
36981
36982 .vitem "&*Message errors*&"
36983 .cindex "message" "error"
36984 A message error is associated with a particular message when sent to a
36985 particular host, but not with a particular recipient of the message. The
36986 message errors are:
36987
36988 .ilist
36989 Any error response code to MAIL, DATA, or the &"."& that terminates
36990 the data,
36991 .next
36992 Timeout after MAIL,
36993 .next
36994 Timeout or loss of connection after the &"."& that terminates the data. A
36995 timeout after the DATA command itself is treated as a host error, as is loss of
36996 connection at any other time.
36997 .endlist ilist
36998
36999 For a message error, a permanent error response (5&'xx'&) causes all addresses
37000 to be failed, and a delivery error report to be returned to the sender. A
37001 temporary error response (4&'xx'&), or one of the timeouts, causes all
37002 addresses to be deferred. Retry data is not created for the host, but instead,
37003 a retry record for the combination of host plus message id is created. The
37004 message is not added to the list of those waiting for this host. This ensures
37005 that the failing message will not be sent to this host again until the retry
37006 time arrives. However, other messages that are routed to the host are not
37007 affected, so if it is some property of the message that is causing the error,
37008 it will not stop the delivery of other mail.
37009
37010 If the remote host specified support for the SIZE parameter in its response
37011 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
37012 over-large message will cause a message error because the error arrives as a
37013 response to MAIL.
37014
37015 .vitem "&*Recipient errors*&"
37016 .cindex "recipient" "error"
37017 A recipient error is associated with a particular recipient of a message. The
37018 recipient errors are:
37019
37020 .ilist
37021 Any error response to RCPT,
37022 .next
37023 Timeout after RCPT.
37024 .endlist
37025
37026 For a recipient error, a permanent error response (5&'xx'&) causes the
37027 recipient address to be failed, and a bounce message to be returned to the
37028 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
37029 address to be deferred, and routing retry data to be created for it. This is
37030 used to delay processing of the address in subsequent queue runs, until its
37031 routing retry time arrives. This applies to all messages, but because it
37032 operates only in queue runs, one attempt will be made to deliver a new message
37033 to the failing address before the delay starts to operate. This ensures that,
37034 if the failure is really related to the message rather than the recipient
37035 (&"message too big for this recipient"& is a possible example), other messages
37036 have a chance of getting delivered. If a delivery to the address does succeed,
37037 the retry information gets cleared, so all stuck messages get tried again, and
37038 the retry clock is reset.
37039
37040 The message is not added to the list of those waiting for this host. Use of the
37041 host for other messages is unaffected, and except in the case of a timeout,
37042 other recipients are processed independently, and may be successfully delivered
37043 in the current SMTP session. After a timeout it is of course impossible to
37044 proceed with the session, so all addresses get deferred. However, those other
37045 than the one that failed do not suffer any subsequent retry delays. Therefore,
37046 if one recipient is causing trouble, the others have a chance of getting
37047 through when a subsequent delivery attempt occurs before the failing
37048 recipient's retry time.
37049 .endlist
37050
37051 In all cases, if there are other hosts (or IP addresses) available for the
37052 current set of addresses (for example, from multiple MX records), they are
37053 tried in this run for any undelivered addresses, subject of course to their
37054 own retry data. In other words, recipient error retry data does not take effect
37055 until the next delivery attempt.
37056
37057 Some hosts have been observed to give temporary error responses to every
37058 MAIL command at certain times (&"insufficient space"& has been seen). It
37059 would be nice if such circumstances could be recognized, and defer data for the
37060 host itself created, but this is not possible within the current Exim design.
37061 What actually happens is that retry data for every (host, message) combination
37062 is created.
37063
37064 The reason that timeouts after MAIL and RCPT are treated specially is that
37065 these can sometimes arise as a result of the remote host's verification
37066 procedures. Exim makes this assumption, and treats them as if a temporary error
37067 response had been received. A timeout after &"."& is treated specially because
37068 it is known that some broken implementations fail to recognize the end of the
37069 message if the last character of the last line is a binary zero. Thus, it is
37070 helpful to treat this case as a message error.
37071
37072 Timeouts at other times are treated as host errors, assuming a problem with the
37073 host, or the connection to it. If a timeout after MAIL, RCPT,
37074 or &"."& is really a connection problem, the assumption is that at the next try
37075 the timeout is likely to occur at some other point in the dialogue, causing it
37076 then to be treated as a host error.
37077
37078 There is experimental evidence that some MTAs drop the connection after the
37079 terminating &"."& if they do not like the contents of the message for some
37080 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
37081 should be given. That is why Exim treats this case as a message rather than a
37082 host error, in order not to delay other messages to the same host.
37083
37084
37085
37086
37087 .section "Incoming SMTP messages over TCP/IP" "SECID233"
37088 .cindex "SMTP" "incoming over TCP/IP"
37089 .cindex "incoming SMTP over TCP/IP"
37090 .cindex "inetd"
37091 .cindex "daemon"
37092 Incoming SMTP messages can be accepted in one of two ways: by running a
37093 listening daemon, or by using &'inetd'&. In the latter case, the entry in
37094 &_/etc/inetd.conf_& should be like this:
37095 .code
37096 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
37097 .endd
37098 Exim distinguishes between this case and the case of a locally running user
37099 agent using the &%-bs%& option by checking whether or not the standard input is
37100 a socket. When it is, either the port must be privileged (less than 1024), or
37101 the caller must be root or the Exim user. If any other user passes a socket
37102 with an unprivileged port number, Exim prints a message on the standard error
37103 stream and exits with an error code.
37104
37105 By default, Exim does not make a log entry when a remote host connects or
37106 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
37107 unexpected. It can be made to write such log entries by setting the
37108 &%smtp_connection%& log selector.
37109
37110 .cindex "carriage return"
37111 .cindex "linefeed"
37112 Commands from the remote host are supposed to be terminated by CR followed by
37113 LF. However, there are known to be hosts that do not send CR characters. In
37114 order to be able to interwork with such hosts, Exim treats LF on its own as a
37115 line terminator.
37116 Furthermore, because common code is used for receiving messages from all
37117 sources, a CR on its own is also interpreted as a line terminator. However, the
37118 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
37119
37120 .cindex "EHLO" "invalid data"
37121 .cindex "HELO" "invalid data"
37122 One area that sometimes gives rise to problems concerns the EHLO or
37123 HELO commands. Some clients send syntactically invalid versions of these
37124 commands, which Exim rejects by default. (This is nothing to do with verifying
37125 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
37126 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
37127 match the broken hosts that send invalid commands.
37128
37129 .cindex "SIZE option on MAIL command"
37130 .cindex "MAIL" "SIZE option"
37131 The amount of disk space available is checked whenever SIZE is received on
37132 a MAIL command, independently of whether &%message_size_limit%& or
37133 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
37134 false. A temporary error is given if there is not enough space. If
37135 &%check_spool_space%& is set, the check is for that amount of space plus the
37136 value given with SIZE, that is, it checks that the addition of the incoming
37137 message will not reduce the space below the threshold.
37138
37139 When a message is successfully received, Exim includes the local message id in
37140 its response to the final &"."& that terminates the data. If the remote host
37141 logs this text it can help with tracing what has happened to a message.
37142
37143 The Exim daemon can limit the number of simultaneous incoming connections it is
37144 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
37145 number of simultaneous incoming connections from a single remote host (see the
37146 &%smtp_accept_max_per_host%& option). Additional connection attempts are
37147 rejected using the SMTP temporary error code 421.
37148
37149 The Exim daemon does not rely on the SIGCHLD signal to detect when a
37150 subprocess has finished, as this can get lost at busy times. Instead, it looks
37151 for completed subprocesses every time it wakes up. Provided there are other
37152 things happening (new incoming calls, starts of queue runs), completed
37153 processes will be noticed and tidied away. On very quiet systems you may
37154 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
37155 it will be noticed when the daemon next wakes up.
37156
37157 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
37158 and can also be set up to reject SMTP calls from non-reserved hosts at times of
37159 high system load &-- for details see the &%smtp_accept_reserve%&,
37160 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
37161 applies in both the daemon and &'inetd'& cases.
37162
37163 Exim normally starts a delivery process for each message received, though this
37164 can be varied by means of the &%-odq%& command line option and the
37165 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
37166 number of simultaneously running delivery processes started in this way from
37167 SMTP input can be limited by the &%smtp_accept_queue%& and
37168 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
37169 subsequently received messages are just put on the input queue without starting
37170 a delivery process.
37171
37172 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
37173 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
37174 started up from the &'inetd'& daemon, because in that case each connection is
37175 handled by an entirely independent Exim process. Control by load average is,
37176 however, available with &'inetd'&.
37177
37178 Exim can be configured to verify addresses in incoming SMTP commands as they
37179 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
37180 to rewrite addresses at this time &-- before any syntax checking is done. See
37181 section &<<SSECTrewriteS>>&.
37182
37183 Exim can also be configured to limit the rate at which a client host submits
37184 MAIL and RCPT commands in a single SMTP session. See the
37185 &%smtp_ratelimit_hosts%& option.
37186
37187
37188
37189 .subsection "Unrecognized SMTP commands" SECID234
37190 .cindex "SMTP" "unrecognized commands"
37191 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
37192 commands during a single SMTP connection, it drops the connection after sending
37193 the error response to the last command. The default value for
37194 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
37195 abuse that subvert web servers into making connections to SMTP ports; in these
37196 circumstances, a number of non-SMTP lines are sent first.
37197
37198
37199 .subsection "Syntax and protocol errors in SMTP commands" SECID235
37200 .cindex "SMTP" "syntax errors"
37201 .cindex "SMTP" "protocol errors"
37202 A syntax error is detected if an SMTP command is recognized, but there is
37203 something syntactically wrong with its data, for example, a malformed email
37204 address in a RCPT command. Protocol errors include invalid command
37205 sequencing such as RCPT before MAIL. If Exim receives more than
37206 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
37207 drops the connection after sending the error response to the last command. The
37208 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
37209 broken clients that loop sending bad commands (yes, it has been seen).
37210
37211
37212
37213 .subsection "Use of non-mail SMTP commands" SECID236
37214 .cindex "SMTP" "non-mail commands"
37215 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
37216 DATA. Exim counts such commands, and drops the connection if there are too
37217 many of them in a single SMTP session. This action catches some
37218 denial-of-service attempts and things like repeated failing AUTHs, or a mad
37219 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
37220 defines what &"too many"& means. Its default value is 10.
37221
37222 When a new message is expected, one occurrence of RSET is not counted. This
37223 allows a client to send one RSET between messages (this is not necessary,
37224 but some clients do it). Exim also allows one uncounted occurrence of HELO
37225 or EHLO, and one occurrence of STARTTLS between messages. After
37226 starting up a TLS session, another EHLO is expected, and so it too is not
37227 counted.
37228
37229 The first occurrence of AUTH in a connection, or immediately following
37230 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
37231 RCPT, DATA, and QUIT are counted.
37232
37233 You can control which hosts are subject to the limit set by
37234 &%smtp_accept_max_nonmail%& by setting
37235 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
37236 the limit apply to all hosts. This option means that you can exclude any
37237 specific badly-behaved hosts that you have to live with.
37238
37239
37240
37241
37242 .subsection "The VRFY and EXPN commands" SECID237
37243 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
37244 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
37245 appropriate) in order to decide whether the command should be accepted or not.
37246
37247 .cindex "VRFY" "processing"
37248 When no ACL is defined for VRFY, or if it rejects without
37249 setting an explicit response code, the command is accepted
37250 (with a 252 SMTP response code)
37251 in order to support awkward clients that do a VRFY before every RCPT.
37252 When VRFY is accepted, it runs exactly the same code as when Exim is
37253 called with the &%-bv%& option, and returns 250/451/550
37254 SMTP response codes.
37255
37256 .cindex "EXPN" "processing"
37257 If no ACL for EXPN is defined, the command is rejected.
37258 When EXPN is accepted, a single-level expansion of the address is done.
37259 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
37260 than a verification (the &%-bv%& option). If an unqualified local part is given
37261 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
37262 of VRFY and EXPN commands are logged on the main and reject logs, and
37263 VRFY verification failures are logged in the main log for consistency with
37264 RCPT failures.
37265
37266
37267
37268 .subsection "The ETRN command" SECTETRN
37269 .cindex "ETRN" "processing"
37270 .cindex "ESMTP extensions" ETRN
37271 RFC 1985 describes an ESMTP command called ETRN that is designed to
37272 overcome the security problems of the TURN command (which has fallen into
37273 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
37274 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
37275 should be accepted or not. If no ACL is defined, the command is rejected.
37276
37277 The ETRN command is concerned with &"releasing"& messages that are awaiting
37278 delivery to certain hosts. As Exim does not organize its message queue by host,
37279 the only form of ETRN that is supported by default is the one where the
37280 text starts with the &"#"& prefix, in which case the remainder of the text is
37281 specific to the SMTP server. A valid ETRN command causes a run of Exim with
37282 the &%-R%& option to happen, with the remainder of the ETRN text as its
37283 argument. For example,
37284 .code
37285 ETRN #brigadoon
37286 .endd
37287 runs the command
37288 .code
37289 exim -R brigadoon
37290 .endd
37291 which causes a delivery attempt on all messages with undelivered addresses
37292 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
37293 default), Exim prevents the simultaneous execution of more than one queue run
37294 for the same argument string as a result of an ETRN command. This stops
37295 a misbehaving client from starting more than one queue runner at once.
37296
37297 .cindex "hints database" "ETRN serialization"
37298 Exim implements the serialization by means of a hints database in which a
37299 record is written whenever a process is started by ETRN, and deleted when
37300 the process completes. However, Exim does not keep the SMTP session waiting for
37301 the ETRN process to complete. Once ETRN is accepted, the client is sent
37302 a &"success"& return code. Obviously there is scope for hints records to get
37303 left lying around if there is a system or program crash. To guard against this,
37304 Exim ignores any records that are more than six hours old.
37305
37306 .oindex "&%smtp_etrn_command%&"
37307 For more control over what ETRN does, the &%smtp_etrn_command%& option can
37308 used. This specifies a command that is run whenever ETRN is received,
37309 whatever the form of its argument. For
37310 example:
37311 .code
37312 smtp_etrn_command = /etc/etrn_command $domain \
37313                     $sender_host_address
37314 .endd
37315 .vindex "&$domain$&"
37316 The string is split up into arguments which are independently expanded. The
37317 expansion variable &$domain$& is set to the argument of the ETRN command,
37318 and no syntax checking is done on the contents of this argument. Exim does not
37319 wait for the command to complete, so its status code is not checked. Exim runs
37320 under its own uid and gid when receiving incoming SMTP, so it is not possible
37321 for it to change them before running the command.
37322
37323
37324
37325 .section "Incoming local SMTP" "SECID238"
37326 .cindex "SMTP" "local incoming"
37327 Some user agents use SMTP to pass messages to their local MTA using the
37328 standard input and output, as opposed to passing the envelope on the command
37329 line and writing the message to the standard input. This is supported by the
37330 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37331 messages over TCP/IP (including the use of ACLs), except that the envelope
37332 sender given in a MAIL command is ignored unless the caller is trusted. In
37333 an ACL you can detect this form of SMTP input by testing for an empty host
37334 identification. It is common to have this as the first line in the ACL that
37335 runs for RCPT commands:
37336 .code
37337 accept hosts = :
37338 .endd
37339 This accepts SMTP messages from local processes without doing any other tests.
37340
37341
37342
37343 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37344 .cindex "SMTP" "batched outgoing"
37345 .cindex "batched SMTP output"
37346 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37347 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37348 be output in BSMTP format. No SMTP responses are possible for this form of
37349 delivery. All it is doing is using SMTP commands as a way of transmitting the
37350 envelope along with the message.
37351
37352 The message is written to the file or pipe preceded by the SMTP commands
37353 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37354 the message that start with a dot have an extra dot added. The SMTP command
37355 HELO is not normally used. If it is required, the &%message_prefix%& option
37356 can be used to specify it.
37357
37358 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37359 one recipient address at a time by default. However, you can arrange for them
37360 to handle several addresses at once by setting the &%batch_max%& option. When
37361 this is done for BSMTP, messages may contain multiple RCPT commands. See
37362 chapter &<<CHAPbatching>>& for more details.
37363
37364 .vindex "&$host$&"
37365 When one or more addresses are routed to a BSMTP transport by a router that
37366 sets up a host list, the name of the first host on the list is available to the
37367 transport in the variable &$host$&. Here is an example of such a transport and
37368 router:
37369 .code
37370 begin routers
37371 route_append:
37372   driver = manualroute
37373   transport = smtp_appendfile
37374   route_list = domain.example  batch.host.example
37375
37376 begin transports
37377 smtp_appendfile:
37378   driver = appendfile
37379   directory = /var/bsmtp/$host
37380   batch_max = 1000
37381   use_bsmtp
37382   user = exim
37383 .endd
37384 This causes messages addressed to &'domain.example'& to be written in BSMTP
37385 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37386 message (unless there are more than 1000 recipients).
37387
37388
37389
37390 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37391 .cindex "SMTP" "batched incoming"
37392 .cindex "batched SMTP input"
37393 The &%-bS%& command line option causes Exim to accept one or more messages by
37394 reading SMTP on the standard input, but to generate no responses. If the caller
37395 is trusted, the senders in the MAIL commands are believed; otherwise the
37396 sender is always the caller of Exim. Unqualified senders and receivers are not
37397 rejected (there seems little point) but instead just get qualified. HELO
37398 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37399 as NOOP; QUIT quits.
37400
37401 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37402 ACL is run in the same way as for non-SMTP local input.
37403
37404 If an error is detected while reading a message, including a missing &"."& at
37405 the end, Exim gives up immediately. It writes details of the error to the
37406 standard output in a stylized way that the calling program should be able to
37407 make some use of automatically, for example:
37408 .code
37409 554 Unexpected end of file
37410 Transaction started in line 10
37411 Error detected in line 14
37412 .endd
37413 It writes a more verbose version, for human consumption, to the standard error
37414 file, for example:
37415 .code
37416 An error was detected while processing a file of BSMTP input.
37417 The error message was:
37418
37419 501 '>' missing at end of address
37420
37421 The SMTP transaction started in line 10.
37422 The error was detected in line 12.
37423 The SMTP command at fault was:
37424
37425 rcpt to:<malformed@in.com.plete
37426
37427 1 previous message was successfully processed.
37428 The rest of the batch was abandoned.
37429 .endd
37430 The return code from Exim is zero only if there were no errors. It is 1 if some
37431 messages were accepted before an error was detected, and 2 if no messages were
37432 accepted.
37433 .ecindex IIDsmtpproc1
37434 .ecindex IIDsmtpproc2
37435
37436
37437
37438 . ////////////////////////////////////////////////////////////////////////////
37439 . ////////////////////////////////////////////////////////////////////////////
37440
37441 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37442          "Customizing messages"
37443 When a message fails to be delivered, or remains in the queue for more than a
37444 configured amount of time, Exim sends a message to the original sender, or
37445 to an alternative configured address. The text of these messages is built into
37446 the code of Exim, but it is possible to change it, either by adding a single
37447 string, or by replacing each of the paragraphs by text supplied in a file.
37448
37449 The &'From:'& and &'To:'& header lines are automatically generated; you can
37450 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37451 option. Exim also adds the line
37452 .code
37453 Auto-Submitted: auto-generated
37454 .endd
37455 to all warning and bounce messages,
37456
37457
37458 .section "Customizing bounce messages" "SECID239"
37459 .cindex "customizing" "bounce message"
37460 .cindex "bounce message" "customizing"
37461 If &%bounce_message_text%& is set, its contents are included in the default
37462 message immediately after &"This message was created automatically by mail
37463 delivery software."& The string is not expanded. It is not used if
37464 &%bounce_message_file%& is set.
37465
37466 When &%bounce_message_file%& is set, it must point to a template file for
37467 constructing error messages. The file consists of a series of text items,
37468 separated by lines consisting of exactly four asterisks. If the file cannot be
37469 opened, default text is used and a message is written to the main and panic
37470 logs. If any text item in the file is empty, default text is used for that
37471 item.
37472
37473 .vindex "&$bounce_recipient$&"
37474 .vindex "&$bounce_return_size_limit$&"
37475 Each item of text that is read from the file is expanded, and there are two
37476 expansion variables which can be of use here: &$bounce_recipient$& is set to
37477 the recipient of an error message while it is being created, and
37478 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37479 option, rounded to a whole number.
37480
37481 The items must appear in the file in the following order:
37482
37483 .ilist
37484 The first item is included in the headers, and should include at least a
37485 &'Subject:'& header. Exim does not check the syntax of these headers.
37486 .next
37487 The second item forms the start of the error message. After it, Exim lists the
37488 failing addresses with their error messages.
37489 .next
37490 The third item is used to introduce any text from pipe transports that is to be
37491 returned to the sender. It is omitted if there is no such text.
37492 .next
37493 The fourth, fifth and sixth items will be ignored and may be empty.
37494 The fields exist for back-compatibility
37495 .endlist
37496
37497 The default state (&%bounce_message_file%& unset) is equivalent to the
37498 following file, in which the sixth item is empty. The &'Subject:'& and some
37499 other lines have been split in order to fit them on the page:
37500 .code
37501 Subject: Mail delivery failed
37502   ${if eq{$sender_address}{$bounce_recipient}
37503   {: returning message to sender}}
37504 ****
37505 This message was created automatically by mail delivery software.
37506
37507 A message ${if eq{$sender_address}{$bounce_recipient}
37508   {that you sent }{sent by
37509
37510 <$sender_address>
37511
37512 }}could not be delivered to all of its recipients.
37513 This is a permanent error. The following address(es) failed:
37514 ****
37515 The following text was generated during the delivery attempt(s):
37516 ****
37517 ------ This is a copy of the message, including all the headers.
37518   ------
37519 ****
37520 ------ The body of the message is $message_size characters long;
37521   only the first
37522 ------ $bounce_return_size_limit or so are included here.
37523 ****
37524 .endd
37525 .section "Customizing warning messages" "SECTcustwarn"
37526 .cindex "customizing" "warning message"
37527 .cindex "warning of delay" "customizing the message"
37528 The option &%warn_message_file%& can be pointed at a template file for use when
37529 warnings about message delays are created. In this case there are only three
37530 text sections:
37531
37532 .ilist
37533 The first item is included in the headers, and should include at least a
37534 &'Subject:'& header. Exim does not check the syntax of these headers.
37535 .next
37536 The second item forms the start of the warning message. After it, Exim lists
37537 the delayed addresses.
37538 .next
37539 The third item then ends the message.
37540 .endlist
37541
37542 The default state is equivalent to the following file, except that some lines
37543 have been split here, in order to fit them on the page:
37544 .code
37545 Subject: Warning: message $message_exim_id delayed
37546   $warn_message_delay
37547 ****
37548 This message was created automatically by mail delivery software.
37549
37550 A message ${if eq{$sender_address}{$warn_message_recipients}
37551 {that you sent }{sent by
37552
37553 <$sender_address>
37554
37555 }}has not been delivered to all of its recipients after
37556 more than $warn_message_delay in the queue on $primary_hostname.
37557
37558 The message identifier is:     $message_exim_id
37559 The subject of the message is: $h_subject
37560 The date of the message is:    $h_date
37561
37562 The following address(es) have not yet been delivered:
37563 ****
37564 No action is required on your part. Delivery attempts will
37565 continue for some time, and this warning may be repeated at
37566 intervals if the message remains undelivered. Eventually the
37567 mail delivery software will give up, and when that happens,
37568 the message will be returned to you.
37569 .endd
37570 .vindex "&$warn_message_delay$&"
37571 .vindex "&$warn_message_recipients$&"
37572 However, in the default state the subject and date lines are omitted if no
37573 appropriate headers exist. During the expansion of this file,
37574 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37575 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37576 of recipients for the warning message. There may be more than one if there are
37577 multiple addresses with different &%errors_to%& settings on the routers that
37578 handled them.
37579
37580
37581
37582
37583 . ////////////////////////////////////////////////////////////////////////////
37584 . ////////////////////////////////////////////////////////////////////////////
37585
37586 .chapter "Some common configuration settings" "CHAPcomconreq"
37587 This chapter discusses some configuration settings that seem to be fairly
37588 common. More examples and discussion can be found in the Exim book.
37589
37590
37591
37592 .section "Sending mail to a smart host" "SECID240"
37593 .cindex "smart host" "example router"
37594 If you want to send all mail for non-local domains to a &"smart host"&, you
37595 should replace the default &(dnslookup)& router with a router which does the
37596 routing explicitly:
37597 .code
37598 send_to_smart_host:
37599   driver = manualroute
37600   route_list = !+local_domains smart.host.name
37601   transport = remote_smtp
37602 .endd
37603 You can use the smart host's IP address instead of the name if you wish.
37604 If you are using Exim only to submit messages to a smart host, and not for
37605 receiving incoming messages, you can arrange for it to do the submission
37606 synchronously by setting the &%mua_wrapper%& option (see chapter
37607 &<<CHAPnonqueueing>>&).
37608
37609
37610
37611
37612 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37613 .cindex "mailing lists"
37614 Exim can be used to run simple mailing lists, but for large and/or complicated
37615 requirements, the use of additional specialized mailing list software such as
37616 Majordomo or Mailman is recommended.
37617
37618 The &(redirect)& router can be used to handle mailing lists where each list
37619 is maintained in a separate file, which can therefore be managed by an
37620 independent manager. The &%domains%& router option can be used to run these
37621 lists in a separate domain from normal mail. For example:
37622 .code
37623 lists:
37624   driver = redirect
37625   domains = lists.example
37626   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37627   forbid_pipe
37628   forbid_file
37629   errors_to = ${quote_local_part:$local_part-request}@lists.example
37630   no_more
37631 .endd
37632 This router is skipped for domains other than &'lists.example'&. For addresses
37633 in that domain, it looks for a file that matches the local part. If there is no
37634 such file, the router declines, but because &%no_more%& is set, no subsequent
37635 routers are tried, and so the whole delivery fails.
37636
37637 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37638 expanded into a filename or a pipe delivery, which is usually inappropriate in
37639 a mailing list.
37640
37641 .oindex "&%errors_to%&"
37642 The &%errors_to%& option specifies that any delivery errors caused by addresses
37643 taken from a mailing list are to be sent to the given address rather than the
37644 original sender of the message. However, before acting on this, Exim verifies
37645 the error address, and ignores it if verification fails.
37646
37647 For example, using the configuration above, mail sent to
37648 &'dicts@lists.example'& is passed on to those addresses contained in
37649 &_/usr/lists/dicts_&, with error reports directed to
37650 &'dicts-request@lists.example'&, provided that this address can be verified.
37651 There could be a file called &_/usr/lists/dicts-request_& containing
37652 the address(es) of this particular list's manager(s), but other approaches,
37653 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37654 or &%local_part_suffix%& options) to handle addresses of the form
37655 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37656
37657
37658
37659 .section "Syntax errors in mailing lists" "SECID241"
37660 .cindex "mailing lists" "syntax errors in"
37661 If an entry in redirection data contains a syntax error, Exim normally defers
37662 delivery of the original address. That means that a syntax error in a mailing
37663 list holds up all deliveries to the list. This may not be appropriate when a
37664 list is being maintained automatically from data supplied by users, and the
37665 addresses are not rigorously checked.
37666
37667 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37668 entries that fail to parse, noting the incident in the log. If in addition
37669 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37670 whenever a broken address is skipped. It is usually appropriate to set
37671 &%syntax_errors_to%& to the same address as &%errors_to%&.
37672
37673
37674
37675 .section "Re-expansion of mailing lists" "SECID242"
37676 .cindex "mailing lists" "re-expansion of"
37677 Exim remembers every individual address to which a message has been delivered,
37678 in order to avoid duplication, but it normally stores only the original
37679 recipient addresses with a message. If all the deliveries to a mailing list
37680 cannot be done at the first attempt, the mailing list is re-expanded when the
37681 delivery is next tried. This means that alterations to the list are taken into
37682 account at each delivery attempt, so addresses that have been added to
37683 the list since the message arrived will therefore receive a copy of the
37684 message, even though it pre-dates their subscription.
37685
37686 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37687 on the &(redirect)& router. If this is done, any addresses generated by the
37688 router that fail to deliver at the first attempt are added to the message as
37689 &"top level"& addresses, and the parent address that generated them is marked
37690 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37691 subsequent delivery attempts. The disadvantage of this is that if any of the
37692 failing addresses are incorrect, correcting them in the file has no effect on
37693 pre-existing messages.
37694
37695 The original top-level address is remembered with each of the generated
37696 addresses, and is output in any log messages. However, any intermediate parent
37697 addresses are not recorded. This makes a difference to the log only if the
37698 &%all_parents%& selector is set, but for mailing lists there is normally only
37699 one level of expansion anyway.
37700
37701
37702
37703 .section "Closed mailing lists" "SECID243"
37704 .cindex "mailing lists" "closed"
37705 The examples so far have assumed open mailing lists, to which anybody may
37706 send mail. It is also possible to set up closed lists, where mail is accepted
37707 from specified senders only. This is done by making use of the generic
37708 &%senders%& option to restrict the router that handles the list.
37709
37710 The following example uses the same file as a list of recipients and as a list
37711 of permitted senders. It requires three routers:
37712 .code
37713 lists_request:
37714   driver = redirect
37715   domains = lists.example
37716   local_part_suffix = -request
37717   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37718   file = /usr/lists/${local_part_data}-request
37719   no_more
37720
37721 lists_post:
37722   driver = redirect
37723   domains = lists.example
37724   local_parts = ${lookup {$local_part} dsearch,filter=file,ret=full {/usr/lists}}
37725   senders = ${if exists {$local_part_data} {lsearch;$local_part_data}{*}}
37726   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37727   forbid_pipe
37728   forbid_file
37729   errors_to = ${quote_local_part:$local_part-request}@lists.example
37730   no_more
37731
37732 lists_closed:
37733   driver = redirect
37734   domains = lists.example
37735   allow_fail
37736   data = :fail: $local_part@lists.example is a closed mailing list
37737 .endd
37738 All three routers have the same &%domains%& setting, so for any other domains,
37739 they are all skipped. The first router runs only if the local part ends in
37740 &%-request%&. It handles messages to the list manager(s) by means of an open
37741 mailing list.
37742
37743 The second router runs only if the &%senders%& precondition is satisfied. It
37744 checks for the existence of a list that corresponds to the local part, and then
37745 checks that the sender is on the list by means of a linear search. It is
37746 necessary to check for the existence of the file before trying to search it,
37747 because otherwise Exim thinks there is a configuration error. If the file does
37748 not exist, the expansion of &%senders%& is *, which matches all senders. This
37749 means that the router runs, but because there is no list, declines, and
37750 &%no_more%& ensures that no further routers are run. The address fails with an
37751 &"unrouteable address"& error.
37752
37753 The third router runs only if the second router is skipped, which happens when
37754 a mailing list exists, but the sender is not on it. This router forcibly fails
37755 the address, giving a suitable error message.
37756
37757
37758
37759
37760 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37761 .cindex "VERP"
37762 .cindex "Variable Envelope Return Paths"
37763 .cindex "envelope from"
37764 .cindex "envelope sender"
37765 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37766 are a way of helping mailing list administrators discover which subscription
37767 address is the cause of a particular delivery failure. The idea is to encode
37768 the original recipient address in the outgoing envelope sender address, so that
37769 if the message is forwarded by another host and then subsequently bounces, the
37770 original recipient can be extracted from the recipient address of the bounce.
37771
37772 .oindex &%errors_to%&
37773 .oindex &%return_path%&
37774 Envelope sender addresses can be modified by Exim using two different
37775 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37776 list examples), or the &%return_path%& option on a transport. The second of
37777 these is effective only if the message is successfully delivered to another
37778 host; it is not used for errors detected on the local host (see the description
37779 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37780 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37781 .code
37782 verp_smtp:
37783   driver = smtp
37784   max_rcpt = 1
37785   return_path = \
37786     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37787       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37788 .endd
37789 This has the effect of rewriting the return path (envelope sender) on outgoing
37790 SMTP messages, if the local part of the original return path ends in
37791 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37792 local part and domain of the recipient into the return path. Suppose, for
37793 example, that a message whose return path has been set to
37794 &'somelist-request@your.dom.example'& is sent to
37795 &'subscriber@other.dom.example'&. In the transport, the return path is
37796 rewritten as
37797 .code
37798 somelist-request+subscriber=other.dom.example@your.dom.example
37799 .endd
37800 .vindex "&$local_part$&"
37801 For this to work, you must tell Exim to send multiple copies of messages that
37802 have more than one recipient, so that each copy has just one recipient. This is
37803 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
37804 might be sent to several different recipients in the same domain, in which case
37805 &$local_part$& is not available in the transport, because it is not unique.
37806
37807 Unless your host is doing nothing but mailing list deliveries, you should
37808 probably use a separate transport for the VERP deliveries, so as not to use
37809 extra resources in making one-per-recipient copies for other deliveries. This
37810 can easily be done by expanding the &%transport%& option in the router:
37811 .code
37812 dnslookup:
37813   driver = dnslookup
37814   domains = ! +local_domains
37815   transport = \
37816     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37817       {verp_smtp}{remote_smtp}}
37818   no_more
37819 .endd
37820 If you want to change the return path using &%errors_to%& in a router instead
37821 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
37822 routers that handle mailing list addresses. This will ensure that all delivery
37823 errors, including those detected on the local host, are sent to the VERP
37824 address.
37825
37826 On a host that does no local deliveries and has no manual routing, only the
37827 &(dnslookup)& router needs to be changed. A special transport is not needed for
37828 SMTP deliveries. Every mailing list recipient has its own return path value,
37829 and so Exim must hand them to the transport one at a time. Here is an example
37830 of a &(dnslookup)& router that implements VERP:
37831 .code
37832 verp_dnslookup:
37833   driver = dnslookup
37834   domains = ! +local_domains
37835   transport = remote_smtp
37836   errors_to = \
37837     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
37838      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37839   no_more
37840 .endd
37841 Before you start sending out messages with VERPed return paths, you must also
37842 configure Exim to accept the bounce messages that come back to those paths.
37843 Typically this is done by setting a &%local_part_suffix%& option for a
37844 router, and using this to route the messages to wherever you want to handle
37845 them.
37846
37847 The overhead incurred in using VERP depends very much on the size of the
37848 message, the number of recipient addresses that resolve to the same remote
37849 host, and the speed of the connection over which the message is being sent. If
37850 a lot of addresses resolve to the same host and the connection is slow, sending
37851 a separate copy of the message for each address may take substantially longer
37852 than sending a single copy with many recipients (for which VERP cannot be
37853 used).
37854
37855
37856
37857
37858
37859
37860 .section "Virtual domains" "SECTvirtualdomains"
37861 .cindex "virtual domains"
37862 .cindex "domain" "virtual"
37863 The phrase &'virtual domain'& is unfortunately used with two rather different
37864 meanings:
37865
37866 .ilist
37867 A domain for which there are no real mailboxes; all valid local parts are
37868 aliases for other email addresses. Common examples are organizational
37869 top-level domains and &"vanity"& domains.
37870 .next
37871 One of a number of independent domains that are all handled by the same host,
37872 with mailboxes on that host, but where the mailbox owners do not necessarily
37873 have login accounts on that host.
37874 .endlist
37875
37876 The first usage is probably more common, and does seem more &"virtual"& than
37877 the second. This kind of domain can be handled in Exim with a straightforward
37878 aliasing router. One approach is to create a separate alias file for each
37879 virtual domain. Exim can test for the existence of the alias file to determine
37880 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
37881 to a router of this form:
37882 .code
37883 virtual:
37884   driver = redirect
37885   domains = dsearch;/etc/mail/virtual
37886   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
37887   no_more
37888 .endd
37889 The &%domains%& option specifies that the router is to be skipped, unless there
37890 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
37891 domain that is being processed.
37892 The &(dsearch)& lookup used results in an untainted version of &$domain$&
37893 being placed into the &$domain_data$& variable.
37894
37895 When the router runs, it looks up the local
37896 part in the file to find a new address (or list of addresses). The &%no_more%&
37897 setting ensures that if the lookup fails (leading to &%data%& being an empty
37898 string), Exim gives up on the address without trying any subsequent routers.
37899
37900 This one router can handle all the virtual domains because the alias filenames
37901 follow a fixed pattern. Permissions can be arranged so that appropriate people
37902 can edit the different alias files. A successful aliasing operation results in
37903 a new envelope recipient address, which is then routed from scratch.
37904
37905 The other kind of &"virtual"& domain can also be handled in a straightforward
37906 way. One approach is to create a file for each domain containing a list of
37907 valid local parts, and use it in a router like this:
37908 .code
37909 my_domains:
37910   driver = accept
37911   domains = dsearch;/etc/mail/domains
37912   local_parts = lsearch;/etc/mail/domains/$domain
37913   transport = my_mailboxes
37914 .endd
37915 The address is accepted if there is a file for the domain, and the local part
37916 can be found in the file. The &%domains%& option is used to check for the
37917 file's existence because &%domains%& is tested before the &%local_parts%&
37918 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
37919 because that option is tested after &%local_parts%&. The transport is as
37920 follows:
37921 .code
37922 my_mailboxes:
37923   driver = appendfile
37924   file = /var/mail/$domain_data/$local_part_data
37925   user = mail
37926 .endd
37927 This uses a directory of mailboxes for each domain. The &%user%& setting is
37928 required, to specify which uid is to be used for writing to the mailboxes.
37929
37930 The configuration shown here is just one example of how you might support this
37931 requirement. There are many other ways this kind of configuration can be set
37932 up, for example, by using a database instead of separate files to hold all the
37933 information about the domains.
37934
37935
37936
37937 .section "Multiple user mailboxes" "SECTmulbox"
37938 .cindex "multiple mailboxes"
37939 .cindex "mailbox" "multiple"
37940 .cindex "local part" "prefix"
37941 .cindex "local part" "suffix"
37942 Heavy email users often want to operate with multiple mailboxes, into which
37943 incoming mail is automatically sorted. A popular way of handling this is to
37944 allow users to use multiple sender addresses, so that replies can easily be
37945 identified. Users are permitted to add prefixes or suffixes to their local
37946 parts for this purpose. The wildcard facility of the generic router options
37947 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
37948 example, consider this router:
37949 .code
37950 userforward:
37951   driver = redirect
37952   check_local_user
37953   file = $home/.forward
37954   local_part_suffix = -*
37955   local_part_suffix_optional
37956   allow_filter
37957 .endd
37958 .vindex "&$local_part_suffix$&"
37959 It runs a user's &_.forward_& file for all local parts of the form
37960 &'username-*'&. Within the filter file the user can distinguish different
37961 cases by testing the variable &$local_part_suffix$&. For example:
37962 .code
37963 if $local_part_suffix contains -special then
37964 save /home/$local_part_data/Mail/special
37965 endif
37966 .endd
37967 If the filter file does not exist, or does not deal with such addresses, they
37968 fall through to subsequent routers, and, assuming no subsequent use of the
37969 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
37970 control over which suffixes are valid.
37971
37972 Alternatively, a suffix can be used to trigger the use of a different
37973 &_.forward_& file &-- which is the way a similar facility is implemented in
37974 another MTA:
37975 .code
37976 userforward:
37977   driver = redirect
37978   check_local_user
37979   local_part_suffix = -*
37980   local_part_suffix_optional
37981   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
37982   allow_filter
37983 .endd
37984 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
37985 example, &_.forward-special_& is used. Once again, if the appropriate file
37986 does not exist, or does not deal with the address, it is passed on to
37987 subsequent routers, which could, if required, look for an unqualified
37988 &_.forward_& file to use as a default.
37989
37990
37991
37992 .section "Simplified vacation processing" "SECID244"
37993 .cindex "vacation processing"
37994 The traditional way of running the &'vacation'& program is for a user to set up
37995 a pipe command in a &_.forward_& file
37996 (see section &<<SECTspecitredli>>& for syntax details).
37997 This is prone to error by inexperienced users. There are two features of Exim
37998 that can be used to make this process simpler for users:
37999
38000 .ilist
38001 A local part prefix such as &"vacation-"& can be specified on a router which
38002 can cause the message to be delivered directly to the &'vacation'& program, or
38003 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
38004 &_.forward_& file are then much simpler. For example:
38005 .code
38006 spqr, vacation-spqr
38007 .endd
38008 .next
38009 The &%require_files%& generic router option can be used to trigger a
38010 vacation delivery by checking for the existence of a certain file in the
38011 user's home directory. The &%unseen%& generic option should also be used, to
38012 ensure that the original delivery also proceeds. In this case, all the user has
38013 to do is to create a file called, say, &_.vacation_&, containing a vacation
38014 message.
38015 .endlist
38016
38017 Another advantage of both these methods is that they both work even when the
38018 use of arbitrary pipes by users is locked out.
38019
38020
38021
38022 .section "Taking copies of mail" "SECID245"
38023 .cindex "message" "copying every"
38024 Some installations have policies that require archive copies of all messages to
38025 be made. A single copy of each message can easily be taken by an appropriate
38026 command in a system filter, which could, for example, use a different file for
38027 each day's messages.
38028
38029 There is also a shadow transport mechanism that can be used to take copies of
38030 messages that are successfully delivered by local transports, one copy per
38031 delivery. This could be used, &'inter alia'&, to implement automatic
38032 notification of delivery by sites that insist on doing such things.
38033
38034
38035
38036 .section "Intermittently connected hosts" "SECID246"
38037 .cindex "intermittently connected hosts"
38038 It has become quite common (because it is cheaper) for hosts to connect to the
38039 Internet periodically rather than remain connected all the time. The normal
38040 arrangement is that mail for such hosts accumulates on a system that is
38041 permanently connected.
38042
38043 Exim was designed for use on permanently connected hosts, and so it is not
38044 particularly well-suited to use in an intermittently connected environment.
38045 Nevertheless there are some features that can be used.
38046
38047
38048 .section "Exim on the upstream server host" "SECID247"
38049 It is tempting to arrange for incoming mail for the intermittently connected
38050 host to remain in Exim's queue until the client connects. However, this
38051 approach does not scale very well. Two different kinds of waiting message are
38052 being mixed up in the same queue &-- those that cannot be delivered because of
38053 some temporary problem, and those that are waiting for their destination host
38054 to connect. This makes it hard to manage the queue, as well as wasting
38055 resources, because each queue runner scans the entire queue.
38056
38057 A better approach is to separate off those messages that are waiting for an
38058 intermittently connected host. This can be done by delivering these messages
38059 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
38060 format, from where they are transmitted by other software when their
38061 destination connects. This makes it easy to collect all the mail for one host
38062 in a single directory, and to apply local timeout rules on a per-message basis
38063 if required.
38064
38065 On a very small scale, leaving the mail on Exim's queue can be made to work. If
38066 you are doing this, you should configure Exim with a long retry period for the
38067 intermittent host. For example:
38068 .code
38069 cheshire.wonderland.fict.example    *   F,5d,24h
38070 .endd
38071 This stops a lot of failed delivery attempts from occurring, but Exim remembers
38072 which messages it has queued up for that host. Once the intermittent host comes
38073 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
38074 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
38075 causes all the queued up messages to be delivered, often down a single SMTP
38076 connection. While the host remains connected, any new messages get delivered
38077 immediately.
38078
38079 If the connecting hosts do not have fixed IP addresses, that is, if a host is
38080 issued with a different IP address each time it connects, Exim's retry
38081 mechanisms on the holding host get confused, because the IP address is normally
38082 used as part of the key string for holding retry information. This can be
38083 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
38084 Since this has disadvantages for permanently connected hosts, it is best to
38085 arrange a separate transport for the intermittently connected ones.
38086
38087
38088
38089 .section "Exim on the intermittently connected client host" "SECID248"
38090 The value of &%smtp_accept_queue_per_connection%& should probably be
38091 increased, or even set to zero (that is, disabled) on the intermittently
38092 connected host, so that all incoming messages down a single connection get
38093 delivered immediately.
38094
38095 .cindex "SMTP" "passed connection"
38096 .cindex "SMTP" "multiple deliveries"
38097 .cindex "multiple SMTP deliveries"
38098 .cindex "first pass routing"
38099 Mail waiting to be sent from an intermittently connected host will probably
38100 not have been routed, because without a connection DNS lookups are not
38101 possible. This means that if a normal queue run is done at connection time,
38102 each message is likely to be sent in a separate SMTP session. This can be
38103 avoided by starting the queue run with a command line option beginning with
38104 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
38105 first pass, routing is done but no deliveries take place. The second pass is a
38106 normal queue run; since all the messages have been previously routed, those
38107 destined for the same host are likely to get sent as multiple deliveries in a
38108 single SMTP connection.
38109
38110
38111
38112 . ////////////////////////////////////////////////////////////////////////////
38113 . ////////////////////////////////////////////////////////////////////////////
38114
38115 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
38116          "Exim as a non-queueing client"
38117 .cindex "client, non-queueing"
38118 .cindex "smart host" "suppressing queueing"
38119 On a personal computer, it is a common requirement for all
38120 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
38121 configured to operate that way, for all the popular operating systems.
38122 However, there are some MUAs for Unix-like systems that cannot be so
38123 configured: they submit messages using the command line interface of
38124 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
38125 messages this way.
38126
38127 If the personal computer runs continuously, there is no problem, because it can
38128 run a conventional MTA that handles delivery to the smart host, and deal with
38129 any delays via its queueing mechanism. However, if the computer does not run
38130 continuously or runs different operating systems at different times, queueing
38131 email is not desirable.
38132
38133 There is therefore a requirement for something that can provide the
38134 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
38135 any queueing or retrying facilities. Furthermore, the delivery to the smart
38136 host should be synchronous, so that if it fails, the sending MUA is immediately
38137 informed. In other words, we want something that extends an MUA that submits
38138 to a local MTA via the command line so that it behaves like one that submits
38139 to a remote smart host using TCP/SMTP.
38140
38141 There are a number of applications (for example, there is one called &'ssmtp'&)
38142 that do this job. However, people have found them to be lacking in various
38143 ways. For instance, you might want to allow aliasing and forwarding to be done
38144 before sending a message to the smart host.
38145
38146 Exim already had the necessary infrastructure for doing this job. Just a few
38147 tweaks were needed to make it behave as required, though it is somewhat of an
38148 overkill to use a fully-featured MTA for this purpose.
38149
38150 .oindex "&%mua_wrapper%&"
38151 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
38152 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
38153 assumes that it is being used to &"wrap"& a command-line MUA in the manner
38154 just described. As well as setting &%mua_wrapper%&, you also need to provide a
38155 compatible router and transport configuration. Typically there will be just one
38156 router and one transport, sending everything to a smart host.
38157
38158 When run in MUA wrapping mode, the behaviour of Exim changes in the
38159 following ways:
38160
38161 .ilist
38162 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
38163 In other words, the only way to submit messages is via the command line.
38164 .next
38165 Each message is synchronously delivered as soon as it is received (&%-odi%& is
38166 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
38167 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
38168 does not finish until the delivery attempt is complete. If the delivery is
38169 successful, a zero return code is given.
38170 .next
38171 Address redirection is permitted, but the final routing for all addresses must
38172 be to the same remote transport, and to the same list of hosts. Furthermore,
38173 the return address (envelope sender) must be the same for all recipients, as
38174 must any added or deleted header lines. In other words, it must be possible to
38175 deliver the message in a single SMTP transaction, however many recipients there
38176 are.
38177 .next
38178 If these conditions are not met, or if routing any address results in a
38179 failure or defer status, or if Exim is unable to deliver all the recipients
38180 successfully to one of the smart hosts, delivery of the entire message fails.
38181 .next
38182 Because no queueing is allowed, all failures are treated as permanent; there
38183 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
38184 smart host. Furthermore, because only a single yes/no response can be given to
38185 the caller, it is not possible to deliver to some recipients and not others. If
38186 there is an error (temporary or permanent) for any recipient, all are failed.
38187 .next
38188 If more than one smart host is listed, Exim will try another host after a
38189 connection failure or a timeout, in the normal way. However, if this kind of
38190 failure happens for all the hosts, the delivery fails.
38191 .next
38192 When delivery fails, an error message is written to the standard error stream
38193 (as well as to Exim's log), and Exim exits to the caller with a return code
38194 value 1. The message is expunged from Exim's spool files. No bounce messages
38195 are ever generated.
38196 .next
38197 No retry data is maintained, and any retry rules are ignored.
38198 .next
38199 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
38200 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
38201 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
38202 .endlist
38203
38204 The overall effect is that Exim makes a single synchronous attempt to deliver
38205 the message, failing if there is any kind of problem. Because no local
38206 deliveries are done and no daemon can be run, Exim does not need root
38207 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
38208 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
38209 the advantages and disadvantages of running without root privilege.
38210
38211
38212
38213
38214 . ////////////////////////////////////////////////////////////////////////////
38215 . ////////////////////////////////////////////////////////////////////////////
38216
38217 .chapter "Log files" "CHAPlog"
38218 .scindex IIDloggen "log" "general description"
38219 .cindex "log" "types of"
38220 Exim writes three different logs, referred to as the main log, the reject log,
38221 and the panic log:
38222
38223 .ilist
38224 .cindex "main log"
38225 The main log records the arrival of each message and each delivery in a single
38226 line in each case. The format is as compact as possible, in an attempt to keep
38227 down the size of log files. Two-character flag sequences make it easy to pick
38228 out these lines. A number of other events are recorded in the main log. Some of
38229 them are optional, in which case the &%log_selector%& option controls whether
38230 they are included or not. A Perl script called &'eximstats'&, which does simple
38231 analysis of main log files, is provided in the Exim distribution (see section
38232 &<<SECTmailstat>>&).
38233 .next
38234 .cindex "reject log"
38235 The reject log records information from messages that are rejected as a result
38236 of a configuration option (that is, for policy reasons).
38237 The first line of each rejection is a copy of the line that is also written to
38238 the main log. Then, if the message's header has been read at the time the log
38239 is written, its contents are written to this log. Only the original header
38240 lines are available; header lines added by ACLs are not logged. You can use the
38241 reject log to check that your policy controls are working correctly; on a busy
38242 host this may be easier than scanning the main log for rejection messages. You
38243 can suppress the writing of the reject log by setting &%write_rejectlog%&
38244 false.
38245 .next
38246 .cindex "panic log"
38247 .cindex "system log"
38248 When certain serious errors occur, Exim writes entries to its panic log. If the
38249 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
38250 are usually written to the main log as well, but can get lost amid the mass of
38251 other entries. The panic log should be empty under normal circumstances. It is
38252 therefore a good idea to check it (or to have a &'cron'& script check it)
38253 regularly, in order to become aware of any problems. When Exim cannot open its
38254 panic log, it tries as a last resort to write to the system log (syslog). This
38255 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
38256 message itself is written at priority LOG_CRIT.
38257 .endlist
38258
38259 Every log line starts with a timestamp, in the format shown in the following
38260 example. Note that many of the examples shown in this chapter are line-wrapped.
38261 In the log file, this would be all on one line:
38262 .code
38263 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
38264   by QUIT
38265 .endd
38266 By default, the timestamps are in the local timezone. There are two
38267 ways of changing this:
38268
38269 .ilist
38270 You can set the &%timezone%& option to a different time zone; in particular, if
38271 you set
38272 .code
38273 timezone = UTC
38274 .endd
38275 the timestamps will be in UTC (aka GMT).
38276 .next
38277 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
38278 example:
38279 .code
38280 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
38281 .endd
38282 .endlist
38283
38284 .cindex "log" "process ids in"
38285 .cindex "pid (process id)" "in log lines"
38286 Exim does not include its process id in log lines by default, but you can
38287 request that it does so by specifying the &`pid`& log selector (see section
38288 &<<SECTlogselector>>&). When this is set, the process id is output, in square
38289 brackets, immediately after the time and date.
38290
38291
38292
38293
38294 .section "Where the logs are written" "SECTwhelogwri"
38295 .cindex "log" "destination"
38296 .cindex "log" "to file"
38297 .cindex "log" "to syslog"
38298 .cindex "syslog"
38299 The logs may be written to local files, or to syslog, or both. However, it
38300 should be noted that many syslog implementations use UDP as a transport, and
38301 are therefore unreliable in the sense that messages are not guaranteed to
38302 arrive at the loghost, nor is the ordering of messages necessarily maintained.
38303 It has also been reported that on large log files (tens of megabytes) you may
38304 need to tweak syslog to prevent it syncing the file with each write &-- on
38305 Linux this has been seen to make syslog take 90% plus of CPU time.
38306
38307 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
38308 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
38309 configuration. This latter string is expanded, so it can contain, for example,
38310 references to the host name:
38311 .code
38312 log_file_path = /var/log/$primary_hostname/exim_%slog
38313 .endd
38314 It is generally advisable, however, to set the string in &_Local/Makefile_&
38315 rather than at runtime, because then the setting is available right from the
38316 start of Exim's execution. Otherwise, if there's something it wants to log
38317 before it has read the configuration file (for example, an error in the
38318 configuration file) it will not use the path you want, and may not be able to
38319 log at all.
38320
38321 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
38322 list, currently limited to at most two items. This is one option where the
38323 facility for changing a list separator may not be used. The list must always be
38324 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38325 otherwise the item must either be an absolute path, containing &`%s`& at the
38326 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38327 implying the use of a default path.
38328
38329 When Exim encounters an empty item in the list, it searches the list defined by
38330 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38331 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38332 mean &"use the path specified at build time"&. If no such item exists, log
38333 files are written in the &_log_& subdirectory of the spool directory. This is
38334 equivalent to the configuration file setting:
38335 .code
38336 log_file_path = $spool_directory/log/%slog
38337 .endd
38338 If you do not specify anything at build time or runtime,
38339 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38340 that is where the logs are written.
38341
38342 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38343 are in use &-- see section &<<SECTdatlogfil>>& below.
38344
38345 Here are some examples of possible Makefile settings:
38346 .display
38347 &`LOG_FILE_PATH=syslog                    `& syslog only
38348 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38349 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38350 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38351 .endd
38352 If there are more than two paths in the list, the first is used and a panic
38353 error is logged.
38354
38355
38356
38357 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38358 .cindex "log" "cycling local files"
38359 .cindex "cycling logs"
38360 .cindex "&'exicyclog'&"
38361 .cindex "log" "local files; writing to"
38362 Some operating systems provide centralized and standardized methods for cycling
38363 log files. For those that do not, a utility script called &'exicyclog'& is
38364 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38365 main and reject logs each time it is called. The maximum number of old logs to
38366 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38367
38368 An Exim delivery process opens the main log when it first needs to write to it,
38369 and it keeps the file open in case subsequent entries are required &-- for
38370 example, if a number of different deliveries are being done for the same
38371 message. However, remote SMTP deliveries can take a long time, and this means
38372 that the file may be kept open long after it is renamed if &'exicyclog'& or
38373 something similar is being used to rename log files on a regular basis. To
38374 ensure that a switch of log files is noticed as soon as possible, Exim calls
38375 &[stat()]& on the main log's name before reusing an open file, and if the file
38376 does not exist, or its inode has changed, the old file is closed and Exim
38377 tries to open the main log from scratch. Thus, an old log file may remain open
38378 for quite some time, but no Exim processes should write to it once it has been
38379 renamed.
38380
38381
38382
38383 .section "Datestamped log files" "SECTdatlogfil"
38384 .cindex "log" "datestamped files"
38385 Instead of cycling the main and reject log files by renaming them
38386 periodically, some sites like to use files whose names contain a datestamp,
38387 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38388 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38389 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38390 point where the datestamp is required. For example:
38391 .code
38392 log_file_path = /var/spool/exim/log/%slog-%D
38393 log_file_path = /var/log/exim-%s-%D.log
38394 log_file_path = /var/spool/exim/log/%D-%slog
38395 log_file_path = /var/log/exim/%s.%M
38396 .endd
38397 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38398 examples of names generated by the above examples:
38399 .code
38400 /var/spool/exim/log/mainlog-20021225
38401 /var/log/exim-reject-20021225.log
38402 /var/spool/exim/log/20021225-mainlog
38403 /var/log/exim/main.200212
38404 .endd
38405 When this form of log file is specified, Exim automatically switches to new
38406 files at midnight. It does not make any attempt to compress old logs; you
38407 will need to write your own script if you require this. You should not
38408 run &'exicyclog'& with this form of logging.
38409
38410 The location of the panic log is also determined by &%log_file_path%&, but it
38411 is not datestamped, because rotation of the panic log does not make sense.
38412 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38413 the string. In addition, if it immediately follows a slash, a following
38414 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38415 character is removed. Thus, the four examples above would give these panic
38416 log names:
38417 .code
38418 /var/spool/exim/log/paniclog
38419 /var/log/exim-panic.log
38420 /var/spool/exim/log/paniclog
38421 /var/log/exim/panic
38422 .endd
38423
38424
38425 .section "Logging to syslog" "SECID249"
38426 .cindex "log" "syslog; writing to"
38427 The use of syslog does not change what Exim logs or the format of its messages,
38428 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38429 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38430 that, the same strings are written to syslog as to log files. The syslog
38431 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38432 by default, but you can change these by setting the &%syslog_facility%& and
38433 &%syslog_processname%& options, respectively. If Exim was compiled with
38434 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38435 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38436 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38437 the time and host name to each line.
38438 The three log streams are mapped onto syslog priorities as follows:
38439
38440 .ilist
38441 &'mainlog'& is mapped to LOG_INFO
38442 .next
38443 &'rejectlog'& is mapped to LOG_NOTICE
38444 .next
38445 &'paniclog'& is mapped to LOG_ALERT
38446 .endlist
38447
38448 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38449 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38450 these are routed by syslog to the same place. You can suppress this duplication
38451 by setting &%syslog_duplication%& false.
38452
38453 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38454 entries contain multiple lines when headers are included. To cope with both
38455 these cases, entries written to syslog are split into separate &[syslog()]&
38456 calls at each internal newline, and also after a maximum of
38457 870 data characters. (This allows for a total syslog line length of 1024, when
38458 additions such as timestamps are added.) If you are running a syslog
38459 replacement that can handle lines longer than the 1024 characters allowed by
38460 RFC 3164, you should set
38461 .code
38462 SYSLOG_LONG_LINES=yes
38463 .endd
38464 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38465 lines, but it still splits at internal newlines in &'reject'& log entries.
38466
38467 To make it easy to re-assemble split lines later, each component of a split
38468 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38469 where <&'n'&> is the component number and <&'m'&> is the total number of
38470 components in the entry. The / delimiter is used when the line was split
38471 because it was too long; if it was split because of an internal newline, the \
38472 delimiter is used. For example, supposing the length limit to be 50 instead of
38473 870, the following would be the result of a typical rejection message to
38474 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38475 name, and pid as added by syslog:
38476 .code
38477 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38478 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38479 [3/5]  when scanning for sender: missing or malformed lo
38480 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38481 [5/5] mple>)
38482 .endd
38483 The same error might cause the following lines to be written to &"rejectlog"&
38484 (LOG_NOTICE):
38485 .code
38486 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38487 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38488 [3/18] er when scanning for sender: missing or malformed
38489 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38490 [5\18] .example>)
38491 [6\18] Recipients: ph10@some.domain.cam.example
38492 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38493 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38494 [9\18]        id 16RdAL-0006pc-00
38495 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38496 [11\18] 09:43 +0100
38497 [12\18] F From: <>
38498 [13\18]   Subject: this is a test header
38499 [18\18]   X-something: this is another header
38500 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38501 [16\18] le>
38502 [17\18] B Bcc:
38503 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38504 .endd
38505 Log lines that are neither too long nor contain newlines are written to syslog
38506 without modification.
38507
38508 If only syslog is being used, the Exim monitor is unable to provide a log tail
38509 display, unless syslog is routing &'mainlog'& to a file on the local host and
38510 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38511 where it is.
38512
38513
38514
38515 .section "Log line flags" "SECID250"
38516 One line is written to the main log for each message received, and for each
38517 successful, unsuccessful, and delayed delivery. These lines can readily be
38518 picked out by the distinctive two-character flags that immediately follow the
38519 timestamp. The flags are:
38520 .itable none 0 0 2 10* left 90* left
38521 .irow &%<=%&     "message arrival"
38522 .irow &%(=%&     "message fakereject"
38523 .irow &%=>%&     "normal message delivery"
38524 .irow &%->%&     "additional address in same delivery"
38525 .irow &%>>%&     "cutthrough message delivery"
38526 .irow &%*>%&     "delivery suppressed by &%-N%&"
38527 .irow &%**%&     "delivery failed; address bounced"
38528 .irow &%==%&     "delivery deferred; temporary problem"
38529 .endtable
38530
38531
38532 .section "Logging message reception" "SECID251"
38533 .cindex "log" "reception line"
38534 The format of the single-line entry in the main log that is written for every
38535 message received is shown in the basic example below, which is split over
38536 several lines in order to fit it on the page:
38537 .code
38538 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38539   H=mailer.fict.example [192.168.123.123] U=exim
38540   P=smtp S=5678 id=<incoming message id>
38541 .endd
38542 The address immediately following &"<="& is the envelope sender address. A
38543 bounce message is shown with the sender address &"<>"&, and if it is locally
38544 generated, this is followed by an item of the form
38545 .code
38546 R=<message id>
38547 .endd
38548 which is a reference to the message that caused the bounce to be sent.
38549
38550 .cindex "HELO"
38551 .cindex "EHLO"
38552 For messages from other hosts, the H and U fields identify the remote host and
38553 record the RFC 1413 identity of the user that sent the message, if one was
38554 received. The number given in square brackets is the IP address of the sending
38555 host. If there is a single, unparenthesized  host name in the H field, as
38556 above, it has been verified to correspond to the IP address (see the
38557 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
38558 by the remote host in the SMTP HELO or EHLO command, and has not been
38559 verified. If verification yields a different name to that given for HELO or
38560 EHLO, the verified name appears first, followed by the HELO or EHLO
38561 name in parentheses.
38562
38563 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
38564 without brackets, in the HELO or EHLO command, leading to entries in
38565 the log containing text like these examples:
38566 .code
38567 H=(10.21.32.43) [192.168.8.34]
38568 H=([10.21.32.43]) [192.168.8.34]
38569 .endd
38570 This can be confusing. Only the final address in square brackets can be relied
38571 on.
38572
38573 For locally generated messages (that is, messages not received over TCP/IP),
38574 the H field is omitted, and the U field contains the login name of the caller
38575 of Exim.
38576
38577 .cindex "authentication" "logging"
38578 .cindex "AUTH" "logging"
38579 For all messages, the P field specifies the protocol used to receive the
38580 message. This is the value that is stored in &$received_protocol$&. In the case
38581 of incoming SMTP messages, the value indicates whether or not any SMTP
38582 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38583 session was encrypted, there is an additional X field that records the cipher
38584 suite that was used.
38585
38586 .cindex log protocol
38587 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38588 hosts that have authenticated themselves using the SMTP AUTH command. The first
38589 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38590 there is an additional item A= followed by the name of the authenticator that
38591 was used. If an authenticated identification was set up by the authenticator's
38592 &%server_set_id%& option, this is logged too, separated by a colon from the
38593 authenticator name.
38594
38595 .cindex "size" "of message"
38596 The id field records the existing message id, if present. The size of the
38597 received message is given by the S field. When the message is delivered,
38598 headers may be removed or added, so that the size of delivered copies of the
38599 message may not correspond with this value (and indeed may be different to each
38600 other).
38601
38602 The &%log_selector%& option can be used to request the logging of additional
38603 data when a message is received. See section &<<SECTlogselector>>& below.
38604
38605
38606
38607 .section "Logging deliveries" "SECID252"
38608 .cindex "log" "delivery line"
38609 The format of the single-line entry in the main log that is written for every
38610 delivery is shown in one of the examples below, for local and remote
38611 deliveries, respectively. Each example has been split into multiple lines in order
38612 to fit it on the page:
38613 .code
38614 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38615   <marv@hitch.fict.example> R=localuser T=local_delivery
38616 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38617   monk@holistic.fict.example R=dnslookup T=remote_smtp
38618   H=holistic.fict.example [192.168.234.234]
38619 .endd
38620 For ordinary local deliveries, the original address is given in angle brackets
38621 after the final delivery address, which might be a pipe or a file. If
38622 intermediate address(es) exist between the original and the final address, the
38623 last of these is given in parentheses after the final address. The R and T
38624 fields record the router and transport that were used to process the address.
38625
38626 If SMTP AUTH was used for the delivery there is an additional item A=
38627 followed by the name of the authenticator that was used.
38628 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38629 option, this is logged too, as a second colon-separated list item.
38630 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
38631
38632 If a shadow transport was run after a successful local delivery, the log line
38633 for the successful delivery has an item added on the end, of the form
38634 .display
38635 &`ST=<`&&'shadow transport name'&&`>`&
38636 .endd
38637 If the shadow transport did not succeed, the error message is put in
38638 parentheses afterwards.
38639
38640 .cindex "asterisk" "after IP address"
38641 When more than one address is included in a single delivery (for example, two
38642 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38643 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38644 down a single SMTP connection, an asterisk follows the
38645 remote IP address (and port if enabled)
38646 in the log lines for the second and subsequent messages.
38647 When two or more messages are delivered down a single TLS connection, the
38648 DNS and some TLS-related information logged for the first message delivered
38649 will not be present in the log lines for the second and subsequent messages.
38650 TLS cipher information is still available.
38651
38652 .cindex "delivery" "cutthrough; logging"
38653 .cindex "cutthrough" "logging"
38654 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38655 line precedes the reception line, since cutthrough waits for a possible
38656 rejection from the destination in case it can reject the sourced item.
38657
38658 The generation of a reply message by a filter file gets logged as a
38659 &"delivery"& to the addressee, preceded by &">"&.
38660
38661 The &%log_selector%& option can be used to request the logging of additional
38662 data when a message is delivered. See section &<<SECTlogselector>>& below.
38663
38664
38665 .section "Discarded deliveries" "SECID253"
38666 .cindex "discarded messages"
38667 .cindex "message" "discarded"
38668 .cindex "delivery" "discarded; logging"
38669 When a message is discarded as a result of the command &"seen finish"& being
38670 obeyed in a filter file which generates no deliveries, a log entry of the form
38671 .code
38672 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38673   <low.club@bridge.example> R=userforward
38674 .endd
38675 is written, to record why no deliveries are logged. When a message is discarded
38676 because it is aliased to &":blackhole:"& the log line is like this:
38677 .code
38678 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38679   <hole@nowhere.example> R=blackhole_router
38680 .endd
38681
38682
38683 .section "Deferred deliveries" "SECID254"
38684 When a delivery is deferred, a line of the following form is logged:
38685 .code
38686 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38687   R=dnslookup T=smtp defer (146): Connection refused
38688 .endd
38689 In the case of remote deliveries, the error is the one that was given for the
38690 last IP address that was tried. Details of individual SMTP failures are also
38691 written to the log, so the above line would be preceded by something like
38692 .code
38693 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38694   mail1.endrest.example [192.168.239.239]: Connection refused
38695 .endd
38696 When a deferred address is skipped because its retry time has not been reached,
38697 a message is written to the log, but this can be suppressed by setting an
38698 appropriate value in &%log_selector%&.
38699
38700
38701
38702 .section "Delivery failures" "SECID255"
38703 .cindex "delivery" "failure; logging"
38704 If a delivery fails because an address cannot be routed, a line of the
38705 following form is logged:
38706 .code
38707 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38708   <jim@trek99.example>: unknown mail domain
38709 .endd
38710 If a delivery fails at transport time, the router and transport are shown, and
38711 the response from the remote host is included, as in this example:
38712 .code
38713 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38714   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38715   after pipelined RCPT TO:<ace400@pb.example>: host
38716   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38717   <ace400@pb.example>...Addressee unknown
38718 .endd
38719 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38720 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38721 disabling PIPELINING. The log lines for all forms of delivery failure are
38722 flagged with &`**`&.
38723
38724
38725
38726 .section "Fake deliveries" "SECID256"
38727 .cindex "delivery" "fake; logging"
38728 If a delivery does not actually take place because the &%-N%& option has been
38729 used to suppress it, a normal delivery line is written to the log, except that
38730 &"=>"& is replaced by &"*>"&.
38731
38732
38733
38734 .section "Completion" "SECID257"
38735 A line of the form
38736 .code
38737 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38738 .endd
38739 is written to the main log when a message is about to be removed from the spool
38740 at the end of its processing.
38741
38742
38743
38744
38745 .section "Summary of Fields in Log Lines" "SECID258"
38746 .cindex "log" "summary of fields"
38747 A summary of the field identifiers that are used in log lines is shown in
38748 the following table:
38749 .display
38750 &`A   `&        authenticator name (and optional id and sender)
38751 &`C   `&        SMTP confirmation on delivery
38752 &`    `&        command list for &"no mail in SMTP session"&
38753 &`CV  `&        certificate verification status
38754 &`D   `&        duration of &"no mail in SMTP session"&
38755 &`DKIM`&        domain verified in incoming message
38756 &`DN  `&        distinguished name from peer certificate
38757 &`DS  `&        DNSSEC secured lookups
38758 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38759 &`F   `&        sender address (on delivery lines)
38760 &`H   `&        host name and IP address
38761 &`I   `&        local interface used
38762 &`id  `&        message id (from header) for incoming message
38763 &`K   `&        CHUNKING extension used
38764 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38765 &`M8S `&        8BITMIME status for incoming message
38766 &`P   `&        on &`<=`& lines: protocol used
38767 &`    `&        on &`=>`& and &`**`& lines: return path
38768 &`PRDR`&        PRDR extension used
38769 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38770 &`Q   `&        alternate queue name
38771 &`QT  `&        on &`=>`& lines: time spent on queue so far
38772 &`    `&        on &"Completed"& lines: time spent on queue
38773 &`R   `&        on &`<=`& lines: reference for local bounce
38774 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38775 &`RT  `&        on &`<=`& lines: time taken for reception
38776 &`S   `&        size of message in bytes
38777 &`SNI `&        server name indication from TLS client hello
38778 &`ST  `&        shadow transport name
38779 &`T   `&        on &`<=`& lines: message subject (topic)
38780 &`TFO `&        connection took advantage of TCP Fast Open
38781 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38782 &`U   `&        local user or RFC 1413 identity
38783 &`X   `&        TLS cipher suite
38784 .endd
38785
38786
38787 .section "Other log entries" "SECID259"
38788 Various other types of log entry are written from time to time. Most should be
38789 self-explanatory. Among the more common are:
38790
38791 .ilist
38792 .cindex "retry" "time not reached"
38793 &'retry time not reached'&&~&~An address previously suffered a temporary error
38794 during routing or local delivery, and the time to retry has not yet arrived.
38795 This message is not written to an individual message log file unless it happens
38796 during the first delivery attempt.
38797 .next
38798 &'retry time not reached for any host'&&~&~An address previously suffered
38799 temporary errors during remote delivery, and the retry time has not yet arrived
38800 for any of the hosts to which it is routed.
38801 .next
38802 .cindex "spool directory" "file locked"
38803 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
38804 some other Exim process is already working on the message. This can be quite
38805 common if queue running processes are started at frequent intervals. The
38806 &'exiwhat'& utility script can be used to find out what Exim processes are
38807 doing.
38808 .next
38809 .cindex "error" "ignored"
38810 &'error ignored'&&~&~There are several circumstances that give rise to this
38811 message:
38812 .olist
38813 Exim failed to deliver a bounce message whose age was greater than
38814 &%ignore_bounce_errors_after%&. The bounce was discarded.
38815 .next
38816 A filter file set up a delivery using the &"noerror"& option, and the delivery
38817 failed. The delivery was discarded.
38818 .next
38819 A delivery set up by a router configured with
38820 . ==== As this is a nested list, any displays it contains must be indented
38821 . ==== as otherwise they are too far to the left.
38822 .code
38823     errors_to = <>
38824 .endd
38825 failed. The delivery was discarded.
38826 .endlist olist
38827 .next
38828 .cindex DKIM "log line"
38829 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
38830 logging and the message has a DKIM signature header.
38831 .endlist ilist
38832
38833
38834
38835
38836
38837 .section "Reducing or increasing what is logged" "SECTlogselector"
38838 .cindex "log" "selectors"
38839 By setting the &%log_selector%& global option, you can disable some of Exim's
38840 default logging, or you can request additional logging. The value of
38841 &%log_selector%& is made up of names preceded by plus or minus characters. For
38842 example:
38843 .code
38844 log_selector = +arguments -retry_defer
38845 .endd
38846 The list of optional log items is in the following table, with the default
38847 selection marked by asterisks:
38848 .itable none 0 0 3 2.8in left 10pt center 3in left
38849 .irow &`8bitmime`&                      &nbsp; "received 8BITMIME status"
38850 .irow &`acl_warn_skipped`&              *       "skipped &%warn%& statement in ACL"
38851 .irow &`address_rewrite`&               &nbsp; "address rewriting"
38852 .irow &`all_parents`&                   &nbsp; "all parents in => lines"
38853 .irow &`arguments`&                     &nbsp; "command line arguments"
38854 .irow &`connection_reject`&             *       "connection rejections"
38855 .irow &`delay_delivery`&                *       "immediate delivery delayed"
38856 .irow &`deliver_time`&                  &nbsp; "time taken to attempt delivery"
38857 .irow &`delivery_size`&                 &nbsp; "add &`S=`&&'nnn'& to => lines"
38858 .irow &`dkim`&                          *       "DKIM verified domain on <= lines"
38859 .irow &`dkim_verbose`&                  &nbsp; "separate full DKIM verification result line, per signature"
38860 .irow &`dnslist_defer`&                 *       "defers of DNS list (aka RBL) lookups"
38861 .irow &`dnssec`&                        &nbsp; "DNSSEC secured lookups"
38862 .irow &`etrn`&                          *       "ETRN commands"
38863 .irow &`host_lookup_failed`&            *       "as it says"
38864 .irow &`ident_timeout`&                 &nbsp; "timeout for ident connection"
38865 .irow &`incoming_interface`&            &nbsp; "local interface on <= and => lines"
38866 .irow &`incoming_port`&                 &nbsp; "remote port on <= lines"
38867 .irow &`lost_incoming_connection`&      *       "as it says (includes timeouts)"
38868 .irow &`millisec`&                      &nbsp; "millisecond timestamps and RT,QT,DT,D times"
38869 .irow &`msg_id`&                        *       "on <= lines, Message-ID: header value"
38870 .irow &`msg_id_created`&                &nbsp; "on <= lines, Message-ID: header value when one had to be added"
38871 .irow &`outgoing_interface`&            &nbsp; "local interface on => lines"
38872 .irow &`outgoing_port`&                 &nbsp; "add remote port to => lines"
38873 .irow &`queue_run`&                     *       "start and end queue runs"
38874 .irow &`queue_time`&                    &nbsp; "time on queue for one recipient"
38875 .irow &`queue_time_exclusive`&          &nbsp; "exclude recieve time from QT times"
38876 .irow &`queue_time_overall`&            &nbsp; "time on queue for whole message"
38877 .irow &`pid`&                           &nbsp; "Exim process id"
38878 .irow &`pipelining`&                    &nbsp; "PIPELINING use, on <= and => lines"
38879 .irow &`proxy`&                         &nbsp; "proxy address on <= and => lines"
38880 .irow &`receive_time`&                  &nbsp; "time taken to receive message"
38881 .irow &`received_recipients`&           &nbsp; "recipients on <= lines"
38882 .irow &`received_sender`&               &nbsp; "sender on <= lines"
38883 .irow &`rejected_header`&               *       "header contents on reject log"
38884 .irow &`retry_defer`&                   *       "&<quote>&retry time not reached&</quote>&"
38885 .irow &`return_path_on_delivery`&       &nbsp; "put return path on => and ** lines"
38886 .irow &`sender_on_delivery`&            &nbsp; "add sender to => lines"
38887 .irow &`sender_verify_fail`&            *       "sender verification failures"
38888 .irow &`size_reject`&                   *       "rejection because too big"
38889 .irow &`skip_delivery`&                 *       "delivery skipped in a queue run"
38890 .irow &`smtp_confirmation`&             *       "SMTP confirmation on => lines"
38891 .irow &`smtp_connection`&               &nbsp; "incoming SMTP connections"
38892 .irow &`smtp_incomplete_transaction`&   &nbsp; "incomplete SMTP transactions"
38893 .irow &`smtp_mailauth`&                 &nbsp; "AUTH argument to MAIL commands"
38894 .irow &`smtp_no_mail`&                  &nbsp; "session with no MAIL commands"
38895 .irow &`smtp_protocol_error`&           &nbsp; "SMTP protocol errors"
38896 .irow &`smtp_syntax_error`&             &nbsp; "SMTP syntax errors"
38897 .irow &`subject`&                       &nbsp; "contents of &'Subject:'& on <= lines"
38898 .irow &`tls_certificate_verified`&      *       "certificate verification status"
38899 .irow &`tls_cipher`&                    *       "TLS cipher suite on <= and => lines"
38900 .irow &`tls_peerdn`&                    &nbsp; "TLS peer DN on <= and => lines"
38901 .irow &`tls_resumption`&                &nbsp; "append * to cipher field"
38902 .irow &`tls_sni`&                       &nbsp; "TLS SNI on <= lines"
38903 .irow &`unknown_in_list`&               &nbsp; "DNS lookup failed in list match"
38904 .irow &`all`&                           &nbsp; "&*all of the above*&"
38905 .endtable
38906 See also the &%slow_lookup_log%& main configuration option,
38907 section &<<SECID99>>&
38908
38909 More details on each of these items follows:
38910
38911 .ilist
38912 .cindex "8BITMIME"
38913 .cindex "log" "8BITMIME"
38914 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
38915 which may help in tracking down interoperability issues with ancient MTAs
38916 that are not 8bit clean.  This is added to the &"<="& line, tagged with
38917 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
38918 &`7BIT`& and &`8BITMIME`& respectively.
38919 .next
38920 .cindex "&%warn%& ACL verb" "log when skipping"
38921 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
38922 its conditions cannot be evaluated, a log line to this effect is written if
38923 this log selector is set.
38924 .next
38925 .cindex "log" "rewriting"
38926 .cindex "rewriting" "logging"
38927 &%address_rewrite%&: This applies both to global rewrites and per-transport
38928 rewrites, but not to rewrites in filters run as an unprivileged user (because
38929 such users cannot access the log).
38930 .next
38931 .cindex "log" "full parentage"
38932 &%all_parents%&: Normally only the original and final addresses are logged on
38933 delivery lines; with this selector, intermediate parents are given in
38934 parentheses between them.
38935 .next
38936 .cindex "log" "Exim arguments"
38937 .cindex "Exim arguments, logging"
38938 &%arguments%&: This causes Exim to write the arguments with which it was called
38939 to the main log, preceded by the current working directory. This is a debugging
38940 feature, added to make it easier to find out how certain MUAs call
38941 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
38942 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
38943 that are empty or that contain white space are quoted. Non-printing characters
38944 are shown as escape sequences. This facility cannot log unrecognized arguments,
38945 because the arguments are checked before the configuration file is read. The
38946 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
38947 between the caller and Exim.
38948 .next
38949 .cindex "log" "connection rejections"
38950 &%connection_reject%&: A log entry is written whenever an incoming SMTP
38951 connection is rejected, for whatever reason.
38952 .next
38953 .cindex "log" "delayed delivery"
38954 .cindex "delayed delivery, logging"
38955 &%delay_delivery%&: A log entry is written whenever a delivery process is not
38956 started for an incoming message because the load is too high or too many
38957 messages were received on one connection. Logging does not occur if no delivery
38958 process is started because &%queue_only%& is set or &%-odq%& was used.
38959 .next
38960 .cindex "log" "delivery duration"
38961 &%deliver_time%&: For each delivery, the amount of real time it has taken to
38962 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
38963 If millisecond logging is enabled, short times will be shown with greater
38964 precision, eg. &`DT=0.304s`&.
38965 .next
38966 .cindex "log" "message size on delivery"
38967 .cindex "size" "of message"
38968 &%delivery_size%&: For each delivery, the size of message delivered is added to
38969 the &"=>"& line, tagged with S=.
38970 .next
38971 .cindex log "DKIM verification"
38972 .cindex DKIM "verification logging"
38973 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
38974 verifies successfully a tag of DKIM is added, with one of the verified domains.
38975 .next
38976 .cindex log "DKIM verification"
38977 .cindex DKIM "verification logging"
38978 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
38979 .next
38980 .cindex "log" "dnslist defer"
38981 .cindex "DNS list" "logging defer"
38982 .cindex "black list (DNS)"
38983 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
38984 DNS black list suffers a temporary error.
38985 .next
38986 .cindex log dnssec
38987 .cindex dnssec logging
38988 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
38989 dns lookups gave secure results a tag of DS is added.
38990 For acceptance this covers the reverse and forward lookups for host name verification.
38991 It does not cover helo-name verification.
38992 For delivery this covers the SRV, MX, A and/or AAAA lookups.
38993 .next
38994 .cindex "log" "ETRN commands"
38995 .cindex "ETRN" "logging"
38996 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
38997 is run to determine whether or not it is actually accepted. An invalid ETRN
38998 command, or one received within a message transaction is not logged by this
38999 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
39000 .next
39001 .cindex "log" "host lookup failure"
39002 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
39003 any addresses, or when a lookup of an IP address fails to find a host name, a
39004 log line is written. This logging does not apply to direct DNS lookups when
39005 routing email addresses, but it does apply to &"byname"& lookups.
39006 .next
39007 .cindex "log" "ident timeout"
39008 .cindex "RFC 1413" "logging timeout"
39009 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
39010 client's ident port times out.
39011 .next
39012 .cindex "log" "incoming interface"
39013 .cindex "log" "outgoing interface"
39014 .cindex "log" "local interface"
39015 .cindex "log" "local address and port"
39016 .cindex "TCP/IP" "logging local address and port"
39017 .cindex "interface" "logging"
39018 &%incoming_interface%&: The interface on which a message was received is added
39019 to the &"<="& line as an IP address in square brackets, tagged by I= and
39020 followed by a colon and the port number. The local interface and port are also
39021 added to other SMTP log lines, for example, &"SMTP connection from"&, to
39022 rejection lines, and (despite the name) to outgoing
39023 &"=>"&, &"->"&, &"=="& and &"**"& lines.
39024 The latter can be disabled by turning off the &%outgoing_interface%& option.
39025 .next
39026 .cindex log "incoming proxy address"
39027 .cindex proxy "logging proxy address"
39028 .cindex "TCP/IP" "logging proxy address"
39029 &%proxy%&: The internal (closest to the system running Exim) IP address
39030 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
39031 on a proxied connection
39032 or the &"=>"& line for a message delivered on a proxied connection.
39033 See &<<SECTproxyInbound>>& for more information.
39034 .next
39035 .cindex "log" "incoming remote port"
39036 .cindex "port" "logging remote"
39037 .cindex "TCP/IP" "logging incoming remote port"
39038 .vindex "&$sender_fullhost$&"
39039 .vindex "&$sender_rcvhost$&"
39040 &%incoming_port%&: The remote port number from which a message was received is
39041 added to log entries and &'Received:'& header lines, following the IP address
39042 in square brackets, and separated from it by a colon. This is implemented by
39043 changing the value that is put in the &$sender_fullhost$& and
39044 &$sender_rcvhost$& variables. Recording the remote port number has become more
39045 important with the widening use of NAT (see RFC 2505).
39046 .next
39047 .cindex "log" "dropped connection"
39048 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
39049 connection is unexpectedly dropped.
39050 .next
39051 .cindex "log" "millisecond timestamps"
39052 .cindex millisecond logging
39053 .cindex timestamps "millisecond, in logs"
39054 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
39055 appended to the seconds value.
39056 .next
39057 .cindex "log" "message id"
39058 &%msg_id%&: The value of the Message-ID: header.
39059 .next
39060 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
39061 This will be either because the message is a bounce, or was submitted locally
39062 (submission mode) without one.
39063 The field identifier will have an asterix appended: &"id*="&.
39064 .next
39065 .cindex "log" "outgoing interface"
39066 .cindex "log" "local interface"
39067 .cindex "log" "local address and port"
39068 .cindex "TCP/IP" "logging local address and port"
39069 .cindex "interface" "logging"
39070 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
39071 interface on which a message was sent is added to delivery lines as an I= tag
39072 followed by IP address in square brackets. You can disable this by turning
39073 off the &%outgoing_interface%& option.
39074 .next
39075 .cindex "log" "outgoing remote port"
39076 .cindex "port" "logging outgoing remote"
39077 .cindex "TCP/IP" "logging outgoing remote port"
39078 &%outgoing_port%&: The remote port number is added to delivery log lines (those
39079 containing => tags) following the IP address.
39080 The local port is also added if &%incoming_interface%& and
39081 &%outgoing_interface%& are both enabled.
39082 This option is not included in the default setting, because for most ordinary
39083 configurations, the remote port number is always 25 (the SMTP port), and the
39084 local port is a random ephemeral port.
39085 .next
39086 .cindex "log" "process ids in"
39087 .cindex "pid (process id)" "in log lines"
39088 &%pid%&: The current process id is added to every log line, in square brackets,
39089 immediately after the time and date.
39090 .next
39091 .cindex log pipelining
39092 .cindex pipelining "logging outgoing"
39093 &%pipelining%&: A field is added to delivery and accept
39094 log lines when the ESMTP PIPELINING extension was used.
39095 The field is a single "L".
39096
39097 On accept lines, where PIPELINING was offered but not used by the client,
39098 the field has a minus appended.
39099
39100 .cindex "pipelining" "early connection"
39101 If Exim is built without the DISABLE_PIPE_CONNECT build option
39102 accept "L" fields have a period appended if the feature was
39103 offered but not used, or an asterisk appended if used.
39104 Delivery "L" fields have an asterisk appended if used.
39105
39106 .next
39107 .cindex "log" "queue run"
39108 .cindex "queue runner" "logging"
39109 &%queue_run%&: The start and end of every queue run are logged.
39110 .next
39111 .cindex "log" "queue time"
39112 &%queue_time%&: The amount of time the message has been in the queue on the
39113 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
39114 &`QT=3m45s`&.
39115 If millisecond logging is enabled, short times will be shown with greater
39116 precision, eg. &`QT=1.578s`&.
39117 .next
39118 &%queue_time_overall%&: The amount of time the message has been in the queue on
39119 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
39120 example, &`QT=3m45s`&.
39121 .next
39122 .cindex "log" "receive duration"
39123 &%receive_time%&: For each message, the amount of real time it has taken to
39124 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
39125 If millisecond logging is enabled, short times will be shown with greater
39126 precision, eg. &`RT=0.204s`&.
39127 .next
39128 .cindex "log" "recipients"
39129 &%received_recipients%&: The recipients of a message are listed in the main log
39130 as soon as the message is received. The list appears at the end of the log line
39131 that is written when a message is received, preceded by the word &"for"&. The
39132 addresses are listed after they have been qualified, but before any rewriting
39133 has taken place.
39134 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
39135 in the list.
39136 .next
39137 .cindex "log" "sender reception"
39138 &%received_sender%&: The unrewritten original sender of a message is added to
39139 the end of the log line that records the message's arrival, after the word
39140 &"from"& (before the recipients if &%received_recipients%& is also set).
39141 .next
39142 .cindex "log" "header lines for rejection"
39143 &%rejected_header%&: If a message's header has been received at the time a
39144 rejection is written to the reject log, the complete header is added to the
39145 log. Header logging can be turned off individually for messages that are
39146 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
39147 .next
39148 .cindex "log" "retry defer"
39149 &%retry_defer%&: A log line is written if a delivery is deferred because a
39150 retry time has not yet been reached. However, this &"retry time not reached"&
39151 message is always omitted from individual message logs after the first delivery
39152 attempt.
39153 .next
39154 .cindex "log" "return path"
39155 &%return_path_on_delivery%&: The return path that is being transmitted with
39156 the message is included in delivery and bounce lines, using the tag P=.
39157 This is omitted if no delivery actually happens, for example, if routing fails,
39158 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
39159 .next
39160 .cindex "log" "sender on delivery"
39161 &%sender_on_delivery%&: The message's sender address is added to every delivery
39162 and bounce line, tagged by F= (for &"from"&).
39163 This is the original sender that was received with the message; it is not
39164 necessarily the same as the outgoing return path.
39165 .next
39166 .cindex "log" "sender verify failure"
39167 &%sender_verify_fail%&: If this selector is unset, the separate log line that
39168 gives details of a sender verification failure is not written. Log lines for
39169 the rejection of SMTP commands contain just &"sender verify failed"&, so some
39170 detail is lost.
39171 .next
39172 .cindex "log" "size rejection"
39173 &%size_reject%&: A log line is written whenever a message is rejected because
39174 it is too big.
39175 .next
39176 .cindex "log" "frozen messages; skipped"
39177 .cindex "frozen messages" "logging skipping"
39178 &%skip_delivery%&: A log line is written whenever a message is skipped during a
39179 queue run because it another process is already delivering it or because
39180 it is frozen.
39181 .cindex "&""spool file is locked""&"
39182 .cindex "&""message is frozen""&"
39183 The message that is written is either &"spool file is locked"& or
39184 &"message is frozen"&.
39185 .next
39186 .cindex "log" "smtp confirmation"
39187 .cindex "SMTP" "logging confirmation"
39188 .cindex "LMTP" "logging confirmation"
39189 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
39190 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
39191 A number of MTAs (including Exim) return an identifying string in this
39192 response.
39193 .next
39194 .cindex "log" "SMTP connections"
39195 .cindex "SMTP" "logging connections"
39196 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
39197 established or closed, unless the connection is from a host that matches
39198 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
39199 only when the closure is unexpected.) This applies to connections from local
39200 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
39201 dropped in the middle of a message, a log line is always written, whether or
39202 not this selector is set, but otherwise nothing is written at the start and end
39203 of connections unless this selector is enabled.
39204
39205 For TCP/IP connections to an Exim daemon, the current number of connections is
39206 included in the log message for each new connection, but note that the count is
39207 reset if the daemon is restarted.
39208 Also, because connections are closed (and the closure is logged) in
39209 subprocesses, the count may not include connections that have been closed but
39210 whose termination the daemon has not yet noticed. Thus, while it is possible to
39211 match up the opening and closing of connections in the log, the value of the
39212 logged counts may not be entirely accurate.
39213 .next
39214 .cindex "log" "SMTP transaction; incomplete"
39215 .cindex "SMTP" "logging incomplete transactions"
39216 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
39217 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
39218 and the message sender plus any accepted recipients are included in the log
39219 line. This can provide evidence of dictionary attacks.
39220 .next
39221 .cindex "log" "non-MAIL SMTP sessions"
39222 .cindex "MAIL" "logging session without"
39223 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
39224 connection terminates without having issued a MAIL command. This includes both
39225 the case when the connection is dropped, and the case when QUIT is used. It
39226 does not include cases where the connection is rejected right at the start (by
39227 an ACL, or because there are too many connections, or whatever). These cases
39228 already have their own log lines.
39229
39230 The log line that is written contains the identity of the client in the usual
39231 way, followed by D= and a time, which records the duration of the connection.
39232 If the connection was authenticated, this fact is logged exactly as it is for
39233 an incoming message, with an A= item. If the connection was encrypted, CV=,
39234 DN=, and X= items may appear as they do for an incoming message, controlled by
39235 the same logging options.
39236
39237 Finally, if any SMTP commands were issued during the connection, a C= item
39238 is added to the line, listing the commands that were used. For example,
39239 .code
39240 C=EHLO,QUIT
39241 .endd
39242 shows that the client issued QUIT straight after EHLO. If there were fewer
39243 than 20 commands, they are all listed. If there were more than 20 commands,
39244 the last 20 are listed, preceded by &"..."&. However, with the default
39245 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
39246 have been aborted before 20 non-mail commands are processed.
39247 .next
39248 &%smtp_mailauth%&: A third subfield with the authenticated sender,
39249 colon-separated, is appended to the A= item for a message arrival or delivery
39250 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
39251 was accepted or used.
39252 .next
39253 .cindex "log" "SMTP protocol error"
39254 .cindex "SMTP" "logging protocol error"
39255 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
39256 encountered. Exim does not have perfect detection of all protocol errors
39257 because of transmission delays and the use of pipelining. If PIPELINING has
39258 been advertised to a client, an Exim server assumes that the client will use
39259 it, and therefore it does not count &"expected"& errors (for example, RCPT
39260 received after rejecting MAIL) as protocol errors.
39261 .next
39262 .cindex "SMTP" "logging syntax errors"
39263 .cindex "SMTP" "syntax errors; logging"
39264 .cindex "SMTP" "unknown command; logging"
39265 .cindex "log" "unknown SMTP command"
39266 .cindex "log" "SMTP syntax error"
39267 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
39268 encountered. An unrecognized command is treated as a syntax error. For an
39269 external connection, the host identity is given; for an internal connection
39270 using &%-bs%& the sender identification (normally the calling user) is given.
39271 .next
39272 .cindex "log" "subject"
39273 .cindex "subject, logging"
39274 &%subject%&: The subject of the message is added to the arrival log line,
39275 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
39276 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
39277 specifies whether characters with values greater than 127 should be logged
39278 unchanged, or whether they should be rendered as escape sequences.
39279 .next
39280 .cindex "log" "certificate verification"
39281 .cindex log DANE
39282 .cindex DANE logging
39283 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
39284 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
39285 verified
39286 using a CA trust anchor,
39287 &`CV=dane`& if using a DNS trust anchor,
39288 and &`CV=no`& if not.
39289 .next
39290 .cindex "log" "TLS cipher"
39291 .cindex "TLS" "logging cipher"
39292 &%tls_cipher%&: When a message is sent or received over an encrypted
39293 connection, the cipher suite used is added to the log line, preceded by X=.
39294 .next
39295 .cindex "log" "TLS peer DN"
39296 .cindex "TLS" "logging peer DN"
39297 &%tls_peerdn%&: When a message is sent or received over an encrypted
39298 connection, and a certificate is supplied by the remote host, the peer DN is
39299 added to the log line, preceded by DN=.
39300 .next
39301 .cindex "log" "TLS resumption"
39302 .cindex "TLS" "logging session resumption"
39303 &%tls_resumption%&: When a message is sent or received over an encrypted
39304 connection and the TLS session resumed one used on a previous TCP connection,
39305 an asterisk is appended to the X= cipher field in the log line.
39306 .next
39307 .cindex "log" "TLS SNI"
39308 .cindex "TLS" "logging SNI"
39309 .cindex SNI logging
39310 &%tls_sni%&: When a message is received over an encrypted connection, and
39311 the remote host provided the Server Name Indication extension, the SNI is
39312 added to the log line, preceded by SNI=.
39313 .next
39314 .cindex "log" "DNS failure in list"
39315 &%unknown_in_list%&: This setting causes a log entry to be written when the
39316 result of a list match is failure because a DNS lookup failed.
39317 .endlist
39318
39319
39320 .section "Message log" "SECID260"
39321 .cindex "message" "log file for"
39322 .cindex "log" "message log; description of"
39323 .cindex "&_msglog_& directory"
39324 .oindex "&%preserve_message_logs%&"
39325 In addition to the general log files, Exim writes a log file for each message
39326 that it handles. The names of these per-message logs are the message ids, and
39327 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39328 message log contains copies of the log lines that apply to the message. This
39329 makes it easier to inspect the status of an individual message without having
39330 to search the main log. A message log is deleted when processing of the message
39331 is complete, unless &%preserve_message_logs%& is set, but this should be used
39332 only with great care because they can fill up your disk very quickly.
39333
39334 On a heavily loaded system, it may be desirable to disable the use of
39335 per-message logs, in order to reduce disk I/O. This can be done by setting the
39336 &%message_logs%& option false.
39337 .ecindex IIDloggen
39338
39339
39340
39341
39342 . ////////////////////////////////////////////////////////////////////////////
39343 . ////////////////////////////////////////////////////////////////////////////
39344
39345 .chapter "Exim utilities" "CHAPutils"
39346 .scindex IIDutils "utilities"
39347 A number of utility scripts and programs are supplied with Exim and are
39348 described in this chapter. There is also the Exim Monitor, which is covered in
39349 the next chapter. The utilities described here are:
39350
39351 .itable none 0 0 3  7* left  15* left  40* left
39352 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39353   "list what Exim processes are doing"
39354 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39355 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39356 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39357 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39358                                                 various criteria"
39359 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39360 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39361   "extract statistics from the log"
39362 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39363   "check address acceptance from given IP"
39364 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39365 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39366 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39367 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39368 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39369 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39370 .endtable
39371
39372 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39373 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39374 &url(https://duncanthrax.net/exilog/) for details.
39375
39376
39377
39378
39379 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39380 .cindex "&'exiwhat'&"
39381 .cindex "process, querying"
39382 .cindex "SIGUSR1"
39383 On operating systems that can restart a system call after receiving a signal
39384 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39385 a line describing what it is doing to the file &_exim-process.info_& in the
39386 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39387 processes it can find, having first emptied the file. It then waits for one
39388 second to allow the Exim processes to react before displaying the results. In
39389 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39390 send the signal to the Exim processes, so it is normally run as root.
39391
39392 &*Warning*&: This is not an efficient process. It is intended for occasional
39393 use by system administrators. It is not sensible, for example, to set up a
39394 script that sends SIGUSR1 signals to Exim processes at short intervals.
39395
39396
39397 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39398 varies in different operating systems. Not only are different options used,
39399 but the format of the output is different. For this reason, there are some
39400 system configuration options that configure exactly how &'exiwhat'& works. If
39401 it doesn't seem to be working for you, check the following compile-time
39402 options:
39403 .itable none 0 0 2 30* left 70* left
39404 .irow &`EXIWHAT_PS_CMD`&        "the command for running &'ps'&"
39405 .irow &`EXIWHAT_PS_ARG`&        "the argument for &'ps'&"
39406 .irow &`EXIWHAT_EGREP_ARG`&     "the argument for &'egrep'& to select from &'ps'& output"
39407 .irow &`EXIWHAT_KILL_ARG`&      "the argument for the &'kill'& command"
39408 .endtable
39409 An example of typical output from &'exiwhat'& is
39410 .code
39411 164 daemon: -q1h, listening on port 25
39412 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39413 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39414   [10.19.42.42] (editor@ref.example)
39415 10592 handling incoming call from [192.168.243.242]
39416 10628 accepting a local non-SMTP message
39417 .endd
39418 The first number in the output line is the process number. The third line has
39419 been split here, in order to fit it on the page.
39420
39421
39422
39423 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39424 .cindex "&'exiqgrep'&"
39425 .cindex "queue" "grepping"
39426 This utility is a Perl script contributed by Matt Hubbard. It runs
39427 .code
39428 exim -bpu
39429 .endd
39430 or (in case &*-a*& switch is specified)
39431 .code
39432 exim -bp
39433 .endd
39434 to obtain a queue listing, and then greps the output to select messages
39435 that match given criteria. The following selection options are available:
39436
39437 .vlist
39438 .vitem &*-f*&&~<&'regex'&>
39439 Match the sender address using a case-insensitive search. The field that is
39440 tested is enclosed in angle brackets, so you can test for bounce messages with
39441 .code
39442 exiqgrep -f '^<>$'
39443 .endd
39444 .vitem &*-r*&&~<&'regex'&>
39445 Match a recipient address using a case-insensitive search. The field that is
39446 tested is not enclosed in angle brackets.
39447
39448 .vitem &*-s*&&~<&'regex'&>
39449 Match against the size field.
39450
39451 .vitem &*-y*&&~<&'seconds'&>
39452 Match messages that are younger than the given time.
39453
39454 .vitem &*-o*&&~<&'seconds'&>
39455 Match messages that are older than the given time.
39456
39457 .vitem &*-z*&
39458 Match only frozen messages.
39459
39460 .vitem &*-x*&
39461 Match only non-frozen messages.
39462
39463 .vitem &*-G*&&~<&'queuename'&>
39464 Match only messages in the given queue.  Without this, the default queue is searched.
39465 .endlist
39466
39467 The following options control the format of the output:
39468
39469 .vlist
39470 .vitem &*-c*&
39471 Display only the count of matching messages.
39472
39473 .vitem &*-l*&
39474 Long format &-- display the full message information as output by Exim. This is
39475 the default.
39476
39477 .vitem &*-i*&
39478 Display message ids only.
39479
39480 .vitem &*-b*&
39481 Brief format &-- one line per message.
39482
39483 .vitem &*-R*&
39484 Display messages in reverse order.
39485
39486 .vitem &*-a*&
39487 Include delivered recipients in queue listing.
39488 .endlist
39489
39490 The following options give alternates for configuration:
39491
39492 .vlist
39493 .vitem &*-C*&&~<&'config&~file'&>
39494 is used to specify an alternate &_exim.conf_& which might
39495 contain alternate exim configuration the queue management might be using.
39496
39497 .vitem &*-E*&&~<&'path'&>
39498 can be used to specify a path for the exim binary,
39499 overriding the built-in one.
39500 .endlist
39501
39502 There is one more option, &%-h%&, which outputs a list of options.
39503 At least one selection option, or either the &*-c*& or &*-h*& option, must be given.
39504
39505
39506
39507 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39508 .cindex "&'exiqsumm'&"
39509 .cindex "queue" "summary"
39510 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39511 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39512 running a command such as
39513 .code
39514 exim -bp | exiqsumm
39515 .endd
39516 The output consists of one line for each domain that has messages waiting for
39517 it, as in the following example:
39518 .code
39519 3   2322   74m   66m  msn.com.example
39520 .endd
39521 Each line lists the number of pending deliveries for a domain, their total
39522 volume, and the length of time that the oldest and the newest messages have
39523 been waiting. Note that the number of pending deliveries is greater than the
39524 number of messages when messages have more than one recipient.
39525
39526 A summary line is output at the end. By default the output is sorted on the
39527 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39528 the output to be sorted by oldest message and by count of messages,
39529 respectively. There are also three options that split the messages for each
39530 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39531 separates frozen messages, and &%-s%& separates messages according to their
39532 sender.
39533
39534 The output of &'exim -bp'& contains the original addresses in the message, so
39535 this also applies to the output from &'exiqsumm'&. No domains from addresses
39536 generated by aliasing or forwarding are included (unless the &%one_time%&
39537 option of the &(redirect)& router has been used to convert them into &"top
39538 level"& addresses).
39539
39540
39541
39542
39543 .section "Extracting specific information from the log (exigrep)" &&&
39544          "SECTextspeinf"
39545 .cindex "&'exigrep'&"
39546 .cindex "log" "extracts; grepping for"
39547 The &'exigrep'& utility is a Perl script that searches one or more main log
39548 files for entries that match a given pattern. When it finds a match, it
39549 extracts all the log entries for the relevant message, not just those that
39550 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
39551 given message, or all mail for a given user, or for a given host, for example.
39552 The input files can be in Exim log format or syslog format.
39553 If a matching log line is not associated with a specific message, it is
39554 included in &'exigrep'&'s output without any additional lines. The usage is:
39555 .display
39556 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
39557 .endd
39558 If no log filenames are given on the command line, the standard input is read.
39559
39560 The &%-t%& argument specifies a number of seconds. It adds an additional
39561 condition for message selection. Messages that are complete are shown only if
39562 they spent more than <&'n'&> seconds in the queue.
39563
39564 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
39565 makes it case-sensitive. This may give a performance improvement when searching
39566 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
39567 option; with &%-I%& they do not. In both cases it is possible to change the
39568 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
39569
39570 The &%-l%& option means &"literal"&, that is, treat all characters in the
39571 pattern as standing for themselves. Otherwise the pattern must be a Perl
39572 regular expression.
39573
39574 The &%-v%& option inverts the matching condition. That is, a line is selected
39575 if it does &'not'& match the pattern.
39576
39577 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39578 that are generated as a result/response to a message that &'exigrep'& matched
39579 normally.
39580
39581 Example of &%-M%&:
39582 user_a sends a message to user_b, which generates a bounce back to user_b. If
39583 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39584 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
39585 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
39586 when searching for &"user_a"& will show both messages since the bounce is
39587 &"related"& to or a &"result"& of the first message that was found by the
39588 search term.
39589
39590 If the location of a &'zcat'& command is known from the definition of
39591 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
39592 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
39593 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
39594 autodetection of some well known compression extensions.
39595
39596
39597 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
39598 .cindex "&'exipick'&"
39599 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
39600 lists messages from the queue according to a variety of criteria. For details
39601 of &'exipick'&'s facilities, run &'exipick'& with
39602 the &%--help%& option.
39603
39604
39605 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
39606 .cindex "log" "cycling local files"
39607 .cindex "cycling logs"
39608 .cindex "&'exicyclog'&"
39609 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39610 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39611 you are using log files with datestamps in their names (see section
39612 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39613 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39614 There are two command line options for &'exicyclog'&:
39615 .ilist
39616 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39617 default that is set when Exim is built. The default default is 10.
39618 .next
39619 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39620 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39621 overriding the script's default, which is to find the setting from Exim's
39622 configuration.
39623 .endlist
39624
39625 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39626 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39627 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39628 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39629 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39630 logs are handled similarly.
39631
39632 If the limit is greater than 99, the script uses 3-digit numbers such as
39633 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39634 to one that is greater, or &'vice versa'&, you will have to fix the names of
39635 any existing log files.
39636
39637 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39638 the end are deleted. All files with numbers greater than 01 are compressed,
39639 using a compression command which is configured by the COMPRESS_COMMAND
39640 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39641 root &%crontab%& entry of the form
39642 .code
39643 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39644 .endd
39645 assuming you have used the name &"exim"& for the Exim user. You can run
39646 &'exicyclog'& as root if you wish, but there is no need.
39647
39648
39649
39650 .section "Mail statistics (eximstats)" "SECTmailstat"
39651 .cindex "statistics"
39652 .cindex "&'eximstats'&"
39653 A Perl script called &'eximstats'& is provided for extracting statistical
39654 information from log files. The output is either plain text, or HTML.
39655 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39656 . --- 404 error and everything else points to that.
39657
39658 The &'eximstats'& script has been hacked about quite a bit over time. The
39659 latest version is the result of some extensive revision by Steve Campbell. A
39660 lot of information is given by default, but there are options for suppressing
39661 various parts of it. Following any options, the arguments to the script are a
39662 list of files, which should be main log files. For example:
39663 .code
39664 eximstats -nr /var/spool/exim/log/mainlog.01
39665 .endd
39666 By default, &'eximstats'& extracts information about the number and volume of
39667 messages received from or delivered to various hosts. The information is sorted
39668 both by message count and by volume, and the top fifty hosts in each category
39669 are listed on the standard output. Similar information, based on email
39670 addresses or domains instead of hosts can be requested by means of various
39671 options. For messages delivered and received locally, similar statistics are
39672 also produced per user.
39673
39674 The output also includes total counts and statistics about delivery errors, and
39675 histograms showing the number of messages received and deliveries made in each
39676 hour of the day. A delivery with more than one address in its envelope (for
39677 example, an SMTP transaction with more than one RCPT command) is counted
39678 as a single delivery by &'eximstats'&.
39679
39680 Though normally more deliveries than receipts are reported (as messages may
39681 have multiple recipients), it is possible for &'eximstats'& to report more
39682 messages received than delivered, even though the queue is empty at the start
39683 and end of the period in question. If an incoming message contains no valid
39684 recipients, no deliveries are recorded for it. A bounce message is handled as
39685 an entirely separate message.
39686
39687 &'eximstats'& always outputs a grand total summary giving the volume and number
39688 of messages received and deliveries made, and the number of hosts involved in
39689 each case. It also outputs the number of messages that were delayed (that is,
39690 not completely delivered at the first attempt), and the number that had at
39691 least one address that failed.
39692
39693 The remainder of the output is in sections that can be independently disabled
39694 or modified by various options. It consists of a summary of deliveries by
39695 transport, histograms of messages received and delivered per time interval
39696 (default per hour), information about the time messages spent in the queue,
39697 a list of relayed messages, lists of the top fifty sending hosts, local
39698 senders, destination hosts, and destination local users by count and by volume,
39699 and a list of delivery errors that occurred.
39700
39701 The relay information lists messages that were actually relayed, that is, they
39702 came from a remote host and were directly delivered to some other remote host,
39703 without being processed (for example, for aliasing or forwarding) locally.
39704
39705 There are quite a few options for &'eximstats'& to control exactly what it
39706 outputs. These are documented in the Perl script itself, and can be extracted
39707 by running the command &(perldoc)& on the script. For example:
39708 .code
39709 perldoc /usr/exim/bin/eximstats
39710 .endd
39711
39712 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39713 .cindex "&'exim_checkaccess'&"
39714 .cindex "policy control" "checking access"
39715 .cindex "checking access"
39716 The &%-bh%& command line argument allows you to run a fake SMTP session with
39717 debugging output, in order to check what Exim is doing when it is applying
39718 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39719 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39720 sometimes you just want to answer the question &"Does this address have
39721 access?"& without bothering with any further details.
39722
39723 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39724 two arguments, an IP address and an email address:
39725 .code
39726 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39727 .endd
39728 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39729 given email address would be accepted in a RCPT command in a TCP/IP
39730 connection from the host with the given IP address. The output of the utility
39731 is either the word &"accepted"&, or the SMTP error response, for example:
39732 .code
39733 Rejected:
39734 550 Relay not permitted
39735 .endd
39736 When running this test, the utility uses &`<>`& as the envelope sender address
39737 for the MAIL command, but you can change this by providing additional
39738 options. These are passed directly to the Exim command. For example, to specify
39739 that the test is to be run with the sender address &'himself@there.example'&
39740 you can use:
39741 .code
39742 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39743                  -f himself@there.example
39744 .endd
39745 Note that these additional Exim command line items must be given after the two
39746 mandatory arguments.
39747
39748 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39749 while running its checks. You can run checks that include callouts by using
39750 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39751
39752
39753
39754 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39755 .cindex "DBM" "building dbm files"
39756 .cindex "building DBM files"
39757 .cindex "&'exim_dbmbuild'&"
39758 .cindex "lower casing"
39759 .cindex "binary zero" "in lookup key"
39760 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39761 the format used by the &(lsearch)& lookup (see section
39762 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39763 names as keys and the remainder of the information as data. The lower-casing
39764 can be prevented by calling the program with the &%-nolc%& option.
39765
39766 A terminating zero is included as part of the key string. This is expected by
39767 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39768 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39769 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39770 files.
39771
39772 The program requires two arguments: the name of the input file (which can be a
39773 single hyphen to indicate the standard input), and the name of the output file.
39774 It creates the output under a temporary name, and then renames it if all went
39775 well.
39776
39777 .cindex "USE_DB"
39778 If the native DB interface is in use (USE_DB is set in a compile-time
39779 configuration file &-- this is common in free versions of Unix) the two
39780 filenames must be different, because in this mode the Berkeley DB functions
39781 create a single output file using exactly the name given. For example,
39782 .code
39783 exim_dbmbuild /etc/aliases /etc/aliases.db
39784 .endd
39785 reads the system alias file and creates a DBM version of it in
39786 &_/etc/aliases.db_&.
39787
39788 In systems that use the &'ndbm'& routines (mostly proprietary versions of
39789 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
39790 environment, the suffixes are added to the second argument of
39791 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
39792 when the Berkeley functions are used in compatibility mode (though this is not
39793 recommended), because in that case it adds a &_.db_& suffix to the filename.
39794
39795 If a duplicate key is encountered, the program outputs a warning, and when it
39796 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
39797 option is used. By default, only the first of a set of duplicates is used &--
39798 this makes it compatible with &(lsearch)& lookups. There is an option
39799 &%-lastdup%& which causes it to use the data for the last duplicate instead.
39800 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
39801 &%stderr%&. For other errors, where it doesn't actually make a new file, the
39802 return code is 2.
39803
39804
39805
39806
39807 .section "Finding individual retry times (exinext)" "SECTfinindret"
39808 .cindex "retry" "times"
39809 .cindex "&'exinext'&"
39810 A utility called &'exinext'& (mostly a Perl script) provides the ability to
39811 fish specific information out of the retry database. Given a mail domain (or a
39812 complete address), it looks up the hosts for that domain, and outputs any retry
39813 information for the hosts or for the domain. At present, the retry information
39814 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
39815 output. For example:
39816 .code
39817 $ exinext piglet@milne.fict.example
39818 kanga.milne.example:192.168.8.1 error 146: Connection refused
39819   first failed: 21-Feb-1996 14:57:34
39820   last tried:   21-Feb-1996 14:57:34
39821   next try at:  21-Feb-1996 15:02:34
39822 roo.milne.example:192.168.8.3 error 146: Connection refused
39823   first failed: 20-Jan-1996 13:12:08
39824   last tried:   21-Feb-1996 11:42:03
39825   next try at:  21-Feb-1996 19:42:03
39826   past final cutoff time
39827 .endd
39828 You can also give &'exinext'& a local part, without a domain, and it
39829 will give any retry information for that local part in your default domain.
39830 A message id can be used to obtain retry information pertaining to a specific
39831 message. This exists only when an attempt to deliver a message to a remote host
39832 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
39833 &'exinext'& is not particularly efficient, but then it is not expected to be
39834 run very often.
39835
39836 The &'exinext'& utility calls Exim to find out information such as the location
39837 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
39838 passed on to the &'exim'& commands. The first specifies an alternate Exim
39839 configuration file, and the second sets macros for use within the configuration
39840 file. These features are mainly to help in testing, but might also be useful in
39841 environments where more than one configuration file is in use.
39842
39843
39844
39845 .section "Hints database maintenance" "SECThindatmai"
39846 .cindex "hints database" "maintenance"
39847 .cindex "maintaining Exim's hints database"
39848 Three utility programs are provided for maintaining the DBM files that Exim
39849 uses to contain its delivery hint information. Each program requires two
39850 arguments. The first specifies the name of Exim's spool directory, and the
39851 second is the name of the database it is to operate on. These are as follows:
39852
39853 .ilist
39854 &'retry'&: the database of retry information
39855 .next
39856 &'wait-'&<&'transport name'&>: databases of information about messages waiting
39857 for remote hosts
39858 .next
39859 &'callout'&: the callout cache
39860 .next
39861 &'ratelimit'&: the data for implementing the ratelimit ACL condition
39862 .next
39863 &'tls'&: TLS session resumption data
39864 .next
39865 &'misc'&: other hints data
39866 .endlist
39867
39868 The &'misc'& database is used for
39869
39870 .ilist
39871 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
39872 .next
39873 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
39874 &(smtp)& transport)
39875 .next
39876 Limiting the concurrency of specific transports (when &%max_parallel%& is set
39877 in a transport)
39878 .endlist
39879
39880
39881
39882 .section "exim_dumpdb" "SECTdumpdb"
39883 .cindex "&'exim_dumpdb'&"
39884 The entire contents of a database are written to the standard output by the
39885 &'exim_dumpdb'& program,
39886 taking as arguments the spool and database names.
39887 An option &'-z'& may be given to request times in UTC;
39888 otherwise times are in the local timezone.
39889 An option &'-k'& may be given to dump only the record keys.
39890 For example, to dump the retry database:
39891 .code
39892 exim_dumpdb /var/spool/exim retry
39893 .endd
39894 For the retry database
39895 two lines of output are produced for each entry:
39896 .code
39897 T:mail.ref.example:192.168.242.242 146 77 Connection refused
39898 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
39899 .endd
39900 The first item on the first line is the key of the record. It starts with one
39901 of the letters R, or T, depending on whether it refers to a routing or
39902 transport retry. For a local delivery, the next part is the local address; for
39903 a remote delivery it is the name of the remote host, followed by its failing IP
39904 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
39905 transport). If the remote port is not the standard one (port 25), it is added
39906 to the IP address. Then there follows an error code, an additional error code,
39907 and a textual description of the error.
39908
39909 The three times on the second line are the time of first failure, the time of
39910 the last delivery attempt, and the computed time for the next attempt. The line
39911 ends with an asterisk if the cutoff time for the last retry rule has been
39912 exceeded.
39913
39914 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
39915 consists of a host name followed by a list of ids for messages that are or were
39916 waiting to be delivered to that host. If there are a very large number for any
39917 one host, continuation records, with a sequence number added to the host name,
39918 may be seen. The data in these records is often out of date, because a message
39919 may be routed to several alternative hosts, and Exim makes no effort to keep
39920 cross-references.
39921
39922
39923
39924 .section "exim_tidydb" "SECTtidydb"
39925 .cindex "&'exim_tidydb'&"
39926 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
39927 database. If run with no options, it removes all records that are more than 30
39928 days old. The age is calculated from the date and time that the record was last
39929 updated. Note that, in the case of the retry database, it is &'not'& the time
39930 since the first delivery failure. Information about a host that has been down
39931 for more than 30 days will remain in the database, provided that the record is
39932 updated sufficiently often.
39933
39934 The cutoff date can be altered by means of the &%-t%& option, which must be
39935 followed by a time. For example, to remove all records older than a week from
39936 the retry database:
39937 .code
39938 exim_tidydb -t 7d /var/spool/exim retry
39939 .endd
39940 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
39941 message ids. In the former these appear as data in records keyed by host &--
39942 they were messages that were waiting for that host &-- and in the latter they
39943 are the keys for retry information for messages that have suffered certain
39944 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
39945 message ids in database records are those of messages that are still on the
39946 queue. Message ids for messages that no longer exist are removed from
39947 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
39948 For the &'retry'& database, records whose keys are non-existent message ids are
39949 removed. The &'exim_tidydb'& utility outputs comments on the standard output
39950 whenever it removes information from the database.
39951
39952 Certain records are automatically removed by Exim when they are no longer
39953 needed, but others are not. For example, if all the MX hosts for a domain are
39954 down, a retry record is created for each one. If the primary MX host comes back
39955 first, its record is removed when Exim successfully delivers to it, but the
39956 records for the others remain because Exim has not tried to use those hosts.
39957
39958 It is important, therefore, to run &'exim_tidydb'& periodically on all the
39959 hints databases. You should do this at a quiet time of day, because it requires
39960 a database to be locked (and therefore inaccessible to Exim) while it does its
39961 work. Removing records from a DBM file does not normally make the file smaller,
39962 but all the common DBM libraries are able to re-use the space that is released.
39963 After an initial phase of increasing in size, the databases normally reach a
39964 point at which they no longer get any bigger, as long as they are regularly
39965 tidied.
39966
39967 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
39968 databases is likely to keep on increasing.
39969
39970
39971
39972
39973 .section "exim_fixdb" "SECTfixdb"
39974 .cindex "&'exim_fixdb'&"
39975 The &'exim_fixdb'& program is a utility for interactively modifying databases.
39976 Its main use is for testing Exim, but it might also be occasionally useful for
39977 getting round problems in a live system. Its interface
39978 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
39979 key of a database record can then be entered, and the data for that record is
39980 displayed.
39981
39982 If &"d"& is typed at the next prompt, the entire record is deleted. For all
39983 except the &'retry'& database, that is the only operation that can be carried
39984 out. For the &'retry'& database, each field is output preceded by a number, and
39985 data for individual fields can be changed by typing the field number followed
39986 by new data, for example:
39987 .code
39988 > 4 951102:1000
39989 .endd
39990 resets the time of the next delivery attempt. Time values are given as a
39991 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
39992 used as optional separators.
39993
39994 Both displayed and input times are in the local timezone by default.
39995 If an option &'-z'& is used on the command line, displayed times
39996 are in UTC.
39997
39998
39999
40000
40001 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
40002 .cindex "mailbox" "maintenance"
40003 .cindex "&'exim_lock'&"
40004 .cindex "locking mailboxes"
40005 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
40006 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
40007 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
40008 a user agent while investigating a problem. The utility requires the name of
40009 the file as its first argument. If the locking is successful, the second
40010 argument is run as a command (using C's &[system()]& function); if there is no
40011 second argument, the value of the SHELL environment variable is used; if this
40012 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
40013 is unlocked and the utility ends. The following options are available:
40014
40015 .vlist
40016 .vitem &%-fcntl%&
40017 Use &[fcntl()]& locking on the open mailbox.
40018
40019 .vitem &%-flock%&
40020 Use &[flock()]& locking on the open mailbox, provided the operating system
40021 supports it.
40022
40023 .vitem &%-interval%&
40024 This must be followed by a number, which is a number of seconds; it sets the
40025 interval to sleep between retries (default 3).
40026
40027 .vitem &%-lockfile%&
40028 Create a lock file before opening the mailbox.
40029
40030 .vitem &%-mbx%&
40031 Lock the mailbox using MBX rules.
40032
40033 .vitem &%-q%&
40034 Suppress verification output.
40035
40036 .vitem &%-retries%&
40037 This must be followed by a number; it sets the number of times to try to get
40038 the lock (default 10).
40039
40040 .vitem &%-restore_time%&
40041 This option causes &%exim_lock%& to restore the modified and read times to the
40042 locked file before exiting. This allows you to access a locked mailbox (for
40043 example, to take a backup copy) without disturbing the times that the user
40044 subsequently sees.
40045
40046 .vitem &%-timeout%&
40047 This must be followed by a number, which is a number of seconds; it sets a
40048 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
40049 default), a non-blocking call is used.
40050
40051 .vitem &%-v%&
40052 Generate verbose output.
40053 .endlist
40054
40055 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
40056 default is to create a lock file and also to use &[fcntl()]& locking on the
40057 mailbox, which is the same as Exim's default. The use of &%-flock%& or
40058 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
40059 requires that the directory containing the file be writeable. Locking by lock
40060 file does not last forever; Exim assumes that a lock file is expired if it is
40061 more than 30 minutes old.
40062
40063 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
40064 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
40065 to be taken out on the open mailbox, and an exclusive lock on the file
40066 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
40067 number of the mailbox file. When the locking is released, if an exclusive lock
40068 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
40069
40070 The default output contains verification of the locking that takes place. The
40071 &%-v%& option causes some additional information to be given. The &%-q%& option
40072 suppresses all output except error messages.
40073
40074 A command such as
40075 .code
40076 exim_lock /var/spool/mail/spqr
40077 .endd
40078 runs an interactive shell while the file is locked, whereas
40079 .display
40080 &`exim_lock -q /var/spool/mail/spqr <<End`&
40081 <&'some commands'&>
40082 &`End`&
40083 .endd
40084 runs a specific non-interactive sequence of commands while the file is locked,
40085 suppressing all verification output. A single command can be run by a command
40086 such as
40087 .code
40088 exim_lock -q /var/spool/mail/spqr \
40089   "cp /var/spool/mail/spqr /some/where"
40090 .endd
40091 Note that if a command is supplied, it must be entirely contained within the
40092 second argument &-- hence the quotes.
40093 .ecindex IIDutils
40094
40095
40096 . ////////////////////////////////////////////////////////////////////////////
40097 . ////////////////////////////////////////////////////////////////////////////
40098
40099 .chapter "The Exim monitor" "CHAPeximon"
40100 .scindex IIDeximon "Exim monitor" "description"
40101 .cindex "X-windows"
40102 .cindex "&'eximon'&"
40103 .cindex "Local/eximon.conf"
40104 .cindex "&_exim_monitor/EDITME_&"
40105 The Exim monitor is an application which displays in an X window information
40106 about the state of Exim's queue and what Exim is doing. An admin user can
40107 perform certain operations on messages from this GUI interface; however all
40108 such facilities are also available from the command line, and indeed, the
40109 monitor itself makes use of the command line to perform any actions requested.
40110
40111
40112
40113 .section "Running the monitor" "SECID264"
40114 The monitor is started by running the script called &'eximon'&. This is a shell
40115 script that sets up a number of environment variables, and then runs the
40116 binary called &_eximon.bin_&. The default appearance of the monitor window can
40117 be changed by editing the &_Local/eximon.conf_& file created by editing
40118 &_exim_monitor/EDITME_&. Comments in that file describe what the various
40119 parameters are for.
40120
40121 The parameters that get built into the &'eximon'& script can be overridden for
40122 a particular invocation by setting up environment variables of the same names,
40123 preceded by &`EXIMON_`&. For example, a shell command such as
40124 .code
40125 EXIMON_LOG_DEPTH=400 eximon
40126 .endd
40127 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
40128 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
40129 overrides the Exim log file configuration. This makes it possible to have
40130 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
40131 syslog messages are routed to a file on the local host.
40132
40133 X resources can be used to change the appearance of the window in the normal
40134 way. For example, a resource setting of the form
40135 .code
40136 Eximon*background: gray94
40137 .endd
40138 changes the colour of the background to light grey rather than white. The
40139 stripcharts are drawn with both the data lines and the reference lines in
40140 black. This means that the reference lines are not visible when on top of the
40141 data. However, their colour can be changed by setting a resource called
40142 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
40143 For example, if your X server is running Unix, you could set up lighter
40144 reference lines in the stripcharts by obeying
40145 .code
40146 xrdb -merge <<End
40147 Eximon*highlight: gray
40148 End
40149 .endd
40150 .cindex "admin user"
40151 In order to see the contents of messages in the queue, and to operate on them,
40152 &'eximon'& must either be run as root or by an admin user.
40153
40154 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
40155 contain X11 resource parameters interpreted by the X11 library.  In addition,
40156 if the first parameter starts with the string "gdb" then it is removed and the
40157 binary is invoked under gdb (the parameter is used as the gdb command-name, so
40158 versioned variants of gdb can be invoked).
40159
40160 The monitor's window is divided into three parts. The first contains one or
40161 more stripcharts and two action buttons, the second contains a &"tail"& of the
40162 main log file, and the third is a display of the queue of messages awaiting
40163 delivery, with two more action buttons. The following sections describe these
40164 different parts of the display.
40165
40166
40167
40168
40169 .section "The stripcharts" "SECID265"
40170 .cindex "stripchart"
40171 The first stripchart is always a count of messages in the queue. Its name can
40172 be configured by setting QUEUE_STRIPCHART_NAME in the
40173 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
40174 configuration script by regular expression matches on log file entries, making
40175 it possible to display, for example, counts of messages delivered to certain
40176 hosts or using certain transports. The supplied defaults display counts of
40177 received and delivered messages, and of local and SMTP deliveries. The default
40178 period between stripchart updates is one minute; this can be adjusted by a
40179 parameter in the &_Local/eximon.conf_& file.
40180
40181 The stripchart displays rescale themselves automatically as the value they are
40182 displaying changes. There are always 10 horizontal lines in each chart; the
40183 title string indicates the value of each division when it is greater than one.
40184 For example, &"x2"& means that each division represents a value of 2.
40185
40186 It is also possible to have a stripchart which shows the percentage fullness of
40187 a particular disk partition, which is useful when local deliveries are confined
40188 to a single partition.
40189
40190 .cindex "&%statvfs%& function"
40191 This relies on the availability of the &[statvfs()]& function or equivalent in
40192 the operating system. Most, but not all versions of Unix that support Exim have
40193 this. For this particular stripchart, the top of the chart always represents
40194 100%, and the scale is given as &"x10%"&. This chart is configured by setting
40195 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
40196 &_Local/eximon.conf_& file.
40197
40198
40199
40200
40201 .section "Main action buttons" "SECID266"
40202 .cindex "size" "of monitor window"
40203 .cindex "Exim monitor" "window size"
40204 .cindex "window size"
40205 Below the stripcharts there is an action button for quitting the monitor. Next
40206 to this is another button marked &"Size"&. They are placed here so that
40207 shrinking the window to its default minimum size leaves just the queue count
40208 stripchart and these two buttons visible. Pressing the &"Size"& button causes
40209 the window to expand to its maximum size, unless it is already at the maximum,
40210 in which case it is reduced to its minimum.
40211
40212 When expanding to the maximum, if the window cannot be fully seen where it
40213 currently is, it is moved back to where it was the last time it was at full
40214 size. When it is expanding from its minimum size, the old position is
40215 remembered, and next time it is reduced to the minimum it is moved back there.
40216
40217 The idea is that you can keep a reduced window just showing one or two
40218 stripcharts at a convenient place on your screen, easily expand it to show
40219 the full window when required, and just as easily put it back to what it was.
40220 The idea is copied from what the &'twm'& window manager does for its
40221 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
40222 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
40223
40224 Normally, the monitor starts up with the window at its full size, but it can be
40225 built so that it starts up with the window at its smallest size, by setting
40226 START_SMALL=yes in &_Local/eximon.conf_&.
40227
40228
40229
40230 .section "The log display" "SECID267"
40231 .cindex "log" "tail of; in monitor"
40232 The second section of the window is an area in which a display of the tail of
40233 the main log is maintained.
40234 To save space on the screen, the timestamp on each log line is shortened by
40235 removing the date and, if &%log_timezone%& is set, the timezone.
40236 The log tail is not available when the only destination for logging data is
40237 syslog, unless the syslog lines are routed to a local file whose name is passed
40238 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
40239
40240 The log sub-window has a scroll bar at its lefthand side which can be used to
40241 move back to look at earlier text, and the up and down arrow keys also have a
40242 scrolling effect. The amount of log that is kept depends on the setting of
40243 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
40244 to use. When this is full, the earlier 50% of data is discarded &-- this is
40245 much more efficient than throwing it away line by line. The sub-window also has
40246 a horizontal scroll bar for accessing the ends of long log lines. This is the
40247 only means of horizontal scrolling; the right and left arrow keys are not
40248 available. Text can be cut from this part of the window using the mouse in the
40249 normal way. The size of this subwindow is controlled by parameters in the
40250 configuration file &_Local/eximon.conf_&.
40251
40252 Searches of the text in the log window can be carried out by means of the ^R
40253 and ^S keystrokes, which default to a reverse and a forward search,
40254 respectively. The search covers only the text that is displayed in the window.
40255 It cannot go further back up the log.
40256
40257 The point from which the search starts is indicated by a caret marker. This is
40258 normally at the end of the text in the window, but can be positioned explicitly
40259 by pointing and clicking with the left mouse button, and is moved automatically
40260 by a successful search. If new text arrives in the window when it is scrolled
40261 back, the caret remains where it is, but if the window is not scrolled back,
40262 the caret is moved to the end of the new text.
40263
40264 Pressing ^R or ^S pops up a window into which the search text can be typed.
40265 There are buttons for selecting forward or reverse searching, for carrying out
40266 the search, and for cancelling. If the &"Search"& button is pressed, the search
40267 happens and the window remains so that further searches can be done. If the
40268 &"Return"& key is pressed, a single search is done and the window is closed. If
40269 ^C is typed the search is cancelled.
40270
40271 The searching facility is implemented using the facilities of the Athena text
40272 widget. By default this pops up a window containing both &"search"& and
40273 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
40274 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
40275 However, the linkers in BSDI and HP-UX seem unable to handle an externally
40276 provided version of &%TextPop%& when the remaining parts of the text widget
40277 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
40278 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
40279 on these systems, at the expense of having unwanted items in the search popup
40280 window.
40281
40282
40283
40284 .section "The queue display" "SECID268"
40285 .cindex "queue" "display in monitor"
40286 The bottom section of the monitor window contains a list of all messages that
40287 are in the queue, which includes those currently being received or delivered,
40288 as well as those awaiting delivery. The size of this subwindow is controlled by
40289 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
40290 at which it is updated is controlled by another parameter in the same file &--
40291 the default is 5 minutes, since queue scans can be quite expensive. However,
40292 there is an &"Update"& action button just above the display which can be used
40293 to force an update of the queue display at any time.
40294
40295 When a host is down for some time, a lot of pending mail can build up for it,
40296 and this can make it hard to deal with other messages in the queue. To help
40297 with this situation there is a button next to &"Update"& called &"Hide"&. If
40298 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
40299 type anything in here and press &"Return"&, the text is added to a chain of
40300 such texts, and if every undelivered address in a message matches at least one
40301 of the texts, the message is not displayed.
40302
40303 If there is an address that does not match any of the texts, all the addresses
40304 are displayed as normal. The matching happens on the ends of addresses so, for
40305 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
40306 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
40307 has been set up, a button called &"Unhide"& is displayed. If pressed, it
40308 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
40309 a hide request is automatically cancelled after one hour.
40310
40311 While the dialogue box is displayed, you can't press any buttons or do anything
40312 else to the monitor window. For this reason, if you want to cut text from the
40313 queue display to use in the dialogue box, you have to do the cutting before
40314 pressing the &"Hide"& button.
40315
40316 The queue display contains, for each unhidden queued message, the length of
40317 time it has been in the queue, the size of the message, the message id, the
40318 message sender, and the first undelivered recipient, all on one line. If it is
40319 a bounce message, the sender is shown as &"<>"&. If there is more than one
40320 recipient to which the message has not yet been delivered, subsequent ones are
40321 listed on additional lines, up to a maximum configured number, following which
40322 an ellipsis is displayed. Recipients that have already received the message are
40323 not shown.
40324
40325 .cindex "frozen messages" "display"
40326 If a message is frozen, an asterisk is displayed at the left-hand side.
40327
40328 The queue display has a vertical scroll bar, and can also be scrolled by means
40329 of the arrow keys. Text can be cut from it using the mouse in the normal way.
40330 The text searching facilities, as described above for the log window, are also
40331 available, but the caret is always moved to the end of the text when the queue
40332 display is updated.
40333
40334
40335
40336 .section "The queue menu" "SECID269"
40337 .cindex "queue" "menu in monitor"
40338 If the &%shift%& key is held down and the left button is clicked when the mouse
40339 pointer is over the text for any message, an action menu pops up, and the first
40340 line of the queue display for the message is highlighted. This does not affect
40341 any selected text.
40342
40343 If you want to use some other event for popping up the menu, you can set the
40344 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40345 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40346 value set in this parameter is a standard X event description. For example, to
40347 run eximon using &%ctrl%& rather than &%shift%& you could use
40348 .code
40349 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40350 .endd
40351 The title of the menu is the message id, and it contains entries which act as
40352 follows:
40353
40354 .ilist
40355 &'message log'&: The contents of the message log for the message are displayed
40356 in a new text window.
40357 .next
40358 &'headers'&: Information from the spool file that contains the envelope
40359 information and headers is displayed in a new text window. See chapter
40360 &<<CHAPspool>>& for a description of the format of spool files.
40361 .next
40362 &'body'&: The contents of the spool file containing the body of the message are
40363 displayed in a new text window. There is a default limit of 20,000 bytes to the
40364 amount of data displayed. This can be changed by setting the BODY_MAX
40365 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40366 .next
40367 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40368 delivery of the message. This causes an automatic thaw if the message is
40369 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40370 a new text window. The delivery is run in a separate process, to avoid holding
40371 up the monitor while the delivery proceeds.
40372 .next
40373 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40374 that the message be frozen.
40375 .next
40376 .cindex "thawing messages"
40377 .cindex "unfreezing messages"
40378 .cindex "frozen messages" "thawing"
40379 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40380 that the message be thawed.
40381 .next
40382 .cindex "delivery" "forcing failure"
40383 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40384 that Exim gives up trying to deliver the message. A bounce message is generated
40385 for any remaining undelivered addresses.
40386 .next
40387 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40388 that the message be deleted from the system without generating a bounce
40389 message.
40390 .next
40391 &'add recipient'&: A dialog box is displayed into which a recipient address can
40392 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40393 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40394 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40395 causes a call to Exim to be made using the &%-Mar%& option to request that an
40396 additional recipient be added to the message, unless the entry box is empty, in
40397 which case no action is taken.
40398 .next
40399 &'mark delivered'&: A dialog box is displayed into which a recipient address
40400 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40401 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40402 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40403 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40404 recipient address as already delivered, unless the entry box is empty, in which
40405 case no action is taken.
40406 .next
40407 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40408 mark all recipient addresses as already delivered.
40409 .next
40410 &'edit sender'&: A dialog box is displayed initialized with the current
40411 sender's address. Pressing RETURN causes a call to Exim to be made using the
40412 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40413 in which case no action is taken. If you want to set an empty sender (as in
40414 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40415 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40416 the address is qualified with that domain.
40417 .endlist
40418
40419 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40420 other cases when a call to Exim is made, if there is any output from Exim (in
40421 particular, if the command fails) a window containing the command and the
40422 output is displayed. Otherwise, the results of the action are normally apparent
40423 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40424 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40425 if no output is generated.
40426
40427 The queue display is automatically updated for actions such as freezing and
40428 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40429 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40430 force an update of the display after one of these actions.
40431
40432 In any text window that is displayed as result of a menu action, the normal
40433 cut-and-paste facility is available, and searching can be carried out using ^R
40434 and ^S, as described above for the log tail window.
40435 .ecindex IIDeximon
40436
40437
40438
40439
40440
40441 . ////////////////////////////////////////////////////////////////////////////
40442 . ////////////////////////////////////////////////////////////////////////////
40443
40444 .chapter "Security considerations" "CHAPsecurity"
40445 .scindex IIDsecurcon "security" "discussion of"
40446 This chapter discusses a number of issues concerned with security, some of
40447 which are also covered in other parts of this manual.
40448
40449 For reasons that this author does not understand, some people have promoted
40450 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40451 existence of this chapter in the documentation. However, the intent of the
40452 chapter is simply to describe the way Exim works in relation to certain
40453 security concerns, not to make any specific claims about the effectiveness of
40454 its security as compared with other MTAs.
40455
40456 What follows is a description of the way Exim is supposed to be. Best efforts
40457 have been made to try to ensure that the code agrees with the theory, but an
40458 absence of bugs can never be guaranteed. Any that are reported will get fixed
40459 as soon as possible.
40460
40461
40462 .section "Building a more &""hardened""& Exim" "SECID286"
40463 .cindex "security" "build-time features"
40464 There are a number of build-time options that can be set in &_Local/Makefile_&
40465 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40466 Exim administrator who does not have the root password, or by someone who has
40467 penetrated the Exim (but not the root) account. These options are as follows:
40468
40469 .ilist
40470 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40471 start of any filenames used with the &%-C%& option. When it is set, these
40472 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40473 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40474 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40475 default setting for &%ALT_CONFIG_PREFIX%&.
40476
40477 If the permitted configuration files are confined to a directory to
40478 which only root has access, this guards against someone who has broken
40479 into the Exim account from running a privileged Exim with an arbitrary
40480 configuration file, and using it to break into other accounts.
40481 .next
40482
40483 If a non-trusted configuration file (i.e. not the default configuration file
40484 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40485 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40486 the next item), then root privilege is retained only if the caller of Exim is
40487 root. This locks out the possibility of testing a configuration using &%-C%&
40488 right through message reception and delivery, even if the caller is root. The
40489 reception works, but by that time, Exim is running as the Exim user, so when
40490 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40491 privilege to be lost. However, root can test reception and delivery using two
40492 separate commands.
40493
40494 .next
40495 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40496 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40497 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40498 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40499 the restrictive side.  Requiring build-time selection of safe macros is onerous
40500 but this option is intended solely as a transition mechanism to permit
40501 previously-working configurations to continue to work after release 4.73.
40502 .next
40503 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40504 is disabled.
40505 .next
40506 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40507 never to be used for any deliveries. This is like the &%never_users%& runtime
40508 option, but it cannot be overridden; the runtime option adds additional users
40509 to the list. The default setting is &"root"&; this prevents a non-root user who
40510 is permitted to modify the runtime file from using Exim as a way to get root.
40511 .endlist
40512
40513
40514
40515 .section "Root privilege" "SECID270"
40516 .cindex "setuid"
40517 .cindex "root privilege"
40518 The Exim binary is normally setuid to root, which means that it gains root
40519 privilege (runs as root) when it starts execution. In some special cases (for
40520 example, when the daemon is not in use and there are no local deliveries), it
40521 may be possible to run Exim setuid to some user other than root. This is
40522 discussed in the next section. However, in most installations, root privilege
40523 is required for two things:
40524
40525 .ilist
40526 To set up a socket connected to the standard SMTP port (25) when initialising
40527 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40528 not required.
40529 .next
40530 To be able to change uid and gid in order to read users' &_.forward_& files and
40531 perform local deliveries as the receiving user or as specified in the
40532 configuration.
40533 .endlist
40534
40535 It is not necessary to be root to do any of the other things Exim does, such as
40536 receiving messages and delivering them externally over SMTP, and it is
40537 obviously more secure if Exim does not run as root except when necessary.
40538 For this reason, a user and group for Exim to use must be defined in
40539 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
40540 group"&. Their values can be changed by the runtime configuration, though this
40541 is not recommended. Often a user called &'exim'& is used, but some sites use
40542 &'mail'& or another user name altogether.
40543
40544 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
40545 abdication; the process cannot regain root afterwards. Prior to release 4.00,
40546 &[seteuid()]& was used in some circumstances, but this is no longer the case.
40547
40548 After a new Exim process has interpreted its command line options, it changes
40549 uid and gid in the following cases:
40550
40551 .ilist
40552 .oindex "&%-C%&"
40553 .oindex "&%-D%&"
40554 If the &%-C%& option is used to specify an alternate configuration file, or if
40555 the &%-D%& option is used to define macro values for the configuration, and the
40556 calling process is not running as root, the uid and gid are changed to those of
40557 the calling process.
40558 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
40559 option may not be used at all.
40560 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
40561 can be supplied if the calling process is running as root, the Exim run-time
40562 user or CONFIGURE_OWNER, if defined.
40563 .next
40564 .oindex "&%-be%&"
40565 .oindex "&%-bf%&"
40566 .oindex "&%-bF%&"
40567 If the expansion test option (&%-be%&) or one of the filter testing options
40568 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
40569 calling process.
40570 .next
40571 If the process is not a daemon process or a queue runner process or a delivery
40572 process or a process for testing address routing (started with &%-bt%&), the
40573 uid and gid are changed to the Exim user and group. This means that Exim always
40574 runs under its own uid and gid when receiving messages. This also applies when
40575 testing address verification
40576 .oindex "&%-bv%&"
40577 .oindex "&%-bh%&"
40578 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
40579 option).
40580 .next
40581 For a daemon, queue runner, delivery, or address testing process, the uid
40582 remains as root at this stage, but the gid is changed to the Exim group.
40583 .endlist
40584
40585 The processes that initially retain root privilege behave as follows:
40586
40587 .ilist
40588 A daemon process changes the gid to the Exim group and the uid to the Exim
40589 user after setting up one or more listening sockets. The &[initgroups()]&
40590 function is called, so that if the Exim user is in any additional groups, they
40591 will be used during message reception.
40592 .next
40593 A queue runner process retains root privilege throughout its execution. Its
40594 job is to fork a controlled sequence of delivery processes.
40595 .next
40596 A delivery process retains root privilege throughout most of its execution,
40597 but any actual deliveries (that is, the transports themselves) are run in
40598 subprocesses which always change to a non-root uid and gid. For local
40599 deliveries this is typically the uid and gid of the owner of the mailbox; for
40600 remote deliveries, the Exim uid and gid are used. Once all the delivery
40601 subprocesses have been run, a delivery process changes to the Exim uid and gid
40602 while doing post-delivery tidying up such as updating the retry database and
40603 generating bounce and warning messages.
40604
40605 While the recipient addresses in a message are being routed, the delivery
40606 process runs as root. However, if a user's filter file has to be processed,
40607 this is done in a subprocess that runs under the individual user's uid and
40608 gid. A system filter is run as root unless &%system_filter_user%& is set.
40609 .next
40610 A process that is testing addresses (the &%-bt%& option) runs as root so that
40611 the routing is done in the same environment as a message delivery.
40612 .endlist
40613
40614
40615
40616
40617 .section "Running Exim without privilege" "SECTrunexiwitpri"
40618 .cindex "privilege, running without"
40619 .cindex "unprivileged running"
40620 .cindex "root privilege" "running without"
40621 Some installations like to run Exim in an unprivileged state for more of its
40622 operation, for added security. Support for this mode of operation is provided
40623 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40624 gid are changed to the Exim user and group at the start of a delivery process
40625 (and also queue runner and address testing processes). This means that address
40626 routing is no longer run as root, and the deliveries themselves cannot change
40627 to any other uid.
40628
40629 .cindex SIGHUP
40630 .cindex "daemon" "restarting"
40631 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40632 that the daemon can still be started in the usual way, and it can respond
40633 correctly to SIGHUP because the re-invocation regains root privilege.
40634
40635 An alternative approach is to make Exim setuid to the Exim user and also setgid
40636 to the Exim group. If you do this, the daemon must be started from a root
40637 process. (Calling Exim from a root process makes it behave in the way it does
40638 when it is setuid root.) However, the daemon cannot restart itself after a
40639 SIGHUP signal because it cannot regain privilege.
40640
40641 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40642 stops Exim from trying to re-invoke itself to do a delivery after a message has
40643 been received. Such a re-invocation is a waste of resources because it has no
40644 effect.
40645
40646 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40647 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40648 to the Exim user seems a clean approach, but there is one complication:
40649
40650 In this style of operation, Exim is running with the real uid and gid set to
40651 those of the calling process, and the effective uid/gid set to Exim's values.
40652 Ideally, any association with the calling process' uid/gid should be dropped,
40653 that is, the real uid/gid should be reset to the effective values so as to
40654 discard any privileges that the caller may have. While some operating systems
40655 have a function that permits this action for a non-root effective uid, quite a
40656 number of them do not. Because of this lack of standardization, Exim does not
40657 address this problem at this time.
40658
40659 For this reason, the recommended approach for &"mostly unprivileged"& running
40660 is to keep the Exim binary setuid to root, and to set
40661 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40662 be used in the most straightforward way.
40663
40664 If you configure Exim not to run delivery processes as root, there are a
40665 number of restrictions on what you can do:
40666
40667 .ilist
40668 You can deliver only as the Exim user/group. You should  explicitly use the
40669 &%user%& and &%group%& options to override routers or local transports that
40670 normally deliver as the recipient. This makes sure that configurations that
40671 work in this mode function the same way in normal mode. Any implicit or
40672 explicit specification of another user causes an error.
40673 .next
40674 Use of &_.forward_& files is severely restricted, such that it is usually
40675 not worthwhile to include them in the configuration.
40676 .next
40677 Users who wish to use &_.forward_& would have to make their home directory and
40678 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40679 and their equivalents in Exim filters, cannot be used. While they could be
40680 enabled in the Exim user's name, that would be insecure and not very useful.
40681 .next
40682 Unless the local user mailboxes are all owned by the Exim user (possible in
40683 some POP3 or IMAP-only environments):
40684
40685 .olist
40686 They must be owned by the Exim group and be writeable by that group. This
40687 implies you must set &%mode%& in the appendfile configuration, as well as the
40688 mode of the mailbox files themselves.
40689 .next
40690 You must set &%no_check_owner%&, since most or all of the files will not be
40691 owned by the Exim user.
40692 .next
40693 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40694 on a newly created mailbox when unprivileged. This also implies that new
40695 mailboxes need to be created manually.
40696 .endlist olist
40697 .endlist ilist
40698
40699
40700 These restrictions severely restrict what can be done in local deliveries.
40701 However, there are no restrictions on remote deliveries. If you are running a
40702 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40703 gives more security at essentially no cost.
40704
40705 If you are using the &%mua_wrapper%& facility (see chapter
40706 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40707
40708
40709
40710
40711 .section "Delivering to local files" "SECID271"
40712 Full details of the checks applied by &(appendfile)& before it writes to a file
40713 are given in chapter &<<CHAPappendfile>>&.
40714
40715
40716
40717 .section "Running local commands" "SECTsecconslocalcmds"
40718 .cindex "security" "local commands"
40719 .cindex "security" "command injection attacks"
40720 There are a number of ways in which an administrator can configure Exim to run
40721 commands based upon received, untrustworthy, data. Further, in some
40722 configurations a user who can control a &_.forward_& file can also arrange to
40723 run commands. Configuration to check includes, but is not limited to:
40724
40725 .ilist
40726 Use of &%use_shell%& in the pipe transport: various forms of shell command
40727 injection may be possible with this option present. It is dangerous and should
40728 be used only with considerable caution. Consider constraints which whitelist
40729 allowed characters in a variable which is to be used in a pipe transport that
40730 has &%use_shell%& enabled.
40731 .next
40732 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40733 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40734 &_.forward_& files in a redirect router. If Exim is running on a central mail
40735 hub to which ordinary users do not have shell access, but home directories are
40736 NFS mounted (for instance) then administrators should review the list of these
40737 forbid options available, and should bear in mind that the options that may
40738 need forbidding can change as new features are added between releases.
40739 .next
40740 The &%${run...}%& expansion item does not use a shell by default, but
40741 administrators can configure use of &_/bin/sh_& as part of the command.
40742 Such invocations should be viewed with prejudicial suspicion.
40743 .next
40744 Administrators who use embedded Perl are advised to explore how Perl's
40745 taint checking might apply to their usage.
40746 .next
40747 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40748 administrators are well advised to view its use with suspicion, in case (for
40749 instance) it allows a local-part to contain embedded Exim directives.
40750 .next
40751 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40752 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40753 each can reference arbitrary lists and files, rather than just being a list
40754 of opaque strings.
40755 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40756 real-world security vulnerabilities caused by its use with untrustworthy data
40757 injected in, for SQL injection attacks.
40758 Consider the use of the &%inlisti%& expansion condition instead.
40759 .endlist
40760
40761
40762
40763
40764 .section "Trust in configuration data" "SECTsecconfdata"
40765 .cindex "security" "data sources"
40766 .cindex "security" "regular expressions"
40767 .cindex "regular expressions" "security"
40768 .cindex "PCRE2" "security"
40769 If configuration data for Exim can come from untrustworthy sources, there
40770 are some issues to be aware of:
40771
40772 .ilist
40773 Use of &%${expand...}%& may provide a path for shell injection attacks.
40774 .next
40775 Letting untrusted data provide a regular expression is unwise.
40776 .next
40777 Using &%${match...}%& to apply a fixed regular expression against untrusted
40778 data may result in pathological behaviour within PCRE2.  Be aware of what
40779 "backtracking" means and consider options for being more strict with a regular
40780 expression. Avenues to explore include limiting what can match (avoiding &`.`&
40781 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
40782 possessive quantifiers or just not using regular expressions against untrusted
40783 data.
40784 .next
40785 It can be important to correctly use &%${quote:...}%&,
40786 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
40787 items to ensure that data is correctly constructed.
40788 .next
40789 Some lookups might return multiple results, even though normal usage is only
40790 expected to yield one result.
40791 .endlist
40792
40793
40794
40795
40796 .section "IPv4 source routing" "SECID272"
40797 .cindex "source routing" "in IP packets"
40798 .cindex "IP source routing"
40799 Many operating systems suppress IP source-routed packets in the kernel, but
40800 some cannot be made to do this, so Exim does its own check. It logs incoming
40801 IPv4 source-routed TCP calls, and then drops them. Things are all different in
40802 IPv6. No special checking is currently done.
40803
40804
40805
40806 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
40807 Support for these SMTP commands is disabled by default. If required, they can
40808 be enabled by defining suitable ACLs.
40809
40810
40811
40812
40813 .section "Privileged users" "SECID274"
40814 .cindex "trusted users"
40815 .cindex "admin user"
40816 .cindex "privileged user"
40817 .cindex "user" "trusted"
40818 .cindex "user" "admin"
40819 Exim recognizes two sets of users with special privileges. Trusted users are
40820 able to submit new messages to Exim locally, but supply their own sender
40821 addresses and information about a sending host. For other users submitting
40822 local messages, Exim sets up the sender address from the uid, and doesn't
40823 permit a remote host to be specified.
40824
40825 .oindex "&%-f%&"
40826 However, an untrusted user is permitted to use the &%-f%& command line option
40827 in the special form &%-f <>%& to indicate that a delivery failure for the
40828 message should not cause an error report. This affects the message's envelope,
40829 but it does not affect the &'Sender:'& header. Untrusted users may also be
40830 permitted to use specific forms of address with the &%-f%& option by setting
40831 the &%untrusted_set_sender%& option.
40832
40833 Trusted users are used to run processes that receive mail messages from some
40834 other mail domain and pass them on to Exim for delivery either locally, or over
40835 the Internet. Exim trusts a caller that is running as root, as the Exim user,
40836 as any user listed in the &%trusted_users%& configuration option, or under any
40837 group listed in the &%trusted_groups%& option.
40838
40839 Admin users are permitted to do things to the messages on Exim's queue. They
40840 can freeze or thaw messages, cause them to be returned to their senders, remove
40841 them entirely, or modify them in various ways. In addition, admin users can run
40842 the Exim monitor and see all the information it is capable of providing, which
40843 includes the contents of files on the spool.
40844
40845 .oindex "&%-M%&"
40846 .oindex "&%-q%&"
40847 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
40848 delivery of messages on its queue is restricted to admin users. This
40849 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
40850 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
40851 queue is also restricted to admin users. This restriction can be relaxed by
40852 setting &%no_queue_list_requires_admin%&.
40853
40854 Exim recognizes an admin user if the calling process is running as root or as
40855 the Exim user or if any of the groups associated with the calling process is
40856 the Exim group. It is not necessary actually to be running under the Exim
40857 group. However, if admin users who are not root or the Exim user are to access
40858 the contents of files on the spool via the Exim monitor (which runs
40859 unprivileged), Exim must be built to allow group read access to its spool
40860 files.
40861
40862 By default, regular users are trusted to perform basic testing and
40863 introspection commands, as themselves.  This setting can be tightened by
40864 setting the &%commandline_checks_require_admin%& option.
40865 This affects most of the checking options,
40866 such as &%-be%& and anything else &%-b*%&.
40867
40868
40869 .section "Spool files" "SECID275"
40870 .cindex "spool directory" "files"
40871 Exim's spool directory and everything it contains is owned by the Exim user and
40872 set to the Exim group. The mode for spool files is defined in the
40873 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
40874 any user who is a member of the Exim group can access these files.
40875
40876
40877
40878 .section "Use of argv[0]" "SECID276"
40879 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
40880 of specific strings, Exim assumes certain options. For example, calling Exim
40881 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
40882 to calling it with the option &%-bS%&. There are no security implications in
40883 this.
40884
40885
40886
40887 .section "Use of %f formatting" "SECID277"
40888 The only use made of &"%f"& by Exim is in formatting load average values. These
40889 are actually stored in integer variables as 1000 times the load average.
40890 Consequently, their range is limited and so therefore is the length of the
40891 converted output.
40892
40893
40894
40895 .section "Embedded Exim path" "SECID278"
40896 Exim uses its own path name, which is embedded in the code, only when it needs
40897 to re-exec in order to regain root privilege. Therefore, it is not root when it
40898 does so. If some bug allowed the path to get overwritten, it would lead to an
40899 arbitrary program's being run as exim, not as root.
40900
40901
40902
40903 .section "Dynamic module directory" "SECTdynmoddir"
40904 Any dynamically loadable modules must be installed into the directory
40905 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
40906 loading it.
40907
40908
40909 .section "Use of sprintf()" "SECID279"
40910 .cindex "&[sprintf()]&"
40911 A large number of occurrences of &"sprintf"& in the code are actually calls to
40912 &'string_sprintf()'&, a function that returns the result in malloc'd store.
40913 The intermediate formatting is done into a large fixed buffer by a function
40914 that runs through the format string itself, and checks the length of each
40915 conversion before performing it, thus preventing buffer overruns.
40916
40917 The remaining uses of &[sprintf()]& happen in controlled circumstances where
40918 the output buffer is known to be sufficiently long to contain the converted
40919 string.
40920
40921
40922
40923 .section "Use of debug_printf() and log_write()" "SECID280"
40924 Arbitrary strings are passed to both these functions, but they do their
40925 formatting by calling the function &'string_vformat()'&, which runs through
40926 the format string itself, and checks the length of each conversion.
40927
40928
40929
40930 .section "Use of strcat() and strcpy()" "SECID281"
40931 These are used only in cases where the output buffer is known to be large
40932 enough to hold the result.
40933 .ecindex IIDsecurcon
40934
40935
40936
40937
40938 . ////////////////////////////////////////////////////////////////////////////
40939 . ////////////////////////////////////////////////////////////////////////////
40940
40941 .chapter "Format of spool files" "CHAPspool"
40942 .scindex IIDforspo1 "format" "spool files"
40943 .scindex IIDforspo2 "spool directory" "format of files"
40944 .scindex IIDforspo3 "spool files" "format of"
40945 .cindex "spool files" "editing"
40946 A message on Exim's queue consists of two files, whose names are the message id
40947 followed by -D and -H, respectively. The data portion of the message is kept in
40948 the -D file on its own. The message's envelope, status, and headers are all
40949 kept in the -H file, whose format is described in this chapter. Each of these
40950 two files contains the final component of its own name as its first line. This
40951 is insurance against disk crashes where the directory is lost but the files
40952 themselves are recoverable.
40953
40954 The file formats may be changed, or new formats added, at any release.
40955 Spool files are not intended as an interface to other programs
40956 and should not be used as such.
40957
40958 Some people are tempted into editing -D files in order to modify messages. You
40959 need to be extremely careful if you do this; it is not recommended and you are
40960 on your own if you do it. Here are some of the pitfalls:
40961
40962 .ilist
40963 You must ensure that Exim does not try to deliver the message while you are
40964 fiddling with it. The safest way is to take out a write lock on the -D file,
40965 which is what Exim itself does, using &[fcntl()]&. If you update the file in
40966 place, the lock will be retained. If you write a new file and rename it, the
40967 lock will be lost at the instant of rename.
40968 .next
40969 .vindex "&$body_linecount$&"
40970 If you change the number of lines in the file, the value of
40971 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
40972 cause incomplete transmission of messages or undeliverable messages.
40973 .next
40974 If the message is in MIME format, you must take care not to break it.
40975 .next
40976 If the message is cryptographically signed, any change will invalidate the
40977 signature.
40978 .endlist
40979 All in all, modifying -D files is fraught with danger.
40980
40981 Files whose names end with -J may also be seen in the &_input_& directory (or
40982 its subdirectories when &%split_spool_directory%& is set). These are journal
40983 files, used to record addresses to which the message has been delivered during
40984 the course of a delivery attempt. If there are still undelivered recipients at
40985 the end, the -H file is updated, and the -J file is deleted. If, however, there
40986 is some kind of crash (for example, a power outage) before this happens, the -J
40987 file remains in existence. When Exim next processes the message, it notices the
40988 -J file and uses it to update the -H file before starting the next delivery
40989 attempt.
40990
40991 Files whose names end with -K or .eml may also be seen in the spool.
40992 These are temporaries used for DKIM or malware processing, when that is used.
40993 They should be tidied up by normal operations; any old ones are probably
40994 relics of crashes and can be removed.
40995
40996 .section "Format of the -H file" "SECID282"
40997 .cindex "uid (user id)" "in spool file"
40998 .cindex "gid (group id)" "in spool file"
40999 The second line of the -H file contains the login name for the uid of the
41000 process that called Exim to read the message, followed by the numerical uid and
41001 gid. For a locally generated message, this is normally the user who sent the
41002 message. For a message received over TCP/IP via the daemon, it is
41003 normally the Exim user.
41004
41005 The third line of the file contains the address of the message's sender as
41006 transmitted in the envelope, contained in angle brackets. The sender address is
41007 empty for bounce messages. For incoming SMTP mail, the sender address is given
41008 in the MAIL command. For locally generated mail, the sender address is
41009 created by Exim from the login name of the current user and the configured
41010 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
41011 leading &"From&~"& line if the caller is trusted, or if the supplied address is
41012 &"<>"& or an address that matches &%untrusted_set_senders%&.
41013
41014 The fourth line contains two numbers. The first is the time that the message
41015 was received, in the conventional Unix form &-- the number of seconds since the
41016 start of the epoch. The second number is a count of the number of messages
41017 warning of delayed delivery that have been sent to the sender.
41018
41019 There follow a number of lines starting with a hyphen.
41020 These contain variables, can appear in any
41021 order, and are omitted when not relevant.
41022
41023 If there is a second hyphen after the first,
41024 the corresponding data is tainted.
41025 If there is a value in parentheses, the data is quoted for a lookup.
41026
41027 The following word specifies a variable,
41028 and the remainder of the item depends on the variable.
41029
41030 .vlist
41031 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
41032 This item is obsolete, and is not generated from Exim release 4.61 onwards;
41033 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
41034 recognized, to provide backward compatibility. In the old format, a line of
41035 this form is present for every ACL variable that is not empty. The number
41036 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
41037 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
41038 the data string for the variable. The string itself starts at the beginning of
41039 the next line, and is followed by a newline character. It may contain internal
41040 newlines.
41041
41042 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
41043 A line of this form is present for every ACL connection variable that is
41044 defined. Note that there is a space between &%-aclc%& and the rest of the name.
41045 The length is the length of the data string for the variable. The string itself
41046 starts at the beginning of the next line, and is followed by a newline
41047 character. It may contain internal newlines.
41048
41049 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
41050 A line of this form is present for every ACL message variable that is defined.
41051 Note that there is a space between &%-aclm%& and the rest of the name. The
41052 length is the length of the data string for the variable. The string itself
41053 starts at the beginning of the next line, and is followed by a newline
41054 character. It may contain internal newlines.
41055
41056 .vitem "&%-active_hostname%&&~<&'hostname'&>"
41057 This is present if, when the message was received over SMTP, the value of
41058 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
41059
41060 .vitem &%-allow_unqualified_recipient%&
41061 This is present if unqualified recipient addresses are permitted in header
41062 lines (to stop such addresses from being qualified if rewriting occurs at
41063 transport time). Local messages that were input using &%-bnq%& and remote
41064 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
41065
41066 .vitem &%-allow_unqualified_sender%&
41067 This is present if unqualified sender addresses are permitted in header lines
41068 (to stop such addresses from being qualified if rewriting occurs at transport
41069 time). Local messages that were input using &%-bnq%& and remote messages from
41070 hosts that match &%sender_unqualified_hosts%& set this flag.
41071
41072 .vitem "&%-auth_id%&&~<&'text'&>"
41073 The id information for a message received on an authenticated SMTP connection
41074 &-- the value of the &$authenticated_id$& variable.
41075
41076 .vitem "&%-auth_sender%&&~<&'address'&>"
41077 The address of an authenticated sender &-- the value of the
41078 &$authenticated_sender$& variable.
41079
41080 .vitem "&%-body_linecount%&&~<&'number'&>"
41081 This records the number of lines in the body of the message, and is
41082 present unless &%-spool_file_wireformat%& is.
41083
41084 .vitem "&%-body_zerocount%&&~<&'number'&>"
41085 This records the number of binary zero bytes in the body of the message, and is
41086 present if the number is greater than zero.
41087
41088 .vitem &%-deliver_firsttime%&
41089 This is written when a new message is first added to the spool. When the spool
41090 file is updated after a deferral, it is omitted.
41091
41092 .vitem "&%-frozen%&&~<&'time'&>"
41093 .cindex "frozen messages" "spool data"
41094 The message is frozen, and the freezing happened at <&'time'&>.
41095
41096 .vitem "&%-helo_name%&&~<&'text'&>"
41097 This records the host name as specified by a remote host in a HELO or EHLO
41098 command.
41099
41100 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
41101 This records the IP address of the host from which the message was received and
41102 the remote port number that was used. It is omitted for locally generated
41103 messages.
41104
41105 .vitem "&%-host_auth%&&~<&'text'&>"
41106 If the message was received on an authenticated SMTP connection, this records
41107 the name of the authenticator &-- the value of the
41108 &$sender_host_authenticated$& variable.
41109
41110 .vitem &%-host_lookup_failed%&
41111 This is present if an attempt to look up the sending host's name from its IP
41112 address failed. It corresponds to the &$host_lookup_failed$& variable.
41113
41114 .vitem "&%-host_name%&&~<&'text'&>"
41115 .cindex "reverse DNS lookup"
41116 .cindex "DNS" "reverse lookup"
41117 This records the name of the remote host from which the message was received,
41118 if the host name was looked up from the IP address when the message was being
41119 received. It is not present if no reverse lookup was done.
41120
41121 .vitem "&%-ident%&&~<&'text'&>"
41122 For locally submitted messages, this records the login of the originating user,
41123 unless it was a trusted user and the &%-oMt%& option was used to specify an
41124 ident value. For messages received over TCP/IP, this records the ident string
41125 supplied by the remote host, if any.
41126
41127 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
41128 This records the IP address of the local interface and the port number through
41129 which a message was received from a remote host. It is omitted for locally
41130 generated messages.
41131
41132 .vitem &%-local%&
41133 The message is from a local sender.
41134
41135 .vitem &%-localerror%&
41136 The message is a locally-generated bounce message.
41137
41138 .vitem "&%-local_scan%&&~<&'string'&>"
41139 This records the data string that was returned by the &[local_scan()]& function
41140 when the message was received &-- the value of the &$local_scan_data$&
41141 variable. It is omitted if no data was returned.
41142
41143 .vitem &%-manual_thaw%&
41144 The message was frozen but has been thawed manually, that is, by an explicit
41145 Exim command rather than via the auto-thaw process.
41146
41147 .vitem &%-N%&
41148 A testing delivery process was started using the &%-N%& option to suppress any
41149 actual deliveries, but delivery was deferred. At any further delivery attempts,
41150 &%-N%& is assumed.
41151
41152 .vitem &%-received_protocol%&
41153 This records the value of the &$received_protocol$& variable, which contains
41154 the name of the protocol by which the message was received.
41155
41156 .vitem &%-sender_set_untrusted%&
41157 The envelope sender of this message was set by an untrusted local caller (used
41158 to ensure that the caller is displayed in queue listings).
41159
41160 .vitem "&%-spam_score_int%&&~<&'number'&>"
41161 If a message was scanned by SpamAssassin, this is present. It records the value
41162 of &$spam_score_int$&.
41163
41164 .vitem &%-spool_file_wireformat%&
41165 The -D file for this message is in wire-format (for ESMTP CHUNKING)
41166 rather than Unix-format.
41167 The line-ending is CRLF rather than newline.
41168 There is still, however, no leading-dot-stuffing.
41169
41170 .vitem &%-tls_certificate_verified%&
41171 A TLS certificate was received from the client that sent this message, and the
41172 certificate was verified by the server.
41173
41174 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
41175 When the message was received over an encrypted connection, this records the
41176 name of the cipher suite that was used.
41177
41178 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
41179 When the message was received over an encrypted connection, and a certificate
41180 was received from the client, this records the Distinguished Name from that
41181 certificate.
41182 .endlist
41183
41184 Following the options there is a list of those addresses to which the message
41185 is not to be delivered. This set of addresses is initialized from the command
41186 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
41187 is set; otherwise it starts out empty. Whenever a successful delivery is made,
41188 the address is added to this set. The addresses are kept internally as a
41189 balanced binary tree, and it is a representation of that tree which is written
41190 to the spool file. If an address is expanded via an alias or forward file, the
41191 original address is added to the tree when deliveries to all its child
41192 addresses are complete.
41193
41194 If the tree is empty, there is a single line in the spool file containing just
41195 the text &"XX"&. Otherwise, each line consists of two letters, which are either
41196 Y or N, followed by an address. The address is the value for the node of the
41197 tree, and the letters indicate whether the node has a left branch and/or a
41198 right branch attached to it, respectively. If branches exist, they immediately
41199 follow. Here is an example of a three-node tree:
41200 .code
41201 YY darcy@austen.fict.example
41202 NN alice@wonderland.fict.example
41203 NN editor@thesaurus.ref.example
41204 .endd
41205 After the non-recipients tree, there is a list of the message's recipients.
41206 This is a simple list, preceded by a count. It includes all the original
41207 recipients of the message, including those to whom the message has already been
41208 delivered. In the simplest case, the list contains one address per line. For
41209 example:
41210 .code
41211 4
41212 editor@thesaurus.ref.example
41213 darcy@austen.fict.example
41214 rdo@foundation
41215 alice@wonderland.fict.example
41216 .endd
41217 However, when a child address has been added to the top-level addresses as a
41218 result of the use of the &%one_time%& option on a &(redirect)& router, each
41219 line is of the following form:
41220 .display
41221 <&'top-level address'&> <&'errors_to address'&> &&&
41222   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
41223 .endd
41224 The 01 flag bit indicates the presence of the three other fields that follow
41225 the top-level address. Other bits may be used in future to support additional
41226 fields. The <&'parent number'&> is the offset in the recipients list of the
41227 original parent of the &"one time"& address. The first two fields are the
41228 envelope sender that is associated with this address and its length. If the
41229 length is zero, there is no special envelope sender (there are then two space
41230 characters in the line). A non-empty field can arise from a &(redirect)& router
41231 that has an &%errors_to%& setting.
41232
41233
41234 A blank line separates the envelope and status information from the headers
41235 which follow. A header may occupy several lines of the file, and to save effort
41236 when reading it in, each header is preceded by a number and an identifying
41237 character. The number is the number of characters in the header, including any
41238 embedded newlines and the terminating newline. The character is one of the
41239 following:
41240
41241 .table2 50pt
41242 .row <&'blank'&>         "header in which Exim has no special interest"
41243 .row &`B`&               "&'Bcc:'& header"
41244 .row &`C`&               "&'Cc:'& header"
41245 .row &`F`&               "&'From:'& header"
41246 .row &`I`&               "&'Message-id:'& header"
41247 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
41248 .row &`R`&               "&'Reply-To:'& header"
41249 .row &`S`&               "&'Sender:'& header"
41250 .row &`T`&               "&'To:'& header"
41251 .row &`*`&               "replaced or deleted header"
41252 .endtable
41253
41254 Deleted or replaced (rewritten) headers remain in the spool file for debugging
41255 purposes. They are not transmitted when the message is delivered. Here is a
41256 typical set of headers:
41257 .code
41258 111P Received: by hobbit.fict.example with local (Exim 4.00)
41259 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
41260 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
41261 038* X-rewrote-sender: bb@hobbit.fict.example
41262 042* From: Bilbo Baggins <bb@hobbit.fict.example>
41263 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
41264 099* To: alice@wonderland.fict.example, rdo@foundation,
41265 darcy@austen.fict.example, editor@thesaurus.ref.example
41266 104T To: alice@wonderland.fict.example, rdo@foundation.example,
41267 darcy@austen.fict.example, editor@thesaurus.ref.example
41268 038  Date: Fri, 11 May 2001 10:28:59 +0100
41269 .endd
41270 The asterisked headers indicate that the envelope sender, &'From:'& header, and
41271 &'To:'& header have been rewritten, the last one because routing expanded the
41272 unqualified domain &'foundation'&.
41273 .ecindex IIDforspo1
41274 .ecindex IIDforspo2
41275 .ecindex IIDforspo3
41276
41277 .section "Format of the -D file" "SECID282a"
41278 The data file is traditionally in Unix-standard format: lines are ended with
41279 an ASCII newline character.
41280 However, when the &%spool_wireformat%& main option is used some -D files
41281 can have an alternate format.
41282 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
41283 The -D file lines (not including the first name-component line) are
41284 suitable for direct copying to the wire when transmitting using the
41285 ESMTP CHUNKING option, meaning lower processing overhead.
41286 Lines are terminated with an ASCII CRLF pair.
41287 There is no dot-stuffing (and no dot-termination).
41288
41289 . ////////////////////////////////////////////////////////////////////////////
41290 . ////////////////////////////////////////////////////////////////////////////
41291
41292 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
41293          "DKIM, SPF, SRS and DMARC Support"
41294
41295 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
41296 .cindex "DKIM"
41297
41298 DKIM is a mechanism by which messages sent by some entity can be provably
41299 linked to a domain which that entity controls.  It permits reputation to
41300 be tracked on a per-domain basis, rather than merely upon source IP address.
41301 DKIM is documented in RFC 6376.
41302
41303 As DKIM relies on the message being unchanged in transit, messages handled
41304 by a mailing-list (which traditionally adds to the message) will not match
41305 any original DKIM signature.
41306
41307 DKIM support is compiled into Exim by default if TLS support is present.
41308 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
41309
41310 Exim's DKIM implementation allows for
41311 .olist
41312 Signing outgoing messages: This function is implemented in the SMTP transport.
41313 It can co-exist with all other Exim features
41314 (including transport filters)
41315 except cutthrough delivery.
41316 .next
41317 Verifying signatures in incoming messages: This is implemented by an additional
41318 ACL (acl_smtp_dkim), which can be called several times per message, with
41319 different signature contexts.
41320 .endlist
41321
41322 In typical Exim style, the verification implementation does not include any
41323 default "policy". Instead it enables you to build your own policy using
41324 Exim's standard controls.
41325
41326 Please note that verification of DKIM signatures in incoming mail is turned
41327 on by default for logging (in the <= line) purposes.
41328
41329 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
41330 When set, for each signature in incoming email,
41331 exim will log a line displaying the most important signature details, and the
41332 signature status. Here is an example (with line-breaks added for clarity):
41333 .code
41334 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
41335     d=facebookmail.com s=q1-2009b
41336     c=relaxed/relaxed a=rsa-sha1
41337     i=@facebookmail.com t=1252484542 [verification succeeded]
41338 .endd
41339
41340 You might want to turn off DKIM verification processing entirely for internal
41341 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41342 control modifier. This should typically be done in the RCPT ACL, at points
41343 where you accept mail from relay sources (internal hosts or authenticated
41344 senders).
41345
41346
41347 .subsection "Signing outgoing messages" SECDKIMSIGN
41348 .cindex DKIM signing
41349
41350 For signing to be usable you must have published a DKIM record in DNS.
41351 Note that RFC 8301 (which does not cover EC keys) says:
41352 .code
41353 rsa-sha1 MUST NOT be used for signing or verifying.
41354
41355 Signers MUST use RSA keys of at least 1024 bits for all keys.
41356 Signers SHOULD use RSA keys of at least 2048 bits.
41357 .endd
41358
41359 Note also that the key content (the 'p=' field)
41360 in the DNS record is different between RSA and EC keys;
41361 for the former it is the base64 of the ASN.1 for the RSA public key
41362 (equivalent to the private-key .pem with the header/trailer stripped)
41363 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41364
41365 Signing is enabled by setting private options on the SMTP transport.
41366 These options take (expandable) strings as arguments.
41367
41368 .option dkim_domain smtp "string list&!!" unset
41369 The domain(s) you want to sign with.
41370 After expansion, this can be a list.
41371 Each element in turn,
41372 lowercased,
41373 .vindex "&$dkim_domain$&"
41374 is put into the &%$dkim_domain%& expansion variable
41375 while expanding the remaining signing options.
41376 If it is empty after expansion, DKIM signing is not done,
41377 and no error will result even if &%dkim_strict%& is set.
41378
41379 .option dkim_selector smtp "string list&!!" unset
41380 This sets the key selector string.
41381 After expansion, which can use &$dkim_domain$&, this can be a list.
41382 Each element in turn is put in the expansion
41383 .vindex "&$dkim_selector$&"
41384 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41385 option along with &%$dkim_domain%&.
41386 If the option is empty after expansion, DKIM signing is not done for this domain,
41387 and no error will result even if &%dkim_strict%& is set.
41388
41389 To do, for example, dual-signing with RSA and EC keys
41390 this could be be used:
41391 .code
41392 dkim_selector = ec_sel : rsa_sel
41393 dkim_private_key = KEYS_DIR/$dkim_selector
41394 .endd
41395
41396 .option dkim_private_key smtp string&!! unset
41397 This sets the private key to use.
41398 You can use the &%$dkim_domain%& and
41399 &%$dkim_selector%& expansion variables to determine the private key to use.
41400 The result can either
41401 .ilist
41402 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41403 .next
41404 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41405 be a valid Ed25519 private key (same format as above)
41406 .next
41407 start with a slash, in which case it is treated as a file that contains
41408 the private key
41409 .next
41410 be "0", "false" or the empty string, in which case the message will not
41411 be signed. This case will not result in an error, even if &%dkim_strict%&
41412 is set.
41413 .endlist
41414
41415 To generate keys under OpenSSL:
41416 .code
41417 openssl genrsa -out dkim_rsa.private 2048
41418 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41419 .endd
41420 The result file from the first command should be retained, and
41421 this option set to use it.
41422 Take the base-64 lines from the output of the second command, concatenated,
41423 for the DNS TXT record.
41424 See section 3.6 of RFC6376 for the record specification.
41425
41426 Under GnuTLS:
41427 .code
41428 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41429 certtool --load-privkey=dkim_rsa.private --pubkey-info
41430 .endd
41431
41432 Note that RFC 8301 says:
41433 .code
41434 Signers MUST use RSA keys of at least 1024 bits for all keys.
41435 Signers SHOULD use RSA keys of at least 2048 bits.
41436 .endd
41437
41438 EC keys for DKIM are defined by RFC 8463.
41439 They are considerably smaller than RSA keys for equivalent protection.
41440 As they are a recent development, users should consider dual-signing
41441 (by setting a list of selectors, and an expansion for this option)
41442 for some transition period.
41443 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41444 for EC keys.
41445
41446 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41447 .code
41448 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41449 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41450 .endd
41451
41452 To produce the required public key value for a DNS record:
41453 .code
41454 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41455 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41456 .endd
41457
41458 Exim also supports an alternate format
41459 of Ed25519 keys in DNS which was a candidate during development
41460 of the standard, but not adopted.
41461 A future release will probably drop that support.
41462
41463 .option dkim_hash smtp string&!! sha256
41464 Can be set to any one of the supported hash methods, which are:
41465 .ilist
41466 &`sha1`& &-- should not be used, is old and insecure
41467 .next
41468 &`sha256`& &-- the default
41469 .next
41470 &`sha512`& &-- possibly more secure but less well supported
41471 .endlist
41472
41473 Note that RFC 8301 says:
41474 .code
41475 rsa-sha1 MUST NOT be used for signing or verifying.
41476 .endd
41477
41478 .option dkim_identity smtp string&!! unset
41479 If set after expansion, the value is used to set an "i=" tag in
41480 the signing header.  The DKIM standards restrict the permissible
41481 syntax of this optional tag to a mail address, with possibly-empty
41482 local part, an @, and a domain identical to or subdomain of the "d="
41483 tag value.  Note that Exim does not check the value.
41484
41485 .option dkim_canon smtp string&!! unset
41486 This option sets the canonicalization method used when signing a message.
41487 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41488 The option defaults to "relaxed" when unset. Note: the current implementation
41489 only supports signing with the same canonicalization method for both headers and body.
41490
41491 .option dkim_strict smtp string&!! unset
41492 This  option  defines  how  Exim  behaves  when  signing a message that
41493 should be signed fails for some reason.  When the expansion evaluates to
41494 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41495 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41496 variables here.
41497
41498 .option dkim_sign_headers smtp string&!! "see below"
41499 If set, this option must expand to a colon-separated
41500 list of header names.
41501 Headers with these names, or the absence or such a header, will be included
41502 in the message signature.
41503 When unspecified, the header names listed in RFC4871 will be used,
41504 whether or not each header is present in the message.
41505 The default list is available for the expansion in the macro
41506 &"_DKIM_SIGN_HEADERS"&
41507 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41508
41509 If a name is repeated, multiple headers by that name (or the absence thereof)
41510 will be signed.  The textually later headers in the headers part of the
41511 message are signed first, if there are multiples.
41512
41513 A name can be prefixed with either an &"="& or a &"+"& character.
41514 If an &"="& prefix is used, all headers that are present with this name
41515 will be signed.
41516 If a &"+"& prefix if used, all headers that are present with this name
41517 will be signed, and one signature added for a missing header with the
41518 name will be appended.
41519
41520 .option dkim_timestamps smtp integer&!! unset
41521 This option controls the inclusion of timestamp information in the signature.
41522 If not set, no such information will be included.
41523 Otherwise, must be an unsigned number giving an offset in seconds from the current time
41524 for the expiry tag
41525 (eg. 1209600 for two weeks);
41526 both creation (t=) and expiry (x=) tags will be included.
41527
41528 RFC 6376 lists these tags as RECOMMENDED.
41529
41530
41531 .subsection "Verifying DKIM signatures in incoming mail" SECDKIMVFY
41532 .cindex DKIM verification
41533
41534 Verification of DKIM signatures in SMTP incoming email is done for all
41535 messages for which an ACL control &%dkim_disable_verify%& has not been set.
41536 .cindex DKIM "selecting signature algorithms"
41537 Individual classes of signature algorithm can be ignored by changing
41538 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
41539 The &%dkim_verify_minimal%& option can be set to cease verification
41540 processing for a message once the first passing signature is found.
41541
41542 .cindex authentication "expansion item"
41543 Performing verification sets up information used by the
41544 &%authresults%& expansion item.
41545
41546 For most purposes the default option settings suffice and the remainder
41547 of this section can be ignored.
41548
41549 The results of verification are made available to the
41550 &%acl_smtp_dkim%& ACL, which can examine and modify them.
41551 A missing ACL definition defaults to accept.
41552 By default, the ACL is called once for each
41553 syntactically(!) correct signature in the incoming message.
41554 If any ACL call does not accept, the message is not accepted.
41555 If a cutthrough delivery was in progress for the message, that is
41556 summarily dropped (having wasted the transmission effort).
41557
41558 To evaluate the verification result in the ACL
41559 a large number of expansion variables
41560 containing the signature status and its details are set up during the
41561 runtime of the ACL.
41562
41563 Calling the ACL only for existing signatures is not sufficient to build
41564 more advanced policies. For that reason, the main option
41565 &%dkim_verify_signers%&, and an expansion variable
41566 &%$dkim_signers%& exist.
41567
41568 The main option &%dkim_verify_signers%& can be set to a colon-separated
41569 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
41570 called. It is expanded when the message has been received. At this point,
41571 the expansion variable &%$dkim_signers%& already contains a colon-separated
41572 list of signer domains and identities for the message. When
41573 &%dkim_verify_signers%& is not specified in the main configuration,
41574 it defaults as:
41575 .code
41576 dkim_verify_signers = $dkim_signers
41577 .endd
41578 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
41579 DKIM signature in the message. Current DKIM verifiers may want to explicitly
41580 call the ACL for known domains or identities. This would be achieved as follows:
41581 .code
41582 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
41583 .endd
41584 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
41585 and "ebay.com", plus all domains and identities that have signatures in the message.
41586 You can also be more creative in constructing your policy. For example:
41587 .code
41588 dkim_verify_signers = $sender_address_domain:$dkim_signers
41589 .endd
41590
41591 If a domain or identity is listed several times in the (expanded) value of
41592 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
41593
41594 Note that if the option is set using untrustworthy data
41595 (such as the From: header)
41596 care should be taken to force lowercase for domains
41597 and for the domain part if identities.
41598 The default setting can be regarded as trustworthy in this respect.
41599
41600 If multiple signatures match a domain (or identity), the ACL is called once
41601 for each matching signature.
41602
41603
41604 Inside the DKIM ACL, the following expansion variables are
41605 available (from most to least important):
41606
41607
41608 .vlist
41609 .vitem &%$dkim_cur_signer%&
41610 The signer that is being evaluated in this ACL run. This can be a domain or
41611 an identity. This is one of the list items from the expanded main option
41612 &%dkim_verify_signers%& (see above).
41613
41614 .vitem &%$dkim_verify_status%&
41615 Within the DKIM ACL,
41616 a string describing the general status of the signature. One of
41617 .ilist
41618 &%none%&: There is no signature in the message for the current domain or
41619 identity (as reflected by &%$dkim_cur_signer%&).
41620 .next
41621 &%invalid%&: The signature could not be verified due to a processing error.
41622 More detail is available in &%$dkim_verify_reason%&.
41623 .next
41624 &%fail%&: Verification of the signature failed.  More detail is
41625 available in &%$dkim_verify_reason%&.
41626 .next
41627 &%pass%&: The signature passed verification. It is valid.
41628 .endlist
41629
41630 This variable can be overwritten using an ACL 'set' modifier.
41631 This might, for instance, be done to enforce a policy restriction on
41632 hash-method or key-size:
41633 .code
41634   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41635        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41636        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41637                                   {< {$dkim_key_length}{1024}}}}
41638        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41639        set dkim_verify_status = fail
41640        set dkim_verify_reason = hash too weak or key too short
41641 .endd
41642
41643 So long as a DKIM ACL is defined (it need do no more than accept),
41644 after all the DKIM ACL runs have completed, the value becomes a
41645 colon-separated list of the values after each run.
41646 This is maintained for the mime, prdr and data ACLs.
41647
41648 .vitem &%$dkim_verify_reason%&
41649 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41650 "fail" or "invalid". One of
41651 .ilist
41652 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41653 key for the domain could not be retrieved. This may be a temporary problem.
41654 .next
41655 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41656 record for the domain is syntactically invalid.
41657 .next
41658 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41659 body hash does not match the one specified in the signature header. This
41660 means that the message body was modified in transit.
41661 .next
41662 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41663 could not be verified. This may mean that headers were modified,
41664 re-written or otherwise changed in a way which is incompatible with
41665 DKIM verification. It may of course also mean that the signature is forged.
41666 .endlist
41667
41668 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41669
41670 .vitem &%$dkim_domain%&
41671 The signing domain. IMPORTANT: This variable is only populated if there is
41672 an actual signature in the message for the current domain or identity (as
41673 reflected by &%$dkim_cur_signer%&).
41674
41675 .vitem &%$dkim_identity%&
41676 The signing identity, if present. IMPORTANT: This variable is only populated
41677 if there is an actual signature in the message for the current domain or
41678 identity (as reflected by &%$dkim_cur_signer%&).
41679
41680 .vitem &%$dkim_selector%&
41681 The key record selector string.
41682
41683 .vitem &%$dkim_algo%&
41684 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41685 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41686 may also be 'ed25519-sha256'.
41687 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41688 for EC keys.
41689
41690 Note that RFC 8301 says:
41691 .code
41692 rsa-sha1 MUST NOT be used for signing or verifying.
41693
41694 DKIM signatures identified as having been signed with historic
41695 algorithms (currently, rsa-sha1) have permanently failed evaluation
41696 .endd
41697
41698 To enforce this you must either have a DKIM ACL which checks this variable
41699 and overwrites the &$dkim_verify_status$& variable as discussed above,
41700 or have set the main option &%dkim_verify_hashes%& to exclude
41701 processing of such signatures.
41702
41703 .vitem &%$dkim_canon_body%&
41704 The body canonicalization method. One of 'relaxed' or 'simple'.
41705
41706 .vitem &%$dkim_canon_headers%&
41707 The header canonicalization method. One of 'relaxed' or 'simple'.
41708
41709 .vitem &%$dkim_copiedheaders%&
41710 A transcript of headers and their values which are included in the signature
41711 (copied from the 'z=' tag of the signature).
41712 Note that RFC6376 requires that verification fail if the From: header is
41713 not included in the signature.  Exim does not enforce this; sites wishing
41714 strict enforcement should code the check explicitly.
41715
41716 .vitem &%$dkim_bodylength%&
41717 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41718 limit was set by the signer, "9999999999999" is returned. This makes sure
41719 that this variable always expands to an integer value.
41720 &*Note:*& The presence of the signature tag specifying a signing body length
41721 is one possible route to spoofing of valid DKIM signatures.
41722 A paranoid implementation might wish to regard signature where this variable
41723 shows less than the "no limit" return as being invalid.
41724
41725 .vitem &%$dkim_created%&
41726 UNIX timestamp reflecting the date and time when the signature was created.
41727 When this was not specified by the signer, "0" is returned.
41728
41729 .vitem &%$dkim_expires%&
41730 UNIX timestamp reflecting the date and time when the signer wants the
41731 signature to be treated as "expired". When this was not specified by the
41732 signer, "9999999999999" is returned. This makes it possible to do useful
41733 integer size comparisons against this value.
41734 Note that Exim does not check this value.
41735
41736 .vitem &%$dkim_headernames%&
41737 A colon-separated list of names of headers included in the signature.
41738
41739 .vitem &%$dkim_key_testing%&
41740 "1" if the key record has the "testing" flag set, "0" if not.
41741
41742 .vitem &%$dkim_key_nosubdomains%&
41743 "1" if the key record forbids subdomaining, "0" otherwise.
41744
41745 .vitem &%$dkim_key_srvtype%&
41746 Service type (tag s=) from the key record. Defaults to "*" if not specified
41747 in the key record.
41748
41749 .vitem &%$dkim_key_granularity%&
41750 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41751 in the key record.
41752
41753 .vitem &%$dkim_key_notes%&
41754 Notes from the key record (tag n=).
41755
41756 .vitem &%$dkim_key_length%&
41757 Number of bits in the key.
41758 Valid only once the key is loaded, which is at the time the header signature
41759 is verified, which is after the body hash is.
41760
41761 Note that RFC 8301 says:
41762 .code
41763 Verifiers MUST NOT consider signatures using RSA keys of
41764 less than 1024 bits as valid signatures.
41765 .endd
41766
41767 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
41768 option.
41769
41770 .endlist
41771
41772 In addition, two ACL conditions are provided:
41773
41774 .vlist
41775 .vitem &%dkim_signers%&
41776 ACL condition that checks a colon-separated list of domains or identities
41777 for a match against the domain or identity that the ACL is currently verifying
41778 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
41779 verb to a group of domains or identities. For example:
41780
41781 .code
41782 # Warn when Mail purportedly from GMail has no gmail signature
41783 warn sender_domains = gmail.com
41784      dkim_signers = gmail.com
41785      dkim_status = none
41786      log_message = GMail sender without gmail.com DKIM signature
41787 .endd
41788
41789 Note that the above does not check for a total lack of DKIM signing;
41790 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
41791
41792 .vitem &%dkim_status%&
41793 ACL condition that checks a colon-separated list of possible DKIM verification
41794 results against the actual result of verification. This is typically used
41795 to restrict an ACL verb to a list of verification outcomes, for example:
41796
41797 .code
41798 deny sender_domains = paypal.com:paypal.de
41799      dkim_signers = paypal.com:paypal.de
41800      dkim_status = none:invalid:fail
41801      message = Mail from Paypal with invalid/missing signature
41802 .endd
41803
41804 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
41805 see the documentation of the &%$dkim_verify_status%& expansion variable above
41806 for more information of what they mean.
41807 .endlist
41808
41809
41810
41811
41812 .section "SPF (Sender Policy Framework)" SECSPF
41813 .cindex SPF verification
41814
41815 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
41816 messages with its domain in the envelope from, documented by RFC 7208.
41817 For more information on SPF see &url(http://www.open-spf.org), a static copy of
41818 the &url(http://openspf.org).
41819 . --- 2019-10-28: still not https, open-spf.org is told to be a
41820 . --- web-archive copy of the now dead openspf.org site
41821 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
41822 . --- discussion.
41823
41824 Messages sent by a system not authorised will fail checking of such assertions.
41825 This includes retransmissions done by traditional forwarders.
41826
41827 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
41828 &_Local/Makefile_&.  The support uses the &_libspf2_& library
41829 &url(https://www.libspf2.org/).
41830 There is no Exim involvement in the transmission of messages;
41831 publishing certain DNS records is all that is required.
41832
41833 For verification, an ACL condition and an expansion lookup are provided.
41834 .cindex authentication "expansion item"
41835 Performing verification sets up information used by the
41836 &%authresults%& expansion item.
41837
41838
41839 .cindex SPF "ACL condition"
41840 .cindex ACL "spf condition"
41841 The ACL condition "spf" can be used at or after the MAIL ACL.
41842 It takes as an argument a list of strings giving the outcome of the SPF check,
41843 and will succeed for any matching outcome.
41844 Valid strings are:
41845 .vlist
41846 .vitem &%pass%&
41847 The SPF check passed, the sending host is positively verified by SPF.
41848
41849 .vitem &%fail%&
41850 The SPF check failed, the sending host is NOT allowed to send mail for the
41851 domain in the envelope-from address.
41852
41853 .vitem &%softfail%&
41854 The SPF check failed, but the queried domain can't absolutely confirm that this
41855 is a forgery.
41856
41857 .vitem &%none%&
41858 The queried domain does not publish SPF records.
41859
41860 .vitem &%neutral%&
41861 The SPF check returned a "neutral" state.  This means the queried domain has
41862 published a SPF record, but wants to allow outside servers to send mail under
41863 its domain as well.  This should be treated like "none".
41864
41865 .vitem &%permerror%&
41866 This indicates a syntax error in the SPF record of the queried domain.
41867 You may deny messages when this occurs.
41868
41869 .vitem &%temperror%&
41870 This indicates a temporary error during all processing, including Exim's
41871 SPF processing.  You may defer messages when this occurs.
41872
41873 .vitem &%invalid%&
41874 There was an error during processing of the SPF lookup
41875 .endlist
41876
41877 You can prefix each string with an exclamation mark to  invert
41878 its meaning,  for example  "!fail" will  match all  results but
41879 "fail".  The  string  list is  evaluated  left-to-right,  in a
41880 short-circuit fashion.
41881
41882 Example:
41883 .code
41884 deny spf = fail
41885      message = $sender_host_address is not allowed to send mail from \
41886                ${if def:sender_address_domain \
41887                     {$sender_address_domain}{$sender_helo_name}}.  \
41888                Please see http://www.open-spf.org/Why;\
41889                identity=${if def:sender_address_domain \
41890                              {$sender_address}{$sender_helo_name}};\
41891                ip=$sender_host_address
41892 .endd
41893
41894 Note: The above mentioned URL may not be as helpful as expected. You are
41895 encouraged to replace the link with a link to a site with more
41896 explanations.
41897
41898 When the spf condition has run, it sets up several expansion
41899 variables:
41900
41901 .cindex SPF "verification variables"
41902 .vlist
41903 .vitem &$spf_header_comment$&
41904 .vindex &$spf_header_comment$&
41905   This contains a human-readable string describing the outcome
41906   of the SPF check. You can add it to a custom header or use
41907   it for logging purposes.
41908
41909 .vitem &$spf_received$&
41910 .vindex &$spf_received$&
41911   This contains a complete Received-SPF: header (name and
41912   content) that can be added to the message. Please note that
41913   according to the SPF draft, this header must be added at the
41914   top of the header list, i.e. with
41915 .code
41916 add_header = :at_start:$spf_received
41917 .endd
41918   See section &<<SECTaddheadacl>>& for further details.
41919
41920   Note: in case of "Best-guess" (see below), the convention is
41921   to put this string in a header called X-SPF-Guess: instead.
41922
41923 .vitem &$spf_result$&
41924 .vindex &$spf_result$&
41925   This contains the outcome of the SPF check in string form,
41926   currently one of pass, fail, softfail, none, neutral, permerror,
41927   temperror, or &"(invalid)"&.
41928
41929 .vitem &$spf_result_guessed$&
41930 .vindex &$spf_result_guessed$&
41931   This boolean is true only if a best-guess operation was used
41932   and required in order to obtain a result.
41933
41934 .vitem &$spf_smtp_comment$&
41935 .vindex &$spf_smtp_comment$&
41936 .vindex &%spf_smtp_comment_template%&
41937   This contains a string that can be used in a SMTP response
41938   to the calling party. Useful for "fail".
41939   The string is generated by the SPF library from the template configured in the main config
41940   option &%spf_smtp_comment_template%&.
41941 .endlist
41942
41943
41944 .cindex SPF "ACL condition"
41945 .cindex ACL "spf_guess condition"
41946 .cindex SPF "best guess"
41947 In addition to SPF, you can also perform checks for so-called
41948 "Best-guess".  Strictly speaking, "Best-guess" is not standard
41949 SPF, but it is supported by the same framework that enables SPF
41950 capability.
41951 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
41952 for a description of what it means.
41953 . --- 2019-10-28: still not https:
41954
41955 To access this feature, simply use the spf_guess condition in place
41956 of the spf one.  For example:
41957
41958 .code
41959 deny spf_guess = fail
41960      message = $sender_host_address doesn't look trustworthy to me
41961 .endd
41962
41963 In case you decide to reject messages based on this check, you
41964 should note that although it uses the same framework, "Best-guess"
41965 is not SPF, and therefore you should not mention SPF at all in your
41966 reject message.
41967
41968 When the spf_guess condition has run, it sets up the same expansion
41969 variables as when spf condition is run, described above.
41970
41971 Additionally, since Best-guess is not standardized, you may redefine
41972 what "Best-guess" means to you by redefining the main configuration
41973 &%spf_guess%& option.
41974 For example, the following:
41975
41976 .code
41977 spf_guess = v=spf1 a/16 mx/16 ptr ?all
41978 .endd
41979
41980 would relax host matching rules to a broader network range.
41981
41982
41983 .cindex SPF "lookup expansion"
41984 .cindex lookup spf
41985 A lookup expansion is also available. It takes an email
41986 address as the key and an IP address
41987 (v4 or v6)
41988 as the database:
41989
41990 .code
41991   ${lookup {username@domain} spf {ip.ip.ip.ip}}
41992 .endd
41993
41994 The lookup will return the same result strings as can appear in
41995 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
41996
41997
41998
41999
42000
42001 .subsection "SRS (Sender Rewriting Scheme)" SECTSRS
42002 .cindex SRS "sender rewriting scheme"
42003
42004 SRS can be used to modify sender addresses when forwarding so that
42005 SPF verification does not object to them.
42006 It operates by encoding the original envelope sender in a new
42007 sender local part and using a domain run by the forwarding site
42008 as the new domain for the sender.  Any DSN message should be returned
42009 to this new sender at the forwarding site, which can extract the
42010 original sender from the coded local part and forward the DSN to
42011 the originator.
42012
42013 This is a way of avoiding the breakage that SPF does to forwarding.
42014 The constructed local-part will be longer than the original,
42015 leading to possible problems with very long addresses.
42016 The changing of the sender address also hinders the tracing of mail
42017 problems.
42018
42019 Exim can be built to include native SRS support.  To do this
42020 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
42021 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
42022 will be defined.
42023 The support is limited to SRS0-encoding; SRS1 is not supported.
42024
42025 .cindex SRS excoding
42026 To encode an address use this expansion item:
42027 .vlist
42028 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
42029 .cindex "&%srs_encode%& expansion item"
42030 .cindex SRS "expansion item"
42031 The first argument should be a secret known and used by all systems
42032 handling the recipient domain for the original message.
42033 There is no need to periodically change this key; a timestamp is also
42034 encoded.
42035 The second argument should be given as the envelope sender address before this
42036 encoding operation.
42037 If this value is empty the the expansion result will be empty.
42038 The third argument should be the recipient domain of the message when
42039 it arrived at this system.
42040 .endlist
42041
42042 .cindex SRS decoding
42043 To decode an address use this expansion condition:
42044 .vlist
42045 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
42046 The first argument should be the recipient local prt as is was received.
42047 The second argument is the site secret.
42048
42049 If the messages is not for an SRS-encoded recipient the condition will
42050 return false.  If it is, the condition will return true and the variable
42051 &$srs_recipient$& will be set to the decoded (original) value.
42052 .endlist
42053
42054 Example usage:
42055 .code
42056   #macro
42057   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
42058
42059   #routers
42060
42061   outbound:
42062     driver =    dnslookup
42063     # if outbound, and forwarding has been done, use an alternate transport
42064     domains =   ! +my_domains
42065     transport = ${if eq {$local_part@$domain} \
42066                         {$original_local_part@$original_domain} \
42067                      {remote_smtp} {remote_forwarded_smtp}}
42068
42069   inbound_srs:
42070     driver =    redirect
42071     senders =   :
42072     domains =   +my_domains
42073     # detect inbound bounces which are SRS'd, and decode them
42074     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
42075     data =      $srs_recipient
42076
42077   inbound_srs_failure:
42078     driver =    redirect
42079     senders =   :
42080     domains =   +my_domains
42081     # detect inbound bounces which look SRS'd but are invalid
42082     condition = ${if inbound_srs {$local_part} {}}
42083     allow_fail
42084     data =      :fail: Invalid SRS recipient address
42085
42086   #... further routers here
42087
42088
42089   # transport; should look like the non-forward outbound
42090   # one, plus the max_rcpt and return_path options
42091   remote_forwarded_smtp:
42092     driver =              smtp
42093     # modify the envelope from, for mails that we forward
42094     max_rcpt =            1
42095     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
42096 .endd
42097
42098
42099
42100
42101
42102 .section DMARC SECDMARC
42103 .cindex DMARC verification
42104
42105 DMARC combines feedback from SPF, DKIM, and header From: in order
42106 to attempt to provide better indicators of the authenticity of an
42107 email.  This document does not explain the fundamentals; you
42108 should read and understand how it works by visiting the website at
42109 &url(http://www.dmarc.org/).
42110
42111 If Exim is built with DMARC support,
42112 the libopendmarc library is used.
42113
42114 For building Exim yourself, obtain the library from
42115 &url(http://sourceforge.net/projects/opendmarc/)
42116 to obtain a copy, or find it in your favorite package
42117 repository.  You will need to attend to the local/Makefile feature
42118 SUPPORT_DMARC and the associated LDFLAGS addition.
42119 This description assumes
42120 that headers will be in /usr/local/include, and that the libraries
42121 are in /usr/local/lib.
42122
42123 .subsection Configuration SSECDMARCCONFIG
42124 .cindex DMARC configuration
42125
42126 There are three main-configuration options:
42127 .cindex DMARC "configuration options"
42128
42129 The &%dmarc_tld_file%& option
42130 .oindex &%dmarc_tld_file%&
42131 defines the location of a text file of valid
42132 top level domains the opendmarc library uses
42133 during domain parsing. Maintained by Mozilla,
42134 the most current version can be downloaded
42135 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
42136 See also the util/renew-opendmarc-tlds.sh script.
42137 The default for the option is unset.
42138 If not set, DMARC processing is disabled.
42139
42140
42141 The &%dmarc_history_file%& option, if set
42142 .oindex &%dmarc_history_file%&
42143 defines the location of a file to log results
42144 of dmarc verification on inbound emails. The
42145 contents are importable by the opendmarc tools
42146 which will manage the data, send out DMARC
42147 reports, and expire the data. Make sure the
42148 directory of this file is writable by the user
42149 exim runs as.
42150 The default is unset.
42151
42152 The &%dmarc_forensic_sender%& option
42153 .oindex &%dmarc_forensic_sender%&
42154 defines an alternate email address to use when sending a
42155 forensic report detailing alignment failures
42156 if a sender domain's dmarc record specifies it
42157 and you have configured Exim to send them.
42158 If set, this is expanded and used for the
42159 From: header line; the address is extracted
42160 from it and used for the envelope from.
42161 If not set (the default), the From: header is expanded from
42162 the dsn_from option, and <> is used for the
42163 envelope from.
42164
42165 .subsection Controls SSECDMARCCONTROLS
42166 .cindex DMARC controls
42167
42168 By default, the DMARC processing will run for any remote,
42169 non-authenticated user.  It makes sense to only verify DMARC
42170 status of messages coming from remote, untrusted sources.  You can
42171 use standard conditions such as hosts, senders, etc, to decide that
42172 DMARC verification should *not* be performed for them and disable
42173 DMARC with an ACL control modifier:
42174 .code
42175   control = dmarc_disable_verify
42176 .endd
42177 A DMARC record can also specify a "forensic address", which gives
42178 exim an email address to submit reports about failed alignment.
42179 Exim does not do this by default because in certain conditions it
42180 results in unintended information leakage (what lists a user might
42181 be subscribed to, etc).  You must configure exim to submit forensic
42182 reports to the owner of the domain.  If the DMARC record contains a
42183 forensic address and you specify the control statement below, then
42184 exim will send these forensic emails.  It is also advised that you
42185 configure a &%dmarc_forensic_sender%& because the default sender address
42186 construction might be inadequate.
42187 .code
42188   control = dmarc_enable_forensic
42189 .endd
42190 (AGAIN: You can choose not to send these forensic reports by simply
42191 not putting the dmarc_enable_forensic control line at any point in
42192 your exim config.  If you don't tell exim to send them, it will not
42193 send them.)
42194
42195 There are no options to either control.  Both must appear before
42196 the DATA acl.
42197
42198 .subsection ACL SSECDMARCACL
42199 .cindex DMARC "ACL condition"
42200
42201 DMARC checks cam be run on incoming SMTP  messages by using the
42202 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
42203 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
42204 condition.  Putting this condition in the ACLs is required in order
42205 for a DMARC check to actually occur.  All of the variables are set
42206 up before the DATA ACL, but there is no actual DMARC check that
42207 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
42208
42209 The &"dmarc_status"& condition takes a list of strings on its
42210 right-hand side.  These strings describe recommended action based
42211 on the DMARC check.  To understand what the policy recommendations
42212 mean, refer to the DMARC website above.  Valid strings are:
42213 .itable none 0 0 2 20* left 80* left
42214 .irow &'accept'&        "The DMARC check passed and the library recommends accepting the email"
42215 .irow &'reject'&        "The DMARC check failed and the library recommends rejecting the email"
42216 .irow &'quarantine'&    "The DMARC check failed and the library recommends keeping it for further inspection"
42217 .irow &'none'&          "The DMARC check passed and the library recommends no specific action, neutral"
42218 .irow &'norecord'&      "No policy section in the DMARC record for this RFC5322.From field"
42219 .irow &'nofrom'&        "Unable to determine the domain of the sender"
42220 .irow &'temperror'&     "Library error or dns error"
42221 .irow &'off'&           "The DMARC check was disabled for this email"
42222 .endtable
42223 You can prefix each string with an exclamation mark to invert its
42224 meaning, for example "!accept" will match all results but
42225 "accept".  The string list is evaluated left-to-right in a
42226 short-circuit fashion.  When a string matches the outcome of the
42227 DMARC check, the condition succeeds.  If none of the listed
42228 strings matches the outcome of the DMARC check, the condition
42229 fails.
42230
42231 Of course, you can also use any other lookup method that Exim
42232 supports, including LDAP, Postgres, MySQL, etc, as long as the
42233 result is a list of colon-separated strings.
42234
42235 Performing the check sets up information used by the
42236 &%authresults%& expansion item.
42237
42238 Several expansion variables are set before the DATA ACL is
42239 processed, and you can use them in this ACL.  The following
42240 expansion variables are available:
42241
42242 .vlist
42243 .vitem &$dmarc_status$&
42244 .vindex &$dmarc_status$&
42245 .cindex DMARC result
42246 A one word status indicating what the DMARC library
42247 thinks of the email.  It is a combination of the results of
42248 DMARC record lookup and the SPF/DKIM/DMARC processing results
42249 (if a DMARC record was found).  The actual policy declared
42250 in the DMARC record is in a separate expansion variable.
42251
42252 .vitem &$dmarc_status_text$&
42253 .vindex &$dmarc_status_text$&
42254 Slightly longer, human readable status.
42255
42256 .vitem &$dmarc_used_domain$&
42257 .vindex &$dmarc_used_domain$&
42258 The domain which DMARC used to look up the DMARC policy record.
42259
42260 .vitem &$dmarc_domain_policy$&
42261 .vindex &$dmarc_domain_policy$&
42262 The policy declared in the DMARC record.  Valid values
42263 are "none", "reject" and "quarantine".  It is blank when there
42264 is any error, including no DMARC record.
42265 .endlist
42266
42267 .subsection Logging SSECDMARCLOGGING
42268 .cindex DMARC logging
42269
42270 By default, Exim's DMARC configuration is intended to be
42271 non-intrusive and conservative.  To facilitate this, Exim will not
42272 create any type of logging files without explicit configuration by
42273 you, the admin.  Nor will Exim send out any emails/reports about
42274 DMARC issues without explicit configuration by you, the admin (other
42275 than typical bounce messages that may come about due to ACL
42276 processing or failure delivery issues).
42277
42278 In order to log statistics suitable to be imported by the opendmarc
42279 tools, you need to:
42280 .ilist
42281 Configure the global option &%dmarc_history_file%&
42282 .next
42283 Configure cron jobs to call the appropriate opendmarc history
42284 import scripts and truncating the dmarc_history_file
42285 .endlist
42286
42287 In order to send forensic reports, you need to:
42288 .ilist
42289 Configure the global option &%dmarc_forensic_sender%&
42290 .next
42291 Configure, somewhere before the DATA ACL, the control option to
42292 enable sending DMARC forensic reports
42293 .endlist
42294
42295 .subsection Example SSECDMARCEXAMPLE
42296 .cindex DMARC example
42297
42298 Example usage:
42299 .code
42300 (RCPT ACL)
42301   warn    domains        = +local_domains
42302           hosts          = +local_hosts
42303           control        = dmarc_disable_verify
42304
42305   warn    !domains       = +screwed_up_dmarc_records
42306           control        = dmarc_enable_forensic
42307
42308   warn    condition      = (lookup if destined to mailing list)
42309           set acl_m_mailing_list = 1
42310
42311 (DATA ACL)
42312   warn    dmarc_status   = accept : none : off
42313           !authenticated = *
42314           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
42315
42316   warn    dmarc_status   = !accept
42317           !authenticated = *
42318           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
42319
42320   warn    dmarc_status   = quarantine
42321           !authenticated = *
42322           set $acl_m_quarantine = 1
42323           # Do something in a transport with this flag variable
42324
42325   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
42326           condition      = ${if eq{$acl_m_mailing_list}{1}}
42327           message        = Messages from $dmarc_used_domain break mailing lists
42328
42329   deny    dmarc_status   = reject
42330           !authenticated = *
42331           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
42332
42333   warn    add_header     = :at_start:${authresults {$primary_hostname}}
42334 .endd
42335
42336
42337
42338
42339
42340 . ////////////////////////////////////////////////////////////////////////////
42341 . ////////////////////////////////////////////////////////////////////////////
42342
42343 .chapter "Proxies" "CHAPproxies" &&&
42344          "Proxy support"
42345 .cindex "proxy support"
42346 .cindex "proxy" "access via"
42347
42348 A proxy is an intermediate system through which communication is passed.
42349 Proxies may provide a security, availability or load-distribution function.
42350
42351
42352 .section "Inbound proxies" SECTproxyInbound
42353 .cindex proxy inbound
42354 .cindex proxy "server side"
42355 .cindex proxy "Proxy protocol"
42356 .cindex "Proxy protocol" proxy
42357
42358 Exim has support for receiving inbound SMTP connections via a proxy
42359 that uses &"Proxy Protocol"& to speak to it.
42360 To include this support, include &"SUPPORT_PROXY=yes"&
42361 in Local/Makefile.
42362
42363 It was built on the HAProxy specification, found at
42364 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42365
42366 The purpose of this facility is so that an application load balancer,
42367 such as HAProxy, can sit in front of several Exim servers
42368 to distribute load.
42369 Exim uses the local protocol communication with the proxy to obtain
42370 the remote SMTP system IP address and port information.
42371 There is no logging if a host passes or
42372 fails Proxy Protocol negotiation, but it can easily be determined and
42373 recorded in an ACL (example is below).
42374
42375 Use of a proxy is enabled by setting the &%hosts_proxy%&
42376 main configuration option to a hostlist; connections from these
42377 hosts will use Proxy Protocol.
42378 Exim supports both version 1 and version 2 of the Proxy Protocol and
42379 automatically determines which version is in use.
42380
42381 The Proxy Protocol header is the first data received on a TCP connection
42382 and is inserted before any TLS-on-connect handshake from the client; Exim
42383 negotiates TLS between Exim-as-server and the remote client, not between
42384 Exim and the proxy server. The Proxy Protocol header must be received
42385 within &%proxy_protocol_timeout%&, which defaults to 3s.
42386
42387 The following expansion variables are usable
42388 (&"internal"& and &"external"& here refer to the interfaces
42389 of the proxy):
42390 .itable none 0 0 2 30* left 70* left
42391 .irow $proxy_external_address   "IP of host being proxied or IP of remote interface of proxy"
42392 .irow $proxy_external_port      "Port of host being proxied or Port on remote interface of proxy"
42393 .irow $proxy_local_address      "IP of proxy server inbound or IP of local interface of proxy"
42394 .irow $proxy_local_port         "Port of proxy server inbound or Port on local interface of proxy"
42395 .irow $proxy_session            "boolean: SMTP connection via proxy"
42396 .endtable
42397 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42398 there was a protocol error.
42399 The variables &$sender_host_address$& and &$sender_host_port$&
42400 will have values for the actual client system, not the proxy.
42401
42402 Since the real connections are all coming from the proxy, and the
42403 per host connection tracking is done before Proxy Protocol is
42404 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42405 handle all of the parallel volume you expect per inbound proxy.
42406 With the option set so high, you lose the ability
42407 to protect your server from many connections from one IP.
42408 In order to prevent your server from overload, you
42409 need to add a per connection ratelimit to your connect ACL.
42410 A possible solution is:
42411 .display
42412   # Set max number of connections per host
42413   LIMIT   = 5
42414   # Or do some kind of IP lookup in a flat file or database
42415   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42416
42417   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42418           message        = Too many connections from this IP right now
42419 .endd
42420
42421
42422
42423 .section "Outbound proxies" SECTproxySOCKS
42424 .cindex proxy outbound
42425 .cindex proxy "client side"
42426 .cindex proxy SOCKS
42427 .cindex SOCKS proxy
42428 Exim has support for sending outbound SMTP via a proxy
42429 using a protocol called SOCKS5 (defined by RFC1928).
42430 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42431 Local/Makefile.
42432
42433 Use of a proxy is enabled by setting the &%socks_proxy%& option
42434 on an smtp transport.
42435 The option value is expanded and should then be a list
42436 (colon-separated by default) of proxy specifiers.
42437 Each proxy specifier is a list
42438 (space-separated by default) where the initial element
42439 is an IP address and any subsequent elements are options.
42440
42441 Options are a string <name>=<value>.
42442 The list of options is in the following table:
42443 .itable none 0 0 2 10* left 90* left
42444 .irow &'auth'&  "authentication method"
42445 .irow &'name'&  "authentication username"
42446 .irow &'pass'&  "authentication password"
42447 .irow &'port'&  "tcp port"
42448 .irow &'tmo'&   "connection timeout"
42449 .irow &'pri'&   "priority"
42450 .irow &'weight'& "selection bias"
42451 .endtable
42452
42453 More details on each of these options follows:
42454
42455 .ilist
42456 .cindex authentication "to proxy"
42457 .cindex proxy authentication
42458 &%auth%&: Either &"none"& (default) or &"name"&.
42459 Using &"name"& selects username/password authentication per RFC 1929
42460 for access to the proxy.
42461 Default is &"none"&.
42462 .next
42463 &%name%&: sets the username for the &"name"& authentication method.
42464 Default is empty.
42465 .next
42466 &%pass%&: sets the password for the &"name"& authentication method.
42467 Default is empty.
42468 .next
42469 &%port%&: the TCP port number to use for the connection to the proxy.
42470 Default is 1080.
42471 .next
42472 &%tmo%&: sets a connection timeout in seconds for this proxy.
42473 Default is 5.
42474 .next
42475 &%pri%&: specifies a priority for the proxy within the list,
42476 higher values being tried first.
42477 The default priority is 1.
42478 .next
42479 &%weight%&: specifies a selection bias.
42480 Within a priority set servers are queried in a random fashion,
42481 weighted by this value.
42482 The default value for selection bias is 1.
42483 .endlist
42484
42485 Proxies from the list are tried according to their priority
42486 and weight settings until one responds.  The timeout for the
42487 overall connection applies to the set of proxied attempts.
42488
42489 .section Logging SECTproxyLog
42490 To log the (local) IP of a proxy in the incoming or delivery logline,
42491 add &"+proxy"& to the &%log_selector%& option.
42492 This will add a component tagged with &"PRX="& to the line.
42493
42494 . ////////////////////////////////////////////////////////////////////////////
42495 . ////////////////////////////////////////////////////////////////////////////
42496
42497 .chapter "Internationalisation" "CHAPi18n" &&&
42498          "Internationalisation""
42499 .cindex internationalisation "email address"
42500 .cindex EAI
42501 .cindex i18n
42502 .cindex utf8 "mail name handling"
42503
42504 Exim has support for Internationalised mail names.
42505 To include this it must be built with SUPPORT_I18N and the libidn library.
42506 Standards supported are RFCs 2060, 5890, 6530 and 6533.
42507
42508 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
42509 instead of it) then IDNA2008 is supported; this adds an extra library
42510 requirement, upon libidn2.
42511
42512 .section "MTA operations" SECTi18nMTA
42513 .cindex SMTPUTF8 "ESMTP option"
42514 .cindex "ESMTP extensions" SMTPUTF8
42515 The main configuration option &%smtputf8_advertise_hosts%& specifies
42516 a host list.  If this matches the sending host and
42517 accept_8bitmime is true (the default) then the ESMTP option
42518 SMTPUTF8 will be advertised.
42519
42520 If the sender specifies the SMTPUTF8 option on a MAIL command
42521 international handling for the message is enabled and
42522 the expansion variable &$message_smtputf8$& will have value TRUE.
42523
42524 The option &%allow_utf8_domains%& is set to true for this
42525 message. All DNS lookups are converted to a-label form
42526 whatever the setting of &%allow_utf8_domains%&
42527 when Exim is built with SUPPORT_I18N.
42528
42529 Both localparts and domain are maintained as the original
42530 UTF-8 form internally; any comparison or regular-expression use will
42531 require appropriate care.  Filenames created, eg. by
42532 the appendfile transport, will have UTF-8 names.
42533
42534 HELO names sent by the smtp transport will have any UTF-8
42535 components expanded to a-label form,
42536 and any certificate name checks will be done using the a-label
42537 form of the name.
42538
42539 .cindex log protocol
42540 .cindex SMTPUTF8 logging
42541 .cindex i18n logging
42542 Log lines and Received-by: header lines will acquire a "utf8"
42543 prefix on the protocol element, eg. utf8esmtp.
42544
42545 The following expansion operators can be used:
42546 .code
42547 ${utf8_domain_to_alabel:str}
42548 ${utf8_domain_from_alabel:str}
42549 ${utf8_localpart_to_alabel:str}
42550 ${utf8_localpart_from_alabel:str}
42551 .endd
42552
42553 .cindex utf8 "address downconversion"
42554 .cindex i18n "utf8 address downconversion"
42555 The RCPT ACL
42556 may use the following modifier:
42557 .display
42558 control = utf8_downconvert
42559 control = utf8_downconvert/<value>
42560 .endd
42561 This sets a flag requiring that envelope addresses are converted to
42562 a-label form before smtp delivery.
42563 This is usually for use in a Message Submission Agent context,
42564 but could be used for any message.
42565
42566 If a value is appended it may be:
42567 .itable none 0 0 2 5* right 95* left
42568 .irow &`1`&     "mandatory downconversion"
42569 .irow &`0`&     "no downconversion"
42570 .irow &`-1`&    "if SMTPUTF8 not supported by destination host"
42571 .endtable
42572 If no value is given, 1 is used.
42573
42574 If mua_wrapper is set, the utf8_downconvert control
42575 is initially set to -1.
42576
42577 The smtp transport has an option &%utf8_downconvert%&.
42578 If set it must expand to one of the three values described above,
42579 or an empty string.
42580 If non-empty it overrides value previously set
42581 (due to mua_wrapper or by an ACL control).
42582
42583
42584 There is no explicit support for VRFY and EXPN.
42585 Configurations supporting these should inspect
42586 &$smtp_command_argument$& for an SMTPUTF8 argument.
42587
42588 There is no support for LMTP on Unix sockets.
42589 Using the "lmtp" protocol option on an smtp transport,
42590 for LMTP over TCP, should work as expected.
42591
42592 There is no support for DSN unitext handling,
42593 and no provision for converting logging from or to UTF-8.
42594
42595
42596
42597 .section "MDA operations" SECTi18nMDA
42598 To aid in constructing names suitable for IMAP folders
42599 the following expansion operator can be used:
42600 .code
42601 ${imapfolder {<string>} {<sep>} {<specials>}}
42602 .endd
42603
42604 The string is converted from the charset specified by
42605 the "headers charset" command (in a filter file)
42606 or &%headers_charset%& main configuration option (otherwise),
42607 to the
42608 modified UTF-7 encoding specified by RFC 2060,
42609 with the following exception: All occurrences of <sep>
42610 (which has to be a single character)
42611 are replaced with periods ("."), and all periods and slashes that are not
42612 <sep> and are not in the <specials> string are BASE64 encoded.
42613
42614 The third argument can be omitted, defaulting to an empty string.
42615 The second argument can be omitted, defaulting to "/".
42616
42617 This is the encoding used by Courier for Maildir names on disk, and followed
42618 by many other IMAP servers.
42619
42620 Examples:
42621 .display
42622 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
42623 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
42624 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
42625 .endd
42626
42627 Note that the source charset setting is vital, and also that characters
42628 must be representable in UTF-16.
42629
42630
42631 . ////////////////////////////////////////////////////////////////////////////
42632 . ////////////////////////////////////////////////////////////////////////////
42633
42634 .chapter "Events" "CHAPevents" &&&
42635          "Events"
42636 .cindex events
42637
42638 The events mechanism in Exim can be used to intercept processing at a number
42639 of points.  It was originally invented to give a way to do customised logging
42640 actions (for example, to a database) but can also be used to modify some
42641 processing actions.
42642
42643 Most installations will never need to use Events.
42644 The support can be left out of a build by defining DISABLE_EVENT=yes
42645 in &_Local/Makefile_&.
42646
42647 There are two major classes of events: main and transport.
42648 The main configuration option &%event_action%& controls reception events;
42649 a transport option &%event_action%& controls delivery events.
42650
42651 Both options are a string which is expanded when the event fires.
42652 An example might look like:
42653 .cindex logging custom
42654 .code
42655 event_action = ${if eq {msg:delivery}{$event_name} \
42656 {${lookup pgsql {SELECT * FROM record_Delivery( \
42657     '${quote_pgsql:$sender_address_domain}',\
42658     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42659     '${quote_pgsql:$domain}', \
42660     '${quote_pgsql:${lc:$local_part}}', \
42661     '${quote_pgsql:$host_address}', \
42662     '${quote_pgsql:${lc:$host}}', \
42663     '${quote_pgsql:$message_exim_id}')}} \
42664 } {}}
42665 .endd
42666
42667 Events have names which correspond to the point in process at which they fire.
42668 The name is placed in the variable &$event_name$& and the event action
42669 expansion must check this, as it will be called for every possible event type.
42670
42671 The current list of events is:
42672 .itable all 0 0 4 25* left 10* center 15* center 50* left
42673 .row auth:fail              after    both       "per driver per authentication attempt"
42674 .row dane:fail              after    transport  "per connection"
42675 .row msg:complete           after    main       "per message"
42676 .row msg:defer              after    transport  "per message per delivery try"
42677 .row msg:delivery           after    transport  "per recipient"
42678 .row msg:rcpt:host:defer    after    transport  "per recipient per host"
42679 .row msg:rcpt:defer         after    transport  "per recipient"
42680 .row msg:host:defer         after    transport  "per host per delivery try; host errors"
42681 .row msg:fail:delivery      after    transport  "per recipient"
42682 .row msg:fail:internal      after    main       "per recipient"
42683 .row tcp:connect            before   transport  "per connection"
42684 .row tcp:close              after    transport  "per connection"
42685 .row tls:cert               before   both       "per certificate in verification chain"
42686 .row tls:fail:connect       after    main       "per connection"
42687 .row smtp:connect           after    transport  "per connection"
42688 .row smtp:ehlo              after    transport  "per connection"
42689 .endtable
42690 New event types may be added in future.
42691
42692 The event name is a colon-separated list, defining the type of
42693 event in a tree of possibilities.  It may be used as a list
42694 or just matched on as a whole.  There will be no spaces in the name.
42695
42696 The second column in the table above describes whether the event fires
42697 before or after the action is associates with.  Those which fire before
42698 can be used to affect that action (more on this below).
42699
42700 The third column in the table above says what section of the configuration
42701 should define the event action.
42702
42703 An additional variable, &$event_data$&, is filled with information varying
42704 with the event type:
42705 .itable all 0 0 2 20* left 80* left
42706 .row auth:fail            "smtp response"
42707 .row dane:fail            "failure reason"
42708 .row msg:defer            "error string"
42709 .row msg:delivery         "smtp confirmation message"
42710 .row msg:fail:internal    "failure reason"
42711 .row msg:fail:delivery    "smtp error message"
42712 .row msg:host:defer       "error string"
42713 .row msg:rcpt:host:defer  "error string"
42714 .row msg:rcpt:defer       "error string"
42715 .row tls:cert             "verification chain depth"
42716 .row tls:fail:connect     "error string"
42717 .row smtp:connect         "smtp banner"
42718 .row smtp:ehlo            "smtp ehlo response"
42719 .endtable
42720
42721 The :defer events populate one extra variable: &$event_defer_errno$&.
42722
42723 For complex operations an ACL expansion can be used in &%event_action%&,
42724 however due to the multiple contexts that Exim operates in during
42725 the course of its processing:
42726 .ilist
42727 variables set in transport events will not be visible outside that
42728 transport call
42729 .next
42730 acl_m variables in a server context are lost on a new connection,
42731 and after smtp helo/ehlo/mail/starttls/rset commands
42732 .endlist
42733 Using an ACL expansion with the logwrite modifier can be
42734 a useful way of writing to the main log.
42735
42736 The expansion of the event_action option should normally
42737 return an empty string.  Should it return anything else the
42738 following will be forced:
42739 .itable all 0 0 2 20* left 80* left
42740 .row auth:fail        "log information to write"
42741 .row tcp:connect      "do not connect"
42742 .row tls:cert         "refuse verification"
42743 .row smtp:connect     "close connection"
42744 .endtable
42745 All other message types ignore the result string, and
42746 no other use is made of it.
42747
42748 For a tcp:connect event, if the connection is being made to a proxy
42749 then the address and port variables will be that of the proxy and not
42750 the target system.
42751
42752 For tls:cert events, if GnuTLS is in use this will trigger only per
42753 chain element received on the connection.
42754 For OpenSSL it will trigger for every chain element including those
42755 loaded locally.
42756
42757 . ////////////////////////////////////////////////////////////////////////////
42758 . ////////////////////////////////////////////////////////////////////////////
42759
42760 .chapter "Adding new drivers or lookup types" "CHID13" &&&
42761          "Adding drivers or lookups"
42762 .cindex "adding drivers"
42763 .cindex "new drivers, adding"
42764 .cindex "drivers" "adding new"
42765 The following actions have to be taken in order to add a new router, transport,
42766 authenticator, or lookup type to Exim:
42767
42768 .olist
42769 Choose a name for the driver or lookup type that does not conflict with any
42770 existing name; I will use &"newdriver"& in what follows.
42771 .next
42772 Add to &_src/EDITME_& the line:
42773 .display
42774 <&'type'&>&`_NEWDRIVER=yes`&
42775 .endd
42776 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
42777 code is not to be included in the binary by default, comment this line out. You
42778 should also add any relevant comments about the driver or lookup type.
42779 .next
42780 Add to &_src/config.h.defaults_& the line:
42781 .code
42782 #define <type>_NEWDRIVER
42783 .endd
42784 .next
42785 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
42786 and create a table entry as is done for all the other drivers and lookup types.
42787 .next
42788 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
42789 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
42790 Add your &`NEWDRIVER`& to that list.
42791 As long as the dynamic module would be named &_newdriver.so_&, you can use the
42792 simple form that most lookups have.
42793 .next
42794 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
42795 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
42796 driver or lookup type and add it to the definition of OBJ.
42797 .next
42798 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
42799 definition of OBJ_MACRO.  Add a set of line to do the compile also.
42800 .next
42801 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
42802 &_src_&.
42803 .next
42804 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
42805 as for other drivers and lookups.
42806 .endlist
42807
42808 Then all you need to do is write the code! A good way to start is to make a
42809 proforma by copying an existing module of the same type, globally changing all
42810 occurrences of the name, and cutting out most of the code. Note that any
42811 options you create must be listed in alphabetical order, because the tables are
42812 searched using a binary chop procedure.
42813
42814 There is a &_README_& file in each of the sub-directories of &_src_& describing
42815 the interface that is expected.
42816
42817
42818
42819
42820 . ////////////////////////////////////////////////////////////////////////////
42821 . ////////////////////////////////////////////////////////////////////////////
42822
42823 . /////////////////////////////////////////////////////////////////////////////
42824 . These lines are processing instructions for the Simple DocBook Processor that
42825 . Philip Hazel has developed as a less cumbersome way of making PostScript and
42826 . PDFs than using xmlto and fop. They will be ignored by all other XML
42827 . processors.
42828 . /////////////////////////////////////////////////////////////////////////////
42829
42830 .literal xml
42831 <?sdop
42832   format="newpage"
42833   foot_right_recto="&chaptertitle;"
42834   foot_right_verso="&chaptertitle;"
42835 ?>
42836 .literal off
42837
42838 .makeindex "Options index"   "option"
42839 .makeindex "Variables index" "variable"
42840 .makeindex "Concept index"   "concept"
42841
42842
42843 . /////////////////////////////////////////////////////////////////////////////
42844 . /////////////////////////////////////////////////////////////////////////////