Docs: update note on host_reject_connection
[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.
9911 .new
9912 Any modification of &$value$& by this evaluation is discarded.
9913 .wen
9914 If the condition is true, &$item$& is added to the output as an
9915 item in a new list; if the condition is false, the item is discarded. The
9916 separator used for the output list is the same as the one used for the
9917 input, but a separator setting is not included in the output. For example:
9918 .code
9919 ${filter{a:b:c}{!eq{$item}{b}}}
9920 .endd
9921 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9922 to what it was before.
9923 See also the &%map%& and &%reduce%& expansion items.
9924
9925
9926 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9927 .cindex "hash function" "textual"
9928 .cindex "expansion" "textual hash"
9929 This is a textual hashing function, and was the first to be implemented in
9930 early versions of Exim. In current releases, there are other hashing functions
9931 (numeric, MD5, and SHA-1), which are described below.
9932
9933 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9934 <&'n'&>. If you are using fixed values for these numbers, that is, if
9935 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9936 use the simpler operator notation that avoids some of the braces:
9937 .code
9938 ${hash_<n>_<m>:<string>}
9939 .endd
9940 The second number is optional (in both notations). If <&'n'&> is greater than
9941 or equal to the length of the string, the expansion item returns the string.
9942 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9943 function to the string. The new string consists of characters taken from the
9944 first <&'m'&> characters of the string
9945 .code
9946 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9947 .endd
9948 If <&'m'&> is not present the value 26 is used, so that only lower case
9949 letters appear. For example:
9950 .display
9951 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9952 &`$hash{5}{monty}}           `&   yields  &`monty`&
9953 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9954 .endd
9955
9956 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9957         &*$h_*&<&'header&~name'&>&*:*&" &&&
9958        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9959         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9960        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9961         &*$lh_*&<&'header&~name'&>&*:*&" &&&
9962        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9963         &*$rh_*&<&'header&~name'&>&*:*&"
9964 .cindex "expansion" "header insertion"
9965 .vindex "&$header_$&"
9966 .vindex "&$bheader_$&"
9967 .vindex "&$lheader_$&"
9968 .vindex "&$rheader_$&"
9969 .cindex "header lines" "in expansion strings"
9970 .cindex "header lines" "character sets"
9971 .cindex "header lines" "decoding"
9972 Substitute the contents of the named message header line, for example
9973 .code
9974 $header_reply-to:
9975 .endd
9976 The newline that terminates a header line is not included in the expansion, but
9977 internal newlines (caused by splitting the header line over several physical
9978 lines) may be present.
9979
9980 The difference between the four pairs of expansions is in the way
9981 the data in the header line is interpreted.
9982
9983 .ilist
9984 .cindex "white space" "in header lines"
9985 &%rheader%& gives the original &"raw"& content of the header line, with no
9986 processing at all, and without the removal of leading and trailing white space.
9987
9988 .next
9989 .cindex "list" "of header lines"
9990 &%lheader%& gives a colon-separated list, one element per header when there
9991 are multiple headers with a given name.
9992 Any embedded colon characters within an element are doubled, so normal Exim
9993 list-processing facilities can be used.
9994 The terminating newline of each element is removed; in other respects
9995 the content is &"raw"&.
9996
9997 .next
9998 .cindex "base64 encoding" "in header lines"
9999 &%bheader%& removes leading and trailing white space, and then decodes base64
10000 or quoted-printable MIME &"words"& within the header text, but does no
10001 character set translation. If decoding of what looks superficially like a MIME
10002 &"word"& fails, the raw string is returned. If decoding
10003 .cindex "binary zero" "in header line"
10004 produces a binary zero character, it is replaced by a question mark &-- this is
10005 what Exim does for binary zeros that are actually received in header lines.
10006
10007 .next
10008 &%header%& tries to translate the string as decoded by &%bheader%& to a
10009 standard character set. This is an attempt to produce the same string as would
10010 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10011 returned. Translation is attempted only on operating systems that support the
10012 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10013 a system Makefile or in &_Local/Makefile_&.
10014 .endlist ilist
10015
10016 In a filter file, the target character set for &%header%& can be specified by a
10017 command of the following form:
10018 .code
10019 headers charset "UTF-8"
10020 .endd
10021 This command affects all references to &$h_$& (or &$header_$&) expansions in
10022 subsequently obeyed filter commands. In the absence of this command, the target
10023 character set in a filter is taken from the setting of the &%headers_charset%&
10024 option in the runtime configuration. The value of this option defaults to the
10025 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10026 ISO-8859-1.
10027
10028 Header names follow the syntax of RFC 2822, which states that they may contain
10029 any printing characters except space and colon. Consequently, curly brackets
10030 &'do not'& terminate header names, and should not be used to enclose them as
10031 if they were variables. Attempting to do so causes a syntax error.
10032
10033 Only header lines that are common to all copies of a message are visible to
10034 this mechanism. These are the original header lines that are received with the
10035 message, and any that are added by an ACL statement or by a system
10036 filter. Header lines that are added to a particular copy of a message by a
10037 router or transport are not accessible.
10038
10039 For incoming SMTP messages, no header lines are visible in
10040 ACLs that are obeyed before the data phase completes,
10041 because the header structure is not set up until the message is received.
10042 They are visible in DKIM, PRDR and DATA ACLs.
10043 Header lines that are added in a RCPT ACL (for example)
10044 are saved until the message's incoming header lines are available, at which
10045 point they are added.
10046 When any of the above ACLs are
10047 running, however, header lines added by earlier ACLs are visible.
10048
10049 Upper case and lower case letters are synonymous in header names. If the
10050 following character is white space, the terminating colon may be omitted, but
10051 this is not recommended, because you may then forget it when it is needed. When
10052 white space terminates the header name, this white space is included in the
10053 expanded string.  If the message does not contain the given header, the
10054 expansion item is replaced by an empty string. (See the &%def%& condition in
10055 section &<<SECTexpcond>>& for a means of testing for the existence of a
10056 header.)
10057
10058 If there is more than one header with the same name, they are all concatenated
10059 to form the substitution string, up to a maximum length of 64K. Unless
10060 &%rheader%& is being used, leading and trailing white space is removed from
10061 each header before concatenation, and a completely empty header is ignored. A
10062 newline character is then inserted between non-empty headers, but there is no
10063 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10064 those headers that contain lists of addresses, a comma is also inserted at the
10065 junctions between headers. This does not happen for the &%rheader%& expansion.
10066
10067 .cindex "tainted data" "message headers"
10068 When the headers are from an incoming message,
10069 the result of expanding any of these variables is tainted.
10070
10071
10072 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10073 .cindex "expansion" "hmac hashing"
10074 .cindex &%hmac%&
10075 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10076 shared secret and some text into a message authentication code, as specified in
10077 RFC 2104. This differs from &`${md5:secret_text...}`& or
10078 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10079 cryptographic hash, allowing for authentication that is not possible with MD5
10080 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10081 present. For example:
10082 .code
10083 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10084 .endd
10085 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10086 produces:
10087 .code
10088 dd97e3ba5d1a61b5006108f8c8252953
10089 .endd
10090 As an example of how this might be used, you might put in the main part of
10091 an Exim configuration:
10092 .code
10093 SPAMSCAN_SECRET=cohgheeLei2thahw
10094 .endd
10095 In a router or a transport you could then have:
10096 .code
10097 headers_add = \
10098   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10099   ${hmac{md5}{SPAMSCAN_SECRET}\
10100   {${primary_hostname},${message_exim_id},$h_message-id:}}
10101 .endd
10102 Then given a message, you can check where it was scanned by looking at the
10103 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10104 this header line is authentic by recomputing the authentication code from the
10105 host name, message ID and the &'Message-id:'& header line. This can be done
10106 using Exim's &%-be%& option, or by other means, for example, by using the
10107 &'hmac_md5_hex()'& function in Perl.
10108
10109
10110 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10111 .cindex "expansion" "conditional"
10112 .cindex "&%if%&, expansion item"
10113 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10114 item; otherwise <&'string2'&> is used. The available conditions are described
10115 in section &<<SECTexpcond>>& below. For example:
10116 .code
10117 ${if eq {$local_part}{postmaster} {yes}{no} }
10118 .endd
10119 The second string need not be present; if it is not and the condition is not
10120 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10121 be present instead of the second string (without any curly brackets). In this
10122 case, the expansion is forced to fail if the condition is not true (see section
10123 &<<SECTforexpfai>>&).
10124
10125 If both strings are omitted, the result is the string &`true`& if the condition
10126 is true, and the empty string if the condition is false. This makes it less
10127 cumbersome to write custom ACL and router conditions. For example, instead of
10128 .code
10129 condition = ${if >{$acl_m4}{3}{true}{false}}
10130 .endd
10131 you can use
10132 .code
10133 condition = ${if >{$acl_m4}{3}}
10134 .endd
10135
10136
10137
10138 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10139 .cindex expansion "imap folder"
10140 .cindex "&%imapfolder%& expansion item"
10141 This item converts a (possibly multilevel, or with non-ASCII characters)
10142 folder specification to a Maildir name for filesystem use.
10143 For information on internationalisation support see &<<SECTi18nMDA>>&.
10144
10145
10146
10147 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10148 .cindex "expansion" "string truncation"
10149 .cindex "&%length%& expansion item"
10150 The &%length%& item is used to extract the initial portion of a string. Both
10151 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10152 you are using a fixed value for the number, that is, if <&'string1'&> does not
10153 change when expanded, you can use the simpler operator notation that avoids
10154 some of the braces:
10155 .code
10156 ${length_<n>:<string>}
10157 .endd
10158 The result of this item is either the first <&'n'&> bytes or the whole
10159 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10160 &%strlen%&, which gives the length of a string.
10161 All measurement is done in bytes and is not UTF-8 aware.
10162
10163
10164 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10165         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10166 .cindex "expansion" "extracting list elements by number"
10167 .cindex "&%listextract%&" "extract list elements by number"
10168 .cindex "list" "extracting elements by number"
10169 The <&'number'&> argument must consist entirely of decimal digits,
10170 apart from an optional leading minus,
10171 and leading and trailing white space (which is ignored).
10172
10173 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10174 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10175
10176 The first field of the list is numbered one.
10177 If the number is negative, the fields are
10178 counted from the end of the list, with the rightmost one numbered -1.
10179 The numbered element of the list is extracted and placed in &$value$&,
10180 then <&'string2'&> is expanded as the result.
10181
10182 If the modulus of the
10183 number is zero or greater than the number of fields in the string,
10184 the result is the expansion of <&'string3'&>.
10185
10186 For example:
10187 .code
10188 ${listextract{2}{x:42:99}}
10189 .endd
10190 yields &"42"&, and
10191 .code
10192 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10193 .endd
10194 yields &"result: 42"&.
10195
10196 If {<&'string3'&>} is omitted, an empty string is used for string3.
10197 If {<&'string2'&>} is also omitted, the value that was
10198 extracted is used.
10199 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10200
10201
10202 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10203 .cindex quoting "for list"
10204 .cindex list quoting
10205 This item doubles any occurrence of the separator character
10206 in the given string.
10207 An empty string is replaced with a single space.
10208 This converts the string into a safe form for use as a list element,
10209 in a list using the given separator.
10210
10211
10212 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10213         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10214        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10215         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10216 .cindex "expansion" "lookup in"
10217 .cindex "file" "lookups"
10218 .cindex "lookup" "in expanded string"
10219 The two forms of lookup item specify data lookups in files and databases, as
10220 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10221 lookups, and the second is used for query-style lookups. The <&'key'&>,
10222 <&'file'&>, and <&'query'&> strings are expanded before use.
10223
10224 If there is any white space in a lookup item which is part of a filter command,
10225 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10226 other place where white space is significant, the lookup item must be enclosed
10227 in double quotes. The use of data lookups in users' filter files may be locked
10228 out by the system administrator.
10229
10230 .vindex "&$value$&"
10231 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10232 During its expansion, the variable &$value$& contains the data returned by the
10233 lookup. Afterwards it reverts to the value it had previously (at the outer
10234 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10235 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10236 string on failure. If <&'string2'&> is provided, it can itself be a nested
10237 lookup, thus providing a mechanism for looking up a default value when the
10238 original lookup fails.
10239
10240 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10241 data for the outer lookup while the parameters of the second lookup are
10242 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10243 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10244 appear, and in this case, if the lookup fails, the entire expansion is forced
10245 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10246 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10247 successful lookup, and nothing in the case of failure.
10248
10249 For single-key lookups, the string &"partial"& is permitted to precede the
10250 search type in order to do partial matching, and * or *@ may follow a search
10251 type to request default lookups if the key does not match (see sections
10252 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10253
10254 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10255 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10256 and non-wild parts of the key during the expansion of the replacement text.
10257 They return to their previous values at the end of the lookup item.
10258
10259 This example looks up the postmaster alias in the conventional alias file:
10260 .code
10261 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10262 .endd
10263 This example uses NIS+ to look up the full name of the user corresponding to
10264 the local part of an address, forcing the expansion to fail if it is not found:
10265 .code
10266 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10267   {$value}fail}
10268 .endd
10269
10270
10271 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10272 .cindex "expansion" "list creation"
10273 .vindex "&$item$&"
10274 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10275 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10276 For each item
10277 in this list, its value is place in &$item$&, and then <&'string2'&> is
10278 expanded and added to the output as an item in a new list. The separator used
10279 for the output list is the same as the one used for the input, but a separator
10280 setting is not included in the output. For example:
10281 .code
10282 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10283 .endd
10284 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10285 value of &$item$& is restored to what it was before. See also the &%filter%&
10286 and &%reduce%& expansion items.
10287
10288 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10289 .cindex "expansion" "numeric hash"
10290 .cindex "hash function" "numeric"
10291 The three strings are expanded; the first two must yield numbers. Call them
10292 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10293 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10294 can use the simpler operator notation that avoids some of the braces:
10295 .code
10296 ${nhash_<n>_<m>:<string>}
10297 .endd
10298 The second number is optional (in both notations). If there is only one number,
10299 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10300 processed by a div/mod hash function that returns two numbers, separated by a
10301 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10302 example,
10303 .code
10304 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10305 .endd
10306 returns the string &"6/33"&.
10307
10308
10309
10310 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10311 .cindex "Perl" "use in expanded string"
10312 .cindex "expansion" "calling Perl from"
10313 This item is available only if Exim has been built to include an embedded Perl
10314 interpreter. The subroutine name and the arguments are first separately
10315 expanded, and then the Perl subroutine is called with those arguments. No
10316 additional arguments need be given; the maximum number permitted, including the
10317 name of the subroutine, is nine.
10318
10319 The return value of the subroutine is inserted into the expanded string, unless
10320 the return value is &%undef%&. In that case, the entire expansion is
10321 forced to fail, in the same way as an explicit &"fail"& on a lookup item
10322 does (see section &<<SECTforexpfai>>&).  Whatever you return is evaluated
10323 in a scalar context, thus the return value is a scalar.  For example, if you
10324 return a Perl vector, the return value is the size of the vector,
10325 not its contents.
10326
10327 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10328 with the error message that was passed to &%die%&. More details of the embedded
10329 Perl facility are given in chapter &<<CHAPperl>>&.
10330
10331 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10332 out the use of this expansion item in filter files.
10333
10334
10335 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10336 .cindex "&%prvs%& expansion item"
10337 The first argument is a complete email address and the second is secret
10338 keystring. The third argument, specifying a key number, is optional. If absent,
10339 it defaults to 0. The result of the expansion is a prvs-signed email address,
10340 to be typically used with the &%return_path%& option on an &(smtp)& transport
10341 as part of a bounce address tag validation (BATV) scheme. For more discussion
10342 and an example, see section &<<SECTverifyPRVS>>&.
10343
10344 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10345         {*&<&'string'&>&*}}*&"
10346 .cindex "&%prvscheck%& expansion item"
10347 This expansion item is the complement of the &%prvs%& item. It is used for
10348 checking prvs-signed addresses. If the expansion of the first argument does not
10349 yield a syntactically valid prvs-signed address, the whole item expands to the
10350 empty string. When the first argument does expand to a syntactically valid
10351 prvs-signed address, the second argument is expanded, with the prvs-decoded
10352 version of the address and the key number extracted from the address in the
10353 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10354
10355 These two variables can be used in the expansion of the second argument to
10356 retrieve the secret. The validity of the prvs-signed address is then checked
10357 against the secret. The result is stored in the variable &$prvscheck_result$&,
10358 which is empty for failure or &"1"& for success.
10359
10360 The third argument is optional; if it is missing, it defaults to an empty
10361 string. This argument is now expanded. If the result is an empty string, the
10362 result of the expansion is the decoded version of the address. This is the case
10363 whether or not the signature was valid. Otherwise, the result of the expansion
10364 is the expansion of the third argument.
10365
10366 All three variables can be used in the expansion of the third argument.
10367 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10368 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10369
10370 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10371 .cindex "expansion" "inserting an entire file"
10372 .cindex "file" "inserting into expansion"
10373 .cindex "&%readfile%& expansion item"
10374 The filename and end-of-line (eol) string are first expanded separately. The file is
10375 then read, and its contents replace the entire item. All newline characters in
10376 the file are replaced by the end-of-line string if it is present. Otherwise,
10377 newlines are left in the string.
10378 String expansion is not applied to the contents of the file. If you want this,
10379 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10380 the string expansion fails.
10381
10382 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10383 locks out the use of this expansion item in filter files.
10384
10385
10386
10387 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10388         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10389 .cindex "expansion" "inserting from a socket"
10390 .cindex "socket, use of in expansion"
10391 .cindex "&%readsocket%& expansion item"
10392 This item inserts data from a Unix domain or TCP socket into the expanded
10393 string. The minimal way of using it uses just two arguments, as in these
10394 examples:
10395 .code
10396 ${readsocket{/socket/name}{request string}}
10397 ${readsocket{inet:some.host:1234}{request string}}
10398 .endd
10399 For a Unix domain socket, the first substring must be the path to the socket.
10400 For an Internet socket, the first substring must contain &`inet:`& followed by
10401 a host name or IP address, followed by a colon and a port, which can be a
10402 number or the name of a TCP port in &_/etc/services_&. An IP address may
10403 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10404 example:
10405 .code
10406 ${readsocket{inet:[::1]:1234}{request string}}
10407 .endd
10408 Only a single host name may be given, but if looking it up yields more than
10409 one IP address, they are each tried in turn until a connection is made. For
10410 both kinds of socket, Exim makes a connection, writes the request string
10411 (unless it is an empty string; no terminating NUL is ever sent)
10412 and reads from the socket until an end-of-file
10413 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10414 extend what can be done. Firstly, you can vary the timeout. For example:
10415 .code
10416 ${readsocket{/socket/name}{request string}{3s}}
10417 .endd
10418
10419 The third argument is a list of options, of which the first element is the timeout
10420 and must be present if any options are given.
10421 Further elements are options of form &'name=value'&.
10422 Example:
10423 .code
10424 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10425 .endd
10426
10427 The following option names are recognised:
10428 .ilist
10429 &*cache*&
10430 Defines if the result data can be cached for use by a later identical
10431 request in the same process.
10432 Values are &"yes"& or &"no"& (the default).
10433 If not, all cached results for this connection specification
10434 will be invalidated.
10435
10436 .next
10437 &*shutdown*&
10438 Defines whether or not a write-shutdown is done on the connection after
10439 sending the request. Values are &"yes"& (the default) or &"no"&
10440 (preferred, eg. by some webservers).
10441
10442 .next
10443 &*tls*&
10444 Controls the use of TLS on the connection.
10445 Values are &"yes"& or &"no"& (the default).
10446 If it is enabled, a shutdown as described above is never done.
10447 .endlist
10448
10449
10450 A fourth argument allows you to change any newlines that are in the data
10451 that is read, in the same way as for &%readfile%& (see above). This example
10452 turns them into spaces:
10453 .code
10454 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10455 .endd
10456 As with all expansions, the substrings are expanded before the processing
10457 happens. Errors in these sub-expansions cause the expansion to fail. In
10458 addition, the following errors can occur:
10459
10460 .ilist
10461 Failure to create a socket file descriptor;
10462 .next
10463 Failure to connect the socket;
10464 .next
10465 Failure to write the request string;
10466 .next
10467 Timeout on reading from the socket.
10468 .endlist
10469
10470 By default, any of these errors causes the expansion to fail. However, if
10471 you supply a fifth substring, it is expanded and used when any of the above
10472 errors occurs. For example:
10473 .code
10474 ${readsocket{/socket/name}{request string}{3s}{\n}\
10475   {socket failure}}
10476 .endd
10477 You can test for the existence of a Unix domain socket by wrapping this
10478 expansion in &`${if exists`&, but there is a race condition between that test
10479 and the actual opening of the socket, so it is safer to use the fifth argument
10480 if you want to be absolutely sure of avoiding an expansion error for a
10481 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10482
10483 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10484 locks out the use of this expansion item in filter files.
10485
10486
10487 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10488 .cindex "expansion" "reducing a list to a scalar"
10489 .cindex "list" "reducing to a scalar"
10490 .vindex "&$value$&"
10491 .vindex "&$item$&"
10492 This operation reduces a list to a single, scalar string. After expansion,
10493 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10494 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10495 Then <&'string2'&> is expanded and
10496 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10497 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10498 them. The result of that expansion is assigned to &$value$& before the next
10499 iteration. When the end of the list is reached, the final value of &$value$& is
10500 added to the expansion output. The &%reduce%& expansion item can be used in a
10501 number of ways. For example, to add up a list of numbers:
10502 .code
10503 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10504 .endd
10505 The result of that expansion would be &`6`&. The maximum of a list of numbers
10506 can be found:
10507 .code
10508 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10509 .endd
10510 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10511 restored to what they were before. See also the &%filter%& and &%map%&
10512 expansion items.
10513
10514 . A bit of a special-case logic error in writing an expansion;
10515 . probably not worth including in the mainline of documentation.
10516 . If only we had footnotes (the html output variant is the problem).
10517 .
10518 . .new
10519 . &*Note*&: if an &'expansion condition'& is used in <&'string3'&>
10520 . and that condition modifies &$value$&,
10521 . then the string expansions dependent on the condition cannot use
10522 . the &$value$& of the reduce iteration.
10523 . .wen
10524
10525 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10526 This item inserts &"raw"& header lines. It is described with the &%header%&
10527 expansion item in section &<<SECTexpansionitems>>& above.
10528
10529 .vitem "&*${run <&'options'&> {*&<&'command&~arg&~list'&>&*}{*&<&'string1'&>&*}&&&
10530         {*&<&'string2'&>&*}}*&"
10531 .cindex "expansion" "running a command"
10532 .cindex "&%run%& expansion item"
10533 This item runs an external command, as a subprocess.
10534 One option is supported after the word &'run'&, comma-separated.
10535
10536 If the option &'preexpand'& is not used,
10537 the command string is split into individual arguments by spaces
10538 and then each argument is expanded.
10539 Then the command is run
10540 in a separate process, but under the same uid and gid.  As in other command
10541 executions from Exim, a shell is not used by default. If the command requires
10542 a shell, you must explicitly code it.
10543 The command name may not be tainted, but the remaining arguments can be.
10544
10545 &*Note*&: if tainted arguments are used, they are supplied by a
10546 potential attacker;
10547 a careful assessment for security vulnerabilities should be done.
10548
10549 If the option &'preexpand'& is used,
10550 the command and its arguments are first expanded as one string. The result is
10551 split apart into individual arguments by spaces, and then the command is run
10552 as above.
10553 Since the arguments are split by spaces, when there is a variable expansion
10554 which has an empty result, it will cause the situation that the argument will
10555 simply be omitted when the program is actually executed by Exim. If the
10556 script/program requires a specific number of arguments and the expanded
10557 variable could possibly result in this empty expansion, the variable must be
10558 quoted. This is more difficult if the expanded variable itself could result
10559 in a string containing quotes, because it would interfere with the quotes
10560 around the command arguments. A possible guard against this is to wrap the
10561 variable in the &%sg%& operator to change any quote marks to some other
10562 character.
10563 Neither the command nor any argument may be tainted.
10564
10565 The standard input for the command exists, but is empty. The standard output
10566 and standard error are set to the same file descriptor.
10567 .cindex "return code" "from &%run%& expansion"
10568 .vindex "&$value$&"
10569 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10570 and replaces the entire item; during this expansion, the standard output/error
10571 from the command is in the variable &$value$&. If the command fails,
10572 <&'string2'&>, if present, is expanded and used. Once again, during the
10573 expansion, the standard output/error from the command is in the variable
10574 &$value$&.
10575
10576 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10577 can be the word &"fail"& (not in braces) to force expansion failure if the
10578 command does not succeed. If both strings are omitted, the result is contents
10579 of the standard output/error on success, and nothing on failure.
10580
10581 .vindex "&$run_in_acl$&"
10582 The standard output/error of the command is put in the variable &$value$&.
10583 In this ACL example, the output of a command is logged for the admin to
10584 troubleshoot:
10585 .code
10586 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10587       log_message  = Output of id: $value
10588 .endd
10589 If the command requires shell idioms, such as the > redirect operator, the
10590 shell must be invoked directly, such as with:
10591 .code
10592 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10593 .endd
10594
10595 .vindex "&$runrc$&"
10596 The return code from the command is put in the variable &$runrc$&, and this
10597 remains set afterwards, so in a filter file you can do things like this:
10598 .code
10599 if "${run{x y z}{}}$runrc" is 1 then ...
10600   elif $runrc is 2 then ...
10601   ...
10602 endif
10603 .endd
10604 If execution of the command fails (for example, the command does not exist),
10605 the return code is 127 &-- the same code that shells use for non-existent
10606 commands.
10607
10608 &*Warning*&: In a router or transport, you cannot assume the order in which
10609 option values are expanded, except for those preconditions whose order of
10610 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10611 by the expansion of one option, and use it in another.
10612
10613 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10614 out the use of this expansion item in filter files.
10615
10616
10617 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10618 .cindex "expansion" "string substitution"
10619 .cindex "&%sg%& expansion item"
10620 This item works like Perl's substitution operator (s) with the global (/g)
10621 option; hence its name. However, unlike the Perl equivalent, Exim does not
10622 modify the subject string; instead it returns the modified string for insertion
10623 into the overall expansion. The item takes three arguments: the subject string,
10624 a regular expression, and a substitution string. For example:
10625 .code
10626 ${sg{abcdefabcdef}{abc}{xyz}}
10627 .endd
10628 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10629 if any $, } or \ characters are required in the regular expression or in the
10630 substitution string, they have to be escaped. For example:
10631 .code
10632 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10633 .endd
10634 yields &"defabc"&, and
10635 .code
10636 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10637 .endd
10638 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10639 the regular expression from string expansion.
10640
10641 The regular expression is compiled in 8-bit mode, working against bytes
10642 rather than any Unicode-aware character handling.
10643
10644
10645 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10646 .cindex sorting "a list"
10647 .cindex list sorting
10648 .cindex expansion "list sorting"
10649 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10650 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10651 The <&'comparator'&> argument is interpreted as the operator
10652 of a two-argument expansion condition.
10653 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10654 The comparison should return true when applied to two values
10655 if the first value should sort before the second value.
10656 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10657 the element being placed in &$item$&,
10658 to give values for comparison.
10659
10660 The item result is a sorted list,
10661 with the original list separator,
10662 of the list elements (in full) of the original.
10663
10664 Examples:
10665 .code
10666 ${sort{3:2:1:4}{<}{$item}}
10667 .endd
10668 sorts a list of numbers, and
10669 .code
10670 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10671 .endd
10672 will sort an MX lookup into priority order.
10673
10674
10675
10676 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10677 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10678
10679
10680
10681 .vitem &*${substr{*&<&'start'&>&*}{*&<&'len'&>&*}{*&<&'subject'&>&*}}*&
10682 .cindex "&%substr%& expansion item"
10683 .cindex "substring extraction"
10684 .cindex "expansion" "substring extraction"
10685 The three strings are expanded; the first two must yield numbers. Call them
10686 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10687 if <&'start'&> and <&'len'&> do not change when they are expanded, you
10688 can use the simpler operator notation that avoids some of the braces:
10689 .code
10690 ${substr_<n>_<m>:<subject>}
10691 .endd
10692 The second number is optional (in both notations).
10693 If it is absent in the simpler format, the preceding underscore must also be
10694 omitted.
10695
10696 The &%substr%& item can be used to extract more general substrings than
10697 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10698 length required. For example
10699 .code
10700 ${substr{3}{2}{$local_part}}
10701 .endd
10702 If the starting offset is greater than the string length the result is the
10703 null string; if the length plus starting offset is greater than the string
10704 length, the result is the right-hand part of the string, starting from the
10705 given offset. The first byte (character) in the string has offset zero.
10706
10707 The &%substr%& expansion item can take negative offset values to count
10708 from the right-hand end of its operand. The last byte (character) is offset -1,
10709 the second-last is offset -2, and so on. Thus, for example,
10710 .code
10711 ${substr{-5}{2}{1234567}}
10712 .endd
10713 yields &"34"&. If the absolute value of a negative offset is greater than the
10714 length of the string, the substring starts at the beginning of the string, and
10715 the length is reduced by the amount of overshoot. Thus, for example,
10716 .code
10717 ${substr{-5}{2}{12}}
10718 .endd
10719 yields an empty string, but
10720 .code
10721 ${substr{-3}{2}{12}}
10722 .endd
10723 yields &"1"&.
10724
10725 When the second number is omitted from &%substr%&, the remainder of the string
10726 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10727 string preceding the offset point are taken. For example, an offset of -1 and
10728 no length, as in these semantically identical examples:
10729 .code
10730 ${substr_-1:abcde}
10731 ${substr{-1}{abcde}}
10732 .endd
10733 yields all but the last character of the string, that is, &"abcd"&.
10734
10735 All measurement is done in bytes and is not UTF-8 aware.
10736
10737
10738
10739 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10740         {*&<&'replacements'&>&*}}*&"
10741 .cindex "expansion" "character translation"
10742 .cindex "&%tr%& expansion item"
10743 This item does single-character (in bytes) translation on its subject string. The second
10744 argument is a list of characters to be translated in the subject string. Each
10745 matching character is replaced by the corresponding character from the
10746 replacement list. For example
10747 .code
10748 ${tr{abcdea}{ac}{13}}
10749 .endd
10750 yields &`1b3de1`&. If there are duplicates in the second character string, the
10751 last occurrence is used. If the third string is shorter than the second, its
10752 last character is replicated. However, if it is empty, no translation takes
10753 place.
10754
10755 All character handling is done in bytes and is not UTF-8 aware.
10756
10757 .endlist
10758
10759
10760
10761 .section "Expansion operators" "SECTexpop"
10762 .cindex "expansion" "operators"
10763 For expansion items that perform transformations on a single argument string,
10764 the &"operator"& notation is used because it is simpler and uses fewer braces.
10765 The substring is first expanded before the operation is applied to it. The
10766 following operations can be performed:
10767
10768 .vlist
10769 .vitem &*${address:*&<&'string'&>&*}*&
10770 .cindex "expansion" "RFC 2822 address handling"
10771 .cindex "&%address%& expansion item"
10772 The string is interpreted as an RFC 2822 address, as it might appear in a
10773 header line, and the effective address is extracted from it. If the string does
10774 not parse successfully, the result is empty.
10775
10776 The parsing correctly handles SMTPUTF8 Unicode in the string.
10777
10778
10779 .vitem &*${addresses:*&<&'string'&>&*}*&
10780 .cindex "expansion" "RFC 2822 address handling"
10781 .cindex "&%addresses%& expansion item"
10782 The string (after expansion) is interpreted as a list of addresses in RFC
10783 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10784 operative address (&'local-part@domain'&) is extracted from each item, and the
10785 result of the expansion is a colon-separated list, with appropriate
10786 doubling of colons should any happen to be present in the email addresses.
10787 Syntactically invalid RFC2822 address items are omitted from the output.
10788
10789 It is possible to specify a character other than colon for the output
10790 separator by starting the string with > followed by the new separator
10791 character. For example:
10792 .code
10793 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10794 .endd
10795 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10796 first, so if the expanded string starts with >, it may change the output
10797 separator unintentionally. This can be avoided by setting the output
10798 separator explicitly:
10799 .code
10800 ${addresses:>:$h_from:}
10801 .endd
10802
10803 Compare the &%address%& (singular)
10804 expansion item, which extracts the working address from a single RFC2822
10805 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10806 processing lists.
10807
10808 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10809 a strict interpretation of header line formatting.  Exim parses the bare,
10810 unquoted portion of an email address and if it finds a comma, treats it as an
10811 email address separator. For the example header line:
10812 .code
10813 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10814 .endd
10815 The first example below demonstrates that Q-encoded email addresses are parsed
10816 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10817 It does not see the comma because it's still encoded as "=2C".  The second
10818 example below is passed the contents of &`$header_from:`&, meaning it gets
10819 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10820 The third example shows that the presence of a comma is skipped when it is
10821 quoted.  The fourth example shows SMTPUTF8 handling.
10822 .code
10823 # exim -be '${addresses:From: \
10824 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10825 user@example.com
10826 # exim -be '${addresses:From: Last, First <user@example.com>}'
10827 Last:user@example.com
10828 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10829 user@example.com
10830 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10831 フィリップ@example.jp
10832 .endd
10833
10834 .vitem &*${base32:*&<&'digits'&>&*}*&
10835 .cindex "&%base32%& expansion item"
10836 .cindex "expansion" "conversion to base 32"
10837 The string must consist entirely of decimal digits. The number is converted to
10838 base 32 and output as a (empty, for zero) string of characters.
10839 Only lowercase letters are used.
10840
10841 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10842 .cindex "&%base32d%& expansion item"
10843 .cindex "expansion" "conversion to base 32"
10844 The string must consist entirely of base-32 digits.
10845 The number is converted to decimal and output as a string.
10846
10847 .vitem &*${base62:*&<&'digits'&>&*}*&
10848 .cindex "&%base62%& expansion item"
10849 .cindex "expansion" "conversion to base 62"
10850 The string must consist entirely of decimal digits. The number is converted to
10851 base 62 and output as a string of six characters, including leading zeros. In
10852 the few operating environments where Exim uses base 36 instead of base 62 for
10853 its message identifiers (because those systems do not have case-sensitive
10854 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10855 to be absolutely clear: this is &'not'& base64 encoding.
10856
10857 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10858 .cindex "&%base62d%& expansion item"
10859 .cindex "expansion" "conversion to base 62"
10860 The string must consist entirely of base-62 digits, or, in operating
10861 environments where Exim uses base 36 instead of base 62 for its message
10862 identifiers, base-36 digits. The number is converted to decimal and output as a
10863 string.
10864
10865 .vitem &*${base64:*&<&'string'&>&*}*&
10866 .cindex "expansion" "base64 encoding"
10867 .cindex "base64 encoding" "in string expansion"
10868 .cindex "&%base64%& expansion item"
10869 .cindex certificate "base64 of DER"
10870 This operator converts a string into one that is base64 encoded.
10871
10872 If the string is a single variable of type certificate,
10873 returns the base64 encoding of the DER form of the certificate.
10874
10875
10876 .vitem &*${base64d:*&<&'string'&>&*}*&
10877 .cindex "expansion" "base64 decoding"
10878 .cindex "base64 decoding" "in string expansion"
10879 .cindex "&%base64d%& expansion item"
10880 This operator converts a base64-encoded string into the un-coded form.
10881
10882
10883 .vitem &*${domain:*&<&'string'&>&*}*&
10884 .cindex "domain" "extraction"
10885 .cindex "expansion" "domain extraction"
10886 The string is interpreted as an RFC 2822 address and the domain is extracted
10887 from it. If the string does not parse successfully, the result is empty.
10888
10889
10890 .vitem &*${escape:*&<&'string'&>&*}*&
10891 .cindex "expansion" "escaping non-printing characters"
10892 .cindex "&%escape%& expansion item"
10893 If the string contains any non-printing characters, they are converted to
10894 escape sequences starting with a backslash. Whether characters with the most
10895 significant bit set (so-called &"8-bit characters"&) count as printing or not
10896 is controlled by the &%print_topbitchars%& option.
10897
10898 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10899 .cindex "expansion" "escaping 8-bit characters"
10900 .cindex "&%escape8bit%& expansion item"
10901 If the string contains any characters with the most significant bit set,
10902 they are converted to escape sequences starting with a backslash.
10903 Backslashes and DEL characters are also converted.
10904
10905
10906 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10907 .cindex "expansion" "expression evaluation"
10908 .cindex "expansion" "arithmetic expression"
10909 .cindex "&%eval%& expansion item"
10910 These items supports simple arithmetic and bitwise logical operations in
10911 expansion strings. The string (after expansion) must be a conventional
10912 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10913 logical operators, and parentheses. All operations are carried out using
10914 integer arithmetic. The operator priorities are as follows (the same as in the
10915 C programming language):
10916 .table2 70pt 300pt
10917 .irow &'highest:'& "not (~), negate (-)"
10918 .irow ""   "multiply (*), divide (/), remainder (%)"
10919 .irow ""   "plus (+), minus (-)"
10920 .irow ""   "shift-left (<<), shift-right (>>)"
10921 .irow ""   "and (&&)"
10922 .irow ""   "xor (^)"
10923 .irow &'lowest:'&  "or (|)"
10924 .endtable
10925 Binary operators with the same priority are evaluated from left to right. White
10926 space is permitted before or after operators.
10927
10928 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10929 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10930 decimal, even if they start with a leading zero; hexadecimal numbers are not
10931 permitted. This can be useful when processing numbers extracted from dates or
10932 times, which often do have leading zeros.
10933
10934 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10935 or 1024*1024*1024,
10936 respectively. Negative numbers are supported. The result of the computation is
10937 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10938
10939 .display
10940 &`${eval:1+1}            `&  yields 2
10941 &`${eval:1+2*3}          `&  yields 7
10942 &`${eval:(1+2)*3}        `&  yields 9
10943 &`${eval:2+42%5}         `&  yields 4
10944 &`${eval:0xc&amp;5}          `&  yields 4
10945 &`${eval:0xc|5}          `&  yields 13
10946 &`${eval:0xc^5}          `&  yields 9
10947 &`${eval:0xc>>1}         `&  yields 6
10948 &`${eval:0xc<<1}         `&  yields 24
10949 &`${eval:~255&amp;0x1234}    `&  yields 4608
10950 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10951 .endd
10952
10953 As a more realistic example, in an ACL you might have
10954 .code
10955 deny   condition =                    \
10956          ${if and {                   \
10957            {>{$rcpt_count}{10}}       \
10958            {                          \
10959            <                          \
10960              {$recipients_count}      \
10961              {${eval:$rcpt_count/2}}  \
10962            }                          \
10963          }{yes}{no}}
10964        message = Too many bad recipients
10965 .endd
10966 The condition is true if there have been more than 10 RCPT commands and
10967 fewer than half of them have resulted in a valid recipient.
10968
10969
10970 .vitem &*${expand:*&<&'string'&>&*}*&
10971 .cindex "expansion" "re-expansion of substring"
10972 The &%expand%& operator causes a string to be expanded for a second time. For
10973 example,
10974 .code
10975 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10976 .endd
10977 first looks up a string in a file while expanding the operand for &%expand%&,
10978 and then re-expands what it has found.
10979
10980
10981 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10982 .cindex "Unicode"
10983 .cindex "UTF-8" "conversion from"
10984 .cindex "expansion" "UTF-8 conversion"
10985 .cindex "&%from_utf8%& expansion item"
10986 The world is slowly moving towards Unicode, although there are no standards for
10987 email yet. However, other applications (including some databases) are starting
10988 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10989 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10990 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10991 the result is an undefined sequence of bytes.
10992
10993 Unicode code points with values less than 256 are compatible with ASCII and
10994 ISO-8859-1 (also known as Latin-1).
10995 For example, character 169 is the copyright symbol in both cases, though the
10996 way it is encoded is different. In UTF-8, more than one byte is needed for
10997 characters with code values greater than 127, whereas ISO-8859-1 is a
10998 single-byte encoding (but thereby limited to 256 characters). This makes
10999 translation from UTF-8 to ISO-8859-1 straightforward.
11000
11001
11002 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11003 .cindex "hash function" "textual"
11004 .cindex "expansion" "textual hash"
11005 The &%hash%& operator is a simpler interface to the hashing function that can
11006 be used when the two parameters are fixed numbers (as opposed to strings that
11007 change when expanded). The effect is the same as
11008 .code
11009 ${hash{<n>}{<m>}{<string>}}
11010 .endd
11011 See the description of the general &%hash%& item above for details. The
11012 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11013
11014
11015
11016 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11017 .cindex "base64 encoding" "conversion from hex"
11018 .cindex "expansion" "hex to base64"
11019 .cindex "&%hex2b64%& expansion item"
11020 This operator converts a hex string into one that is base64 encoded. This can
11021 be useful for processing the output of the various hashing functions.
11022
11023
11024
11025 .vitem &*${hexquote:*&<&'string'&>&*}*&
11026 .cindex "quoting" "hex-encoded unprintable characters"
11027 .cindex "&%hexquote%& expansion item"
11028 This operator converts non-printable characters in a string into a hex
11029 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11030 as is, and other byte values are converted to &`\xNN`&, for example, a
11031 byte value 127 is converted to &`\x7f`&.
11032
11033
11034 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11035 .cindex "&%ipv6denorm%& expansion item"
11036 .cindex "IP address" normalisation
11037 This expands an IPv6 address to a full eight-element colon-separated set
11038 of hex digits including leading zeroes.
11039 A trailing ipv4-style dotted-decimal set is converted to hex.
11040 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11041
11042 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11043 .cindex "&%ipv6norm%& expansion item"
11044 .cindex "IP address" normalisation
11045 .cindex "IP address" "canonical form"
11046 This converts an IPv6 address to canonical form.
11047 Leading zeroes of groups are omitted, and the longest
11048 set of zero-valued groups is replaced with a double colon.
11049 A trailing ipv4-style dotted-decimal set is converted to hex.
11050 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11051
11052
11053 .vitem &*${lc:*&<&'string'&>&*}*&
11054 .cindex "case forcing in strings"
11055 .cindex "string" "case forcing"
11056 .cindex "lower casing"
11057 .cindex "expansion" "case forcing"
11058 .cindex "&%lc%& expansion item"
11059 This forces the letters in the string into lower-case, for example:
11060 .code
11061 ${lc:$local_part}
11062 .endd
11063 Case is defined per the system C locale.
11064
11065 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11066 .cindex "expansion" "string truncation"
11067 .cindex "&%length%& expansion item"
11068 The &%length%& operator is a simpler interface to the &%length%& function that
11069 can be used when the parameter is a fixed number (as opposed to a string that
11070 changes when expanded). The effect is the same as
11071 .code
11072 ${length{<number>}{<string>}}
11073 .endd
11074 See the description of the general &%length%& item above for details. Note that
11075 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11076 when &%length%& is used as an operator.
11077 All measurement is done in bytes and is not UTF-8 aware.
11078
11079
11080 .vitem &*${listcount:*&<&'string'&>&*}*&
11081 .cindex "expansion" "list item count"
11082 .cindex "list" "item count"
11083 .cindex "list" "count of items"
11084 .cindex "&%listcount%& expansion item"
11085 The string is interpreted as a list and the number of items is returned.
11086
11087
11088 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11089 .cindex "expansion" "named list"
11090 .cindex "&%listnamed%& expansion item"
11091 The name is interpreted as a named list and the content of the list is returned,
11092 expanding any referenced lists, re-quoting as needed for colon-separation.
11093 If the optional type is given it must be one of "a", "d", "h" or "l"
11094 and selects address-, domain-, host- or localpart- lists to search among respectively.
11095 Otherwise all types are searched in an undefined order and the first
11096 matching list is returned.
11097 &*Note*&: Neither string-expansion of lists referenced by named-list syntax elements,
11098 nor expansion of lookup elements, is done by the &%listnamed%& operator.
11099
11100
11101 .vitem &*${local_part:*&<&'string'&>&*}*&
11102 .cindex "expansion" "local part extraction"
11103 .cindex "&%local_part%& expansion item"
11104 The string is interpreted as an RFC 2822 address and the local part is
11105 extracted from it. If the string does not parse successfully, the result is
11106 empty.
11107 The parsing correctly handles SMTPUTF8 Unicode in the string.
11108
11109
11110 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*& &&&
11111        &*${mask_n:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11112 .cindex "masked IP address"
11113 .cindex "IP address" "masking"
11114 .cindex "CIDR notation"
11115 .cindex "expansion" "IP address masking"
11116 .cindex "&%mask%& expansion item"
11117 If the form of the string to be operated on is not an IP address followed by a
11118 slash and an integer (that is, a network address in CIDR notation), the
11119 expansion fails. Otherwise, this operator converts the IP address to binary,
11120 masks off the least significant bits according to the bit count, and converts
11121 the result back to text, with mask appended. For example,
11122 .code
11123 ${mask:10.111.131.206/28}
11124 .endd
11125 returns the string &"10.111.131.192/28"&.
11126
11127 Since this operation is expected to
11128 be mostly used for looking up masked addresses in files, the
11129 normal
11130 result for an IPv6
11131 address uses dots to separate components instead of colons, because colon
11132 terminates a key string in lsearch files. So, for example,
11133 .code
11134 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11135 .endd
11136 returns the string
11137 .code
11138 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11139 .endd
11140 If the optional form &*mask_n*& is used, IPv6 address result are instead
11141 returned in normailsed form, using colons and with zero-compression.
11142 Letters in IPv6 addresses are always output in lower case.
11143
11144
11145 .vitem &*${md5:*&<&'string'&>&*}*&
11146 .cindex "MD5 hash"
11147 .cindex "expansion" "MD5 hash"
11148 .cindex certificate fingerprint
11149 .cindex "&%md5%& expansion item"
11150 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11151 as a 32-digit hexadecimal number, in which any letters are in lower case.
11152
11153 If the string is a single variable of type certificate,
11154 returns the MD5 hash fingerprint of the certificate.
11155
11156
11157 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11158 .cindex "expansion" "numeric hash"
11159 .cindex "hash function" "numeric"
11160 The &%nhash%& operator is a simpler interface to the numeric hashing function
11161 that can be used when the two parameters are fixed numbers (as opposed to
11162 strings that change when expanded). The effect is the same as
11163 .code
11164 ${nhash{<n>}{<m>}{<string>}}
11165 .endd
11166 See the description of the general &%nhash%& item above for details.
11167
11168
11169 .vitem &*${quote:*&<&'string'&>&*}*&
11170 .cindex "quoting" "in string expansions"
11171 .cindex "expansion" "quoting"
11172 .cindex "&%quote%& expansion item"
11173 The &%quote%& operator puts its argument into double quotes if it
11174 is an empty string or
11175 contains anything other than letters, digits, underscores, dots, and hyphens.
11176 Any occurrences of double quotes and backslashes are escaped with a backslash.
11177 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11178 respectively For example,
11179 .code
11180 ${quote:ab"*"cd}
11181 .endd
11182 becomes
11183 .code
11184 "ab\"*\"cd"
11185 .endd
11186 The place where this is useful is when the argument is a substitution from a
11187 variable or a message header.
11188
11189 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11190 .cindex "&%quote_local_part%& expansion item"
11191 This operator is like &%quote%&, except that it quotes the string only if
11192 required to do so by the rules of RFC 2822 for quoting local parts. For
11193 example, a plus sign would not cause quoting (but it would for &%quote%&).
11194 If you are creating a new email address from the contents of &$local_part$&
11195 (or any other unknown data), you should always use this operator.
11196
11197 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11198 will likely use the quoting form.
11199 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11200
11201
11202 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11203 .cindex "quoting" "lookup-specific"
11204 This operator applies lookup-specific quoting rules to the string. Each
11205 query-style lookup type has its own quoting rules which are described with
11206 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11207 .code
11208 ${quote_ldap:two * two}
11209 .endd
11210 returns
11211 .code
11212 two%20%5C2A%20two
11213 .endd
11214 For single-key lookup types, no quoting is ever necessary and this operator
11215 yields an unchanged string.
11216
11217
11218 .vitem &*${randint:*&<&'n'&>&*}*&
11219 .cindex "random number"
11220 This operator returns a somewhat random number which is less than the
11221 supplied number and is at least 0.  The quality of this randomness depends
11222 on how Exim was built; the values are not suitable for keying material.
11223 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11224 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11225 for versions of GnuTLS with that function.
11226 Otherwise, the implementation may be arc4random(), random() seeded by
11227 srandomdev() or srandom(), or a custom implementation even weaker than
11228 random().
11229
11230
11231 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11232 .cindex "expansion" "IP address"
11233 This operator reverses an IP address; for IPv4 addresses, the result is in
11234 dotted-quad decimal form, while for IPv6 addresses the result is in
11235 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11236 for DNS.  For example,
11237 .code
11238 ${reverse_ip:192.0.2.4}
11239 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11240 .endd
11241 returns
11242 .code
11243 4.2.0.192
11244 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
11245 .endd
11246
11247
11248 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11249 .cindex "expansion" "RFC 2047"
11250 .cindex "RFC 2047" "expansion operator"
11251 .cindex "&%rfc2047%& expansion item"
11252 This operator encodes text according to the rules of RFC 2047. This is an
11253 encoding that is used in header lines to encode non-ASCII characters. It is
11254 assumed that the input string is in the encoding specified by the
11255 &%headers_charset%& option, which gets its default at build time. If the string
11256 contains only characters in the range 33&--126, and no instances of the
11257 characters
11258 .code
11259 ? = ( ) < > @ , ; : \ " . [ ] _
11260 .endd
11261 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11262 string, using as many &"encoded words"& as necessary to encode all the
11263 characters.
11264
11265
11266 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11267 .cindex "expansion" "RFC 2047"
11268 .cindex "RFC 2047" "decoding"
11269 .cindex "&%rfc2047d%& expansion item"
11270 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11271 bytes are replaced by question marks. Characters are converted into the
11272 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11273 not recognized unless &%check_rfc2047_length%& is set false.
11274
11275 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11276 access a header line, RFC 2047 decoding is done automatically. You do not need
11277 to use this operator as well.
11278
11279
11280
11281 .vitem &*${rxquote:*&<&'string'&>&*}*&
11282 .cindex "quoting" "in regular expressions"
11283 .cindex "regular expressions" "quoting"
11284 .cindex "&%rxquote%& expansion item"
11285 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11286 characters in its argument. This is useful when substituting the values of
11287 variables or headers inside regular expressions.
11288
11289
11290 .vitem &*${sha1:*&<&'string'&>&*}*&
11291 .cindex "SHA-1 hash"
11292 .cindex "expansion" "SHA-1 hashing"
11293 .cindex certificate fingerprint
11294 .cindex "&%sha1%& expansion item"
11295 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11296 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11297
11298 If the string is a single variable of type certificate,
11299 returns the SHA-1 hash fingerprint of the certificate.
11300
11301
11302 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11303        &*${sha2:*&<&'string'&>&*}*& &&&
11304        &*${sha2_<n>:*&<&'string'&>&*}*&
11305 .cindex "SHA-256 hash"
11306 .cindex "SHA-2 hash"
11307 .cindex certificate fingerprint
11308 .cindex "expansion" "SHA-256 hashing"
11309 .cindex "&%sha256%& expansion item"
11310 .cindex "&%sha2%& expansion item"
11311 The &%sha256%& operator computes the SHA-256 hash value of the string
11312 and returns
11313 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11314
11315 If the string is a single variable of type certificate,
11316 returns the SHA-256 hash fingerprint of the certificate.
11317
11318 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11319 (except for certificates, which are not supported).
11320 Finally, if an underbar
11321 and a number is appended it specifies the output length, selecting a
11322 member of the SHA-2 family of hash functions.
11323 Values of 256, 384 and 512 are accepted, with 256 being the default.
11324
11325
11326 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11327        &*${sha3_<n>:*&<&'string'&>&*}*&
11328 .cindex "SHA3 hash"
11329 .cindex "expansion" "SHA3 hashing"
11330 .cindex "&%sha3%& expansion item"
11331 The &%sha3%& operator computes the SHA3-256 hash value of the string
11332 and returns
11333 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11334
11335 If a number is appended, separated by an underbar, it specifies
11336 the output length.  Values of 224, 256, 384 and 512 are accepted;
11337 with 256 being the default.
11338
11339 The &%sha3%& expansion item is only supported if Exim has been
11340 compiled with GnuTLS 3.5.0 or later,
11341 or OpenSSL 1.1.1 or later.
11342 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11343
11344
11345 .vitem &*${stat:*&<&'string'&>&*}*&
11346 .cindex "expansion" "statting a file"
11347 .cindex "file" "extracting characteristics"
11348 .cindex "&%stat%& expansion item"
11349 The string, after expansion, must be a file path. A call to the &[stat()]&
11350 function is made for this path. If &[stat()]& fails, an error occurs and the
11351 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11352 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11353 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11354 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11355 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11356 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11357 can extract individual fields using the &%extract%& expansion item.
11358
11359 The use of the &%stat%& expansion in users' filter files can be locked out by
11360 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11361 systems for files larger than 2GB.
11362
11363 .vitem &*${str2b64:*&<&'string'&>&*}*&
11364 .cindex "&%str2b64%& expansion item"
11365 Now deprecated, a synonym for the &%base64%& expansion operator.
11366
11367
11368
11369 .vitem &*${strlen:*&<&'string'&>&*}*&
11370 .cindex "expansion" "string length"
11371 .cindex "string" "length in expansion"
11372 .cindex "&%strlen%& expansion item"
11373 The item is replaced by the length of the expanded string, expressed as a
11374 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11375 All measurement is done in bytes and is not UTF-8 aware.
11376
11377
11378 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11379 .cindex "&%substr%& expansion item"
11380 .cindex "substring extraction"
11381 .cindex "expansion" "substring expansion"
11382 The &%substr%& operator is a simpler interface to the &%substr%& function that
11383 can be used when the two parameters are fixed numbers (as opposed to strings
11384 that change when expanded). The effect is the same as
11385 .code
11386 ${substr{<start>}{<length>}{<string>}}
11387 .endd
11388 See the description of the general &%substr%& item above for details. The
11389 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11390 All measurement is done in bytes and is not UTF-8 aware.
11391
11392 .vitem &*${time_eval:*&<&'string'&>&*}*&
11393 .cindex "&%time_eval%& expansion item"
11394 .cindex "time interval" "decoding"
11395 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11396 seconds.
11397
11398 .vitem &*${time_interval:*&<&'string'&>&*}*&
11399 .cindex "&%time_interval%& expansion item"
11400 .cindex "time interval" "formatting"
11401 The argument (after sub-expansion) must be a sequence of decimal digits that
11402 represents an interval of time as a number of seconds. It is converted into a
11403 number of larger units and output in Exim's normal time format, for example,
11404 &`1w3d4h2m6s`&.
11405
11406 .vitem &*${uc:*&<&'string'&>&*}*&
11407 .cindex "case forcing in strings"
11408 .cindex "string" "case forcing"
11409 .cindex "upper casing"
11410 .cindex "expansion" "case forcing"
11411 .cindex "&%uc%& expansion item"
11412 This forces the letters in the string into upper-case.
11413 Case is defined per the system C locale.
11414
11415 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11416 .cindex "correction of invalid utf-8 sequences in strings"
11417 .cindex "utf-8" "utf-8 sequences"
11418 .cindex "incorrect utf-8"
11419 .cindex "expansion" "utf-8 forcing"
11420 .cindex "&%utf8clean%& expansion item"
11421 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11422 In versions of Exim before 4.92, this did not correctly do so for a truncated
11423 final codepoint's encoding, and the character would be silently dropped.
11424 If you must handle detection of this scenario across both sets of Exim behavior,
11425 the complexity will depend upon the task.
11426 For instance, to detect if the first character is multibyte and a 1-byte
11427 extraction can be successfully used as a path component (as is common for
11428 dividing up delivery folders), you might use:
11429 .code
11430 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11431 .endd
11432 (which will false-positive if the first character of the local part is a
11433 literal question mark).
11434
11435 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11436        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11437        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11438        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11439 .cindex expansion UTF-8
11440 .cindex UTF-8 expansion
11441 .cindex EAI
11442 .cindex internationalisation
11443 .cindex "&%utf8_domain_to_alabel%& expansion item"
11444 .cindex "&%utf8_domain_from_alabel%& expansion item"
11445 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11446 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11447 These convert EAI mail name components between UTF-8 and a-label forms.
11448 For information on internationalisation support see &<<SECTi18nMTA>>&.
11449 .endlist
11450
11451
11452
11453
11454
11455
11456 .section "Expansion conditions" "SECTexpcond"
11457 .scindex IIDexpcond "expansion" "conditions"
11458 The following conditions are available for testing by the &%${if%& construct
11459 while expanding strings:
11460
11461 .vlist
11462 .vitem &*!*&<&'condition'&>
11463 .cindex "expansion" "negating a condition"
11464 .cindex "negation" "in expansion condition"
11465 Preceding any condition with an exclamation mark negates the result of the
11466 condition.
11467
11468 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11469 .cindex "numeric comparison"
11470 .cindex "expansion" "numeric comparison"
11471 There are a number of symbolic operators for doing numeric comparisons. They
11472 are:
11473 .itable none 0 0 2 10* left 90* left
11474 .irow "=   " "equal"
11475 .irow "==  " "equal"
11476 .irow ">   " "greater"
11477 .irow ">=  " "greater or equal"
11478 .irow "<   " "less"
11479 .irow "<=  " "less or equal"
11480 .endtable
11481 For example:
11482 .code
11483 ${if >{$message_size}{10M} ...
11484 .endd
11485 Note that the general negation operator provides for inequality testing. The
11486 two strings must take the form of optionally signed decimal integers,
11487 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11488 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11489 As a special case, the numerical value of an empty string is taken as
11490 zero.
11491
11492 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11493 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11494 10M, not if 10M is larger than &$message_size$&.
11495
11496
11497 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11498         {*&<&'arg2'&>&*}...}*&
11499 .cindex "expansion" "calling an acl"
11500 .cindex "&%acl%&" "expansion condition"
11501 The name and zero to nine argument strings are first expanded separately.  The expanded
11502 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11503 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11504 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11505 and may use the variables; if another acl expansion is used the values
11506 are restored after it returns.  If the ACL sets
11507 a value using a "message =" modifier the variable $value becomes
11508 the result of the expansion, otherwise it is empty.
11509 If the ACL returns accept the condition is true; if deny, false.
11510 If the ACL returns defer the result is a forced-fail.
11511
11512 .vitem &*bool&~{*&<&'string'&>&*}*&
11513 .cindex "expansion" "boolean parsing"
11514 .cindex "&%bool%& expansion condition"
11515 This condition turns a string holding a true or false representation into
11516 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11517 (case-insensitively); also integer numbers map to true if non-zero,
11518 false if zero.
11519 An empty string is treated as false.
11520 Leading and trailing whitespace is ignored;
11521 thus a string consisting only of whitespace is false.
11522 All other string values will result in expansion failure.
11523
11524 When combined with ACL variables, this expansion condition will let you
11525 make decisions in one place and act on those decisions in another place.
11526 For example:
11527 .code
11528 ${if bool{$acl_m_privileged_sender} ...
11529 .endd
11530
11531
11532 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11533 .cindex "expansion" "boolean parsing"
11534 .cindex "&%bool_lax%& expansion condition"
11535 Like &%bool%&, this condition turns a string into a boolean state.  But
11536 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11537 loose definition that the Router &%condition%& option uses.  The empty string
11538 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11539 true.  Leading and trailing whitespace is ignored.
11540
11541 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11542
11543 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11544 .cindex "expansion" "encrypted comparison"
11545 .cindex "encrypted strings, comparing"
11546 .cindex "&%crypteq%& expansion condition"
11547 This condition is included in the Exim binary if it is built to support any
11548 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11549 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11550 included in the binary.
11551
11552 The &%crypteq%& condition has two arguments. The first is encrypted and
11553 compared against the second, which is already encrypted. The second string may
11554 be in the LDAP form for storing encrypted strings, which starts with the
11555 encryption type in curly brackets, followed by the data. If the second string
11556 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11557 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11558 Typically this will be a field from a password file. An example of an encrypted
11559 string in LDAP form is:
11560 .code
11561 {md5}CY9rzUYh03PK3k6DJie09g==
11562 .endd
11563 If such a string appears directly in an expansion, the curly brackets have to
11564 be quoted, because they are part of the expansion syntax. For example:
11565 .code
11566 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11567 .endd
11568 The following encryption types (whose names are matched case-independently) are
11569 supported:
11570
11571 .ilist
11572 .cindex "MD5 hash"
11573 .cindex "base64 encoding" "in encrypted password"
11574 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11575 printable characters to compare with the remainder of the second string. If the
11576 length of the comparison string is 24, Exim assumes that it is base64 encoded
11577 (as in the above example). If the length is 32, Exim assumes that it is a
11578 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11579 comparison fails.
11580
11581 .next
11582 .cindex "SHA-1 hash"
11583 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11584 printable characters to compare with the remainder of the second string. If the
11585 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11586 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11587 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11588
11589 .next
11590 .cindex "&[crypt()]&"
11591 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11592 only the first eight characters of the password. However, in modern operating
11593 systems this is no longer true, and in many cases the entire password is used,
11594 whatever its length.
11595
11596 .next
11597 .cindex "&[crypt16()]&"
11598 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11599 use up to 16 characters of the password in some operating systems. Again, in
11600 modern operating systems, more characters may be used.
11601 .endlist
11602 Exim has its own version of &[crypt16()]&, which is just a double call to
11603 &[crypt()]&. For operating systems that have their own version, setting
11604 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11605 operating system version instead of its own. This option is set by default in
11606 the OS-dependent &_Makefile_& for those operating systems that are known to
11607 support &[crypt16()]&.
11608
11609 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11610 it was not using the same algorithm as some operating systems' versions. It
11611 turns out that as well as &[crypt16()]& there is a function called
11612 &[bigcrypt()]& in some operating systems. This may or may not use the same
11613 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11614
11615 However, since there is now a move away from the traditional &[crypt()]&
11616 functions towards using SHA1 and other algorithms, tidying up this area of
11617 Exim is seen as very low priority.
11618
11619 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11620 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11621 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11622 default is &`{crypt}`&. Whatever the default, you can always use either
11623 function by specifying it explicitly in curly brackets.
11624
11625 .vitem &*def:*&<&'variable&~name'&>
11626 .cindex "expansion" "checking for empty variable"
11627 .cindex "&%def%& expansion condition"
11628 The &%def%& condition must be followed by the name of one of the expansion
11629 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11630 variable does not contain the empty string. For example:
11631 .code
11632 ${if def:sender_ident {from $sender_ident}}
11633 .endd
11634 Note that the variable name is given without a leading &%$%& character. If the
11635 variable does not exist, the expansion fails.
11636
11637 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11638         &~&*def:h_*&<&'header&~name'&>&*:*&"
11639 .cindex "expansion" "checking header line existence"
11640 This condition is true if a message is being processed and the named header
11641 exists in the message. For example,
11642 .code
11643 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11644 .endd
11645 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11646 the header name must be terminated by a colon if white space does not follow.
11647
11648 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11649        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11650 .cindex "string" "comparison"
11651 .cindex "expansion" "string comparison"
11652 .cindex "&%eq%& expansion condition"
11653 .cindex "&%eqi%& expansion condition"
11654 The two substrings are first expanded. The condition is true if the two
11655 resulting strings are identical. For &%eq%& the comparison includes the case of
11656 letters, whereas for &%eqi%& the comparison is case-independent, where
11657 case is defined per the system C locale.
11658
11659 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11660 .cindex "expansion" "file existence test"
11661 .cindex "file" "existence test"
11662 .cindex "&%exists%&, expansion condition"
11663 The substring is first expanded and then interpreted as an absolute path. The
11664 condition is true if the named file (or directory) exists. The existence test
11665 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11666 users' filter files may be locked out by the system administrator.
11667
11668 &*Note:*& Testing a path using this condition is not a sufficient way of
11669 de-tainting it.
11670 Consider using a dsearch lookup.
11671
11672 .vitem &*first_delivery*&
11673 .cindex "delivery" "first"
11674 .cindex "first delivery"
11675 .cindex "expansion" "first delivery test"
11676 .cindex "&%first_delivery%& expansion condition"
11677 .cindex retry condition
11678 This condition, which has no data, is true during a message's first delivery
11679 attempt. It is false during any subsequent delivery attempts.
11680
11681
11682 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11683        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11684 .cindex "list" "iterative conditions"
11685 .cindex "expansion" "&*forall*& condition"
11686 .cindex "expansion" "&*forany*& condition"
11687 .vindex "&$item$&"
11688 These conditions iterate over a list. The first argument is expanded to form
11689 the list. By default, the list separator is a colon, but it can be changed by
11690 the normal method (&<<SECTlistsepchange>>&).
11691 The second argument is interpreted as a condition that is to
11692 be applied to each item in the list in turn. During the interpretation of the
11693 condition, the current list item is placed in a variable called &$item$&.
11694 .ilist
11695 For &*forany*&, interpretation stops if the condition is true for any item, and
11696 the result of the whole condition is true. If the condition is false for all
11697 items in the list, the overall condition is false.
11698 .next
11699 For &*forall*&, interpretation stops if the condition is false for any item,
11700 and the result of the whole condition is false. If the condition is true for
11701 all items in the list, the overall condition is true.
11702 .endlist
11703 Note that negation of &*forany*& means that the condition must be false for all
11704 items for the overall condition to succeed, and negation of &*forall*& means
11705 that the condition must be false for at least one item. In this example, the
11706 list separator is changed to a comma:
11707 .code
11708 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11709 .endd
11710 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11711 being processed, to enable these expansion items to be nested.
11712
11713 To scan a named list, expand it with the &*listnamed*& operator.
11714
11715 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11716        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11717        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11718        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11719 .cindex JSON "iterative conditions"
11720 .cindex JSON expansions
11721 .cindex expansion "&*forall_json*& condition"
11722 .cindex expansion "&*forany_json*& condition"
11723 .cindex expansion "&*forall_jsons*& condition"
11724 .cindex expansion "&*forany_jsons*& condition"
11725 As for the above, except that the first argument must, after expansion,
11726 be a JSON array.
11727 The array separator is not changeable.
11728 For the &"jsons"& variants the elements are expected to be JSON strings
11729 and have their quotes removed before the evaluation of the condition.
11730
11731
11732
11733 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11734        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11735 .cindex "string" "comparison"
11736 .cindex "expansion" "string comparison"
11737 .cindex "&%ge%& expansion condition"
11738 .cindex "&%gei%& expansion condition"
11739 The two substrings are first expanded. The condition is true if the first
11740 string is lexically greater than or equal to the second string. For &%ge%& the
11741 comparison includes the case of letters, whereas for &%gei%& the comparison is
11742 case-independent.
11743 Case and collation order are defined per the system C locale.
11744
11745 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11746        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11747 .cindex "string" "comparison"
11748 .cindex "expansion" "string comparison"
11749 .cindex "&%gt%& expansion condition"
11750 .cindex "&%gti%& expansion condition"
11751 The two substrings are first expanded. The condition is true if the first
11752 string is lexically greater than the second string. For &%gt%& the comparison
11753 includes the case of letters, whereas for &%gti%& the comparison is
11754 case-independent.
11755 Case and collation order are defined per the system C locale.
11756
11757
11758 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11759 SRS decode.  See SECT &<<SECTSRS>>& for details.
11760
11761
11762 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11763        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11764 .cindex "string" "comparison"
11765 .cindex "list" "iterative conditions"
11766 Both strings are expanded; the second string is treated as a list of simple
11767 strings; if the first string is a member of the second, then the condition
11768 is true.
11769 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11770
11771 These are simpler to use versions of the more powerful &*forany*& condition.
11772 Examples, and the &*forany*& equivalents:
11773 .code
11774 ${if inlist{needle}{foo:needle:bar}}
11775   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11776 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11777   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11778 .endd
11779
11780 The variable &$value$& will be set for a successful match and can be
11781 used in the success clause of an &%if%& expansion item using the condition.
11782 .cindex "tainted data" "de-tainting"
11783 .cindex "de-tainting" "using an inlist expansion condition"
11784 It will have the same taint status as the list; expansions such as
11785 .code
11786 ${if inlist {$h_mycode:} {0 : 1 : 42} {$value}}
11787 .endd
11788 can be used for de-tainting.
11789 Any previous &$value$& is restored after the if.
11790
11791
11792 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11793        &*isip4&~{*&<&'string'&>&*}*& &&&
11794        &*isip6&~{*&<&'string'&>&*}*&
11795 .cindex "IP address" "testing string format"
11796 .cindex "string" "testing for IP address"
11797 .cindex "&%isip%& expansion condition"
11798 .cindex "&%isip4%& expansion condition"
11799 .cindex "&%isip6%& expansion condition"
11800 The substring is first expanded, and then tested to see if it has the form of
11801 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11802 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11803
11804 For an IPv4 address, the test is for four dot-separated components, each of
11805 which consists of from one to three digits. For an IPv6 address, up to eight
11806 colon-separated components are permitted, each containing from one to four
11807 hexadecimal digits. There may be fewer than eight components if an empty
11808 component (adjacent colons) is present. Only one empty component is permitted.
11809
11810 &*Note*&: The checks used to be just on the form of the address; actual numerical
11811 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11812 check.
11813 This is no longer the case.
11814
11815 The main use of these tests is to distinguish between IP addresses and
11816 host names, or between IPv4 and IPv6 addresses. For example, you could use
11817 .code
11818 ${if isip4{$sender_host_address}...
11819 .endd
11820 to test which IP version an incoming SMTP connection is using.
11821
11822 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11823 .cindex "LDAP" "use for authentication"
11824 .cindex "expansion" "LDAP authentication test"
11825 .cindex "&%ldapauth%& expansion condition"
11826 This condition supports user authentication using LDAP. See section
11827 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11828 queries. For this use, the query must contain a user name and password. The
11829 query itself is not used, and can be empty. The condition is true if the
11830 password is not empty, and the user name and password are accepted by the LDAP
11831 server. An empty password is rejected without calling LDAP because LDAP binds
11832 with an empty password are considered anonymous regardless of the username, and
11833 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11834 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11835 this can be used.
11836
11837
11838 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11839        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11840 .cindex "string" "comparison"
11841 .cindex "expansion" "string comparison"
11842 .cindex "&%le%& expansion condition"
11843 .cindex "&%lei%& expansion condition"
11844 The two substrings are first expanded. The condition is true if the first
11845 string is lexically less than or equal to the second string. For &%le%& the
11846 comparison includes the case of letters, whereas for &%lei%& the comparison is
11847 case-independent.
11848 Case and collation order are defined per the system C locale.
11849
11850 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11851        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11852 .cindex "string" "comparison"
11853 .cindex "expansion" "string comparison"
11854 .cindex "&%lt%& expansion condition"
11855 .cindex "&%lti%& expansion condition"
11856 The two substrings are first expanded. The condition is true if the first
11857 string is lexically less than the second string. For &%lt%& the comparison
11858 includes the case of letters, whereas for &%lti%& the comparison is
11859 case-independent.
11860 Case and collation order are defined per the system C locale.
11861
11862
11863 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11864 .cindex "expansion" "regular expression comparison"
11865 .cindex "regular expressions" "match in expanded string"
11866 .cindex "&%match%& expansion condition"
11867 The two substrings are first expanded. The second is then treated as a regular
11868 expression and applied to the first. Because of the pre-expansion, if the
11869 regular expression contains dollar, or backslash characters, they must be
11870 escaped. Care must also be taken if the regular expression contains braces
11871 (curly brackets). A closing brace must be escaped so that it is not taken as a
11872 premature termination of <&'string2'&>. The easiest approach is to use the
11873 &`\N`& feature to disable expansion of the regular expression.
11874 For example,
11875 .code
11876 ${if match {$local_part}{\N^\d{3}\N} ...
11877 .endd
11878 If the whole expansion string is in double quotes, further escaping of
11879 backslashes is also required.
11880
11881 The condition is true if the regular expression match succeeds.
11882 The regular expression is not required to begin with a circumflex
11883 metacharacter, but if there is no circumflex, the expression is not anchored,
11884 and it may match anywhere in the subject, not just at the start. If you want
11885 the pattern to match at the end of the subject, you must include the &`$`&
11886 metacharacter at an appropriate point.
11887 All character handling is done in bytes and is not UTF-8 aware,
11888 but we might change this in a future Exim release.
11889
11890 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11891 At the start of an &%if%& expansion the values of the numeric variable
11892 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11893 succeeds causes them to be reset to the substrings of that condition and they
11894 will have these values during the expansion of the success string. At the end
11895 of the &%if%& expansion, the previous values are restored. After testing a
11896 combination of conditions using &%or%&, the subsequent values of the numeric
11897 variables are those of the condition that succeeded.
11898
11899 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11900 .cindex "&%match_address%& expansion condition"
11901 See &*match_local_part*&.
11902
11903 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11904 .cindex "&%match_domain%& expansion condition"
11905 See &*match_local_part*&.
11906
11907 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11908 .cindex "&%match_ip%& expansion condition"
11909 This condition matches an IP address to a list of IP address patterns. It must
11910 be followed by two argument strings. The first (after expansion) must be an IP
11911 address or an empty string. The second (not expanded) is a restricted host
11912 list that can match only an IP address, not a host name. For example:
11913 .code
11914 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11915 .endd
11916 The specific types of host list item that are permitted in the list are:
11917
11918 .ilist
11919 An IP address, optionally with a CIDR mask.
11920 .next
11921 A single asterisk, which matches any IP address.
11922 .next
11923 An empty item, which matches only if the IP address is empty. This could be
11924 useful for testing for a locally submitted message or one from specific hosts
11925 in a single test such as
11926 . ==== As this is a nested list, any displays it contains must be indented
11927 . ==== as otherwise they are too far to the left. This comment applies to
11928 . ==== the use of xmlto plus fop. There's no problem when formatting with
11929 . ==== sdop, with or without the extra indent.
11930 .code
11931   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11932 .endd
11933 where the first item in the list is the empty string.
11934 .next
11935 The item @[] matches any of the local host's interface addresses.
11936 .next
11937 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11938 even if &`net-`& is not specified. There is never any attempt to turn the IP
11939 address into a host name. The most common type of linear search for
11940 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11941 masks. For example:
11942 .code
11943   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11944 .endd
11945 It is of course possible to use other kinds of lookup, and in such a case, you
11946 do need to specify the &`net-`& prefix if you want to specify a specific
11947 address mask, for example:
11948 .code
11949   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11950 .endd
11951 However, unless you are combining a &%match_ip%& condition with others, it is
11952 just as easy to use the fact that a lookup is itself a condition, and write:
11953 .code
11954   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11955 .endd
11956 .endlist ilist
11957
11958 Note that <&'string2'&> is not itself subject to string expansion, unless
11959 Exim was built with the EXPAND_LISTMATCH_RHS option.
11960
11961 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11962
11963 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11964 .cindex "domain list" "in expansion condition"
11965 .cindex "address list" "in expansion condition"
11966 .cindex "local part" "list, in expansion condition"
11967 .cindex "&%match_local_part%& expansion condition"
11968 This condition, together with &%match_address%& and &%match_domain%&, make it
11969 possible to test domain, address, and local part lists within expansions. Each
11970 condition requires two arguments: an item and a list to match. A trivial
11971 example is:
11972 .code
11973 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11974 .endd
11975 In each case, the second argument may contain any of the allowable items for a
11976 list of the appropriate type. Also, because the second argument
11977 is a standard form of list, it is possible to refer to a named list.
11978 Thus, you can use conditions like this:
11979 .code
11980 ${if match_domain{$domain}{+local_domains}{...
11981 .endd
11982 .cindex "&`+caseful`&"
11983 For address lists, the matching starts off caselessly, but the &`+caseful`&
11984 item can be used, as in all address lists, to cause subsequent items to
11985 have their local parts matched casefully. Domains are always matched
11986 caselessly.
11987
11988 The variable &$value$& will be set for a successful match and can be
11989 used in the success clause of an &%if%& expansion item using the condition.
11990 .cindex "tainted data" "de-tainting"
11991 .cindex "de-tainting" "using a match_local_part expansion condition"
11992 It will have the same taint status as the list; expansions such as
11993 .code
11994 ${if match_local_part {$local_part} {alice : bill : charlotte : dave} {$value}}
11995 .endd
11996 can be used for de-tainting.
11997 Any previous &$value$& is restored after the if.
11998
11999 Note that <&'string2'&> is not itself subject to string expansion, unless
12000 Exim was built with the EXPAND_LISTMATCH_RHS option.
12001
12002 &*Note*&: Host lists are &'not'& supported in this way. This is because
12003 hosts have two identities: a name and an IP address, and it is not clear
12004 how to specify cleanly how such a test would work. However, IP addresses can be
12005 matched using &%match_ip%&.
12006
12007 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
12008 .cindex "PAM authentication"
12009 .cindex "AUTH" "with PAM"
12010 .cindex "Solaris" "PAM support"
12011 .cindex "expansion" "PAM authentication test"
12012 .cindex "&%pam%& expansion condition"
12013 &'Pluggable Authentication Modules'&
12014 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
12015 available in Solaris
12016 and in some GNU/Linux distributions.
12017 The Exim support, which is intended for use in conjunction with
12018 the SMTP AUTH command, is available only if Exim is compiled with
12019 .code
12020 SUPPORT_PAM=yes
12021 .endd
12022 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12023 in some releases of GNU/Linux &%-ldl%& is also needed.
12024
12025 The argument string is first expanded, and the result must be a
12026 colon-separated list of strings. Leading and trailing white space is ignored.
12027 The PAM module is initialized with the service name &"exim"& and the user name
12028 taken from the first item in the colon-separated data string (<&'string1'&>).
12029 The remaining items in the data string are passed over in response to requests
12030 from the authentication function. In the simple case there will only be one
12031 request, for a password, so the data consists of just two strings.
12032
12033 There can be problems if any of the strings are permitted to contain colon
12034 characters. In the usual way, these have to be doubled to avoid being taken as
12035 separators.
12036 The &%listquote%& expansion item can be used for this.
12037 For example, the configuration
12038 of a LOGIN authenticator might contain this setting:
12039 .code
12040 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12041 .endd
12042 In some operating systems, PAM authentication can be done only from a process
12043 running as root. Since Exim is running as the Exim user when receiving
12044 messages, this means that PAM cannot be used directly in those systems.
12045 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12046
12047
12048 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12049 .cindex "&'pwcheck'& daemon"
12050 .cindex "Cyrus"
12051 .cindex "expansion" "&'pwcheck'& authentication test"
12052 .cindex "&%pwcheck%& expansion condition"
12053 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12054 This is one way of making it possible for passwords to be checked by a process
12055 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12056 deprecated. Its replacement is &'saslauthd'& (see below).
12057
12058 The pwcheck support is not included in Exim by default. You need to specify
12059 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12060 building Exim. For example:
12061 .code
12062 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12063 .endd
12064 You do not need to install the full Cyrus software suite in order to use
12065 the pwcheck daemon. You can compile and install just the daemon alone
12066 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12067 access to the &_/var/pwcheck_& directory.
12068
12069 The &%pwcheck%& condition takes one argument, which must be the user name and
12070 password, separated by a colon. For example, in a LOGIN authenticator
12071 configuration, you might have this:
12072 .code
12073 server_condition = ${if pwcheck{$auth1:$auth2}}
12074 .endd
12075 Again, for a PLAIN authenticator configuration, this would be:
12076 .code
12077 server_condition = ${if pwcheck{$auth2:$auth3}}
12078 .endd
12079 .vitem &*queue_running*&
12080 .cindex "queue runner" "detecting when delivering from"
12081 .cindex "expansion" "queue runner test"
12082 .cindex "&%queue_running%& expansion condition"
12083 This condition, which has no data, is true during delivery attempts that are
12084 initiated by queue runner processes, and false otherwise.
12085
12086
12087 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12088 .cindex "Radius"
12089 .cindex "expansion" "Radius authentication"
12090 .cindex "&%radius%& expansion condition"
12091 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12092 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12093 the Radius client configuration file in order to build Exim with Radius
12094 support.
12095
12096 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12097 library, using the original API. If you are using release 0.4.0 or later of
12098 this library, you need to set
12099 .code
12100 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12101 .endd
12102 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12103 &%libradius%& library that comes with FreeBSD. To do this, set
12104 .code
12105 RADIUS_LIB_TYPE=RADLIB
12106 .endd
12107 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12108 You may also have to supply a suitable setting in EXTRALIBS so that the
12109 Radius library can be found when Exim is linked.
12110
12111 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12112 Radius client library, which calls the Radius server. The condition is true if
12113 the authentication is successful. For example:
12114 .code
12115 server_condition = ${if radius{<arguments>}}
12116 .endd
12117
12118
12119 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12120         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12121 .cindex "&'saslauthd'& daemon"
12122 .cindex "Cyrus"
12123 .cindex "expansion" "&'saslauthd'& authentication test"
12124 .cindex "&%saslauthd%& expansion condition"
12125 This condition supports user authentication using the Cyrus &'saslauthd'&
12126 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12127 Using this daemon is one way of making it possible for passwords to be checked
12128 by a process that is not running as root.
12129
12130 The saslauthd support is not included in Exim by default. You need to specify
12131 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12132 building Exim. For example:
12133 .code
12134 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12135 .endd
12136 You do not need to install the full Cyrus software suite in order to use
12137 the saslauthd daemon. You can compile and install just the daemon alone
12138 from the Cyrus SASL library.
12139
12140 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12141 two are mandatory. For example:
12142 .code
12143 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12144 .endd
12145 The service and the realm are optional (which is why the arguments are enclosed
12146 in their own set of braces). For details of the meaning of the service and
12147 realm, and how to run the daemon, consult the Cyrus documentation.
12148 .endlist vlist
12149
12150
12151
12152 .section "Combining expansion conditions" "SECID84"
12153 .cindex "expansion" "combining conditions"
12154 Several conditions can be tested at once by combining them using the &%and%&
12155 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12156 conditions on their own, and precede their lists of sub-conditions. Each
12157 sub-condition must be enclosed in braces within the overall braces that contain
12158 the list. No repetition of &%if%& is used.
12159
12160
12161 .vlist
12162 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12163 .cindex "&""or""& expansion condition"
12164 .cindex "expansion" "&""or""& of conditions"
12165 The sub-conditions are evaluated from left to right. The condition is true if
12166 any one of the sub-conditions is true.
12167 For example,
12168 .code
12169 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12170 .endd
12171 When a true sub-condition is found, the following ones are parsed but not
12172 evaluated. If there are several &"match"& sub-conditions the values of the
12173 numeric variables afterwards are taken from the first one that succeeds.
12174
12175 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12176 .cindex "&""and""& expansion condition"
12177 .cindex "expansion" "&""and""& of conditions"
12178 The sub-conditions are evaluated from left to right. The condition is true if
12179 all of the sub-conditions are true. If there are several &"match"&
12180 sub-conditions, the values of the numeric variables afterwards are taken from
12181 the last one. When a false sub-condition is found, the following ones are
12182 parsed but not evaluated.
12183 .endlist
12184 .ecindex IIDexpcond
12185
12186
12187
12188
12189 .section "Expansion variables" "SECTexpvar"
12190 .cindex "expansion" "variables, list of"
12191 This section contains an alphabetical list of all the expansion variables. Some
12192 of them are available only when Exim is compiled with specific options such as
12193 support for TLS or the content scanning extension.
12194 .cindex "tainted data"
12195 Variables marked as &'tainted'& are likely to carry data supplied by
12196 a potential attacker.
12197 Variables without such marking may also, depending on how their
12198 values are created.
12199 Such variables should not be further expanded,
12200 used as filenames
12201 or used as command-line arguments for external commands.
12202
12203 .vlist
12204 .vitem "&$0$&, &$1$&, etc"
12205 .cindex "numerical variables (&$1$& &$2$& etc)"
12206 When a &%match%& expansion condition succeeds, these variables contain the
12207 captured substrings identified by the regular expression during subsequent
12208 processing of the success string of the containing &%if%& expansion item.
12209 In the expansion condition case
12210 they do not retain their values afterwards; in fact, their previous
12211 values are restored at the end of processing an &%if%& item. The numerical
12212 variables may also be set externally by some other matching process which
12213 precedes the expansion of the string. For example, the commands available in
12214 Exim filter files include an &%if%& command with its own regular expression
12215 matching condition.
12216 If the subject string was tainted then any captured substring will also be.
12217
12218 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12219 Within an acl condition, expansion condition or expansion item
12220 any arguments are copied to these variables,
12221 any unused variables being made empty.
12222
12223 .vitem "&$acl_c...$&"
12224 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12225 can be given any name that starts with &$acl_c$& and is at least six characters
12226 long, but the sixth character must be either a digit or an underscore. For
12227 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12228 variables persist throughout the lifetime of an SMTP connection. They can be
12229 used to pass information between ACLs and between different invocations of the
12230 same ACL. When a message is received, the values of these variables are saved
12231 with the message, and can be accessed by filters, routers, and transports
12232 during subsequent delivery.
12233
12234 .vitem "&$acl_m...$&"
12235 These variables are like the &$acl_c...$& variables, except that their values
12236 are reset after a message has been received. Thus, if several messages are
12237 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12238 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12239 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12240 message is received, the values of these variables are saved with the message,
12241 and can be accessed by filters, routers, and transports during subsequent
12242 delivery.
12243
12244 .vitem &$acl_narg$&
12245 Within an acl condition, expansion condition or expansion item
12246 this variable has the number of arguments.
12247
12248 .vitem &$acl_verify_message$&
12249 .vindex "&$acl_verify_message$&"
12250 After an address verification has failed, this variable contains the failure
12251 message. It retains its value for use in subsequent modifiers of the verb.
12252 The message can be preserved by coding like this:
12253 .code
12254 warn !verify = sender
12255      set acl_m0 = $acl_verify_message
12256 .endd
12257 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12258 &%log_message%& modifiers, to include information about the verification
12259 failure.
12260 &*Note*&: The variable is cleared at the end of processing the ACL verb.
12261
12262 .vitem &$address_data$&
12263 .vindex "&$address_data$&"
12264 This variable is set by means of the &%address_data%& option in routers. The
12265 value then remains with the address while it is processed by subsequent routers
12266 and eventually a transport. If the transport is handling multiple addresses,
12267 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12268 for more details. &*Note*&: The contents of &$address_data$& are visible in
12269 user filter files.
12270
12271 If &$address_data$& is set when the routers are called from an ACL to verify
12272 a recipient address, the final value is still in the variable for subsequent
12273 conditions and modifiers of the ACL statement. If routing the address caused it
12274 to be redirected to just one address, the child address is also routed as part
12275 of the verification, and in this case the final value of &$address_data$& is
12276 from the child's routing.
12277
12278 If &$address_data$& is set when the routers are called from an ACL to verify a
12279 sender address, the final value is also preserved, but this time in
12280 &$sender_address_data$&, to distinguish it from data from a recipient
12281 address.
12282
12283 In both cases (recipient and sender verification), the value does not persist
12284 after the end of the current ACL statement. If you want to preserve
12285 these values for longer, you can save them in ACL variables.
12286
12287 .vitem &$address_file$&
12288 .vindex "&$address_file$&"
12289 When, as a result of aliasing, forwarding, or filtering, a message is directed
12290 to a specific file, this variable holds the name of the file when the transport
12291 is running. At other times, the variable is empty. For example, using the
12292 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12293 .code
12294 /home/r2d2/savemail
12295 .endd
12296 then when the &(address_file)& transport is running, &$address_file$&
12297 contains the text string &`/home/r2d2/savemail`&.
12298 .cindex "Sieve filter" "value of &$address_file$&"
12299 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12300 then up to the transport configuration to generate an appropriate absolute path
12301 to the relevant file.
12302
12303 .vitem &$address_pipe$&
12304 .vindex "&$address_pipe$&"
12305 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12306 this variable holds the pipe command when the transport is running.
12307
12308 .vitem "&$auth1$& &-- &$auth4$&"
12309 .vindex "&$auth1$&, &$auth2$&, etc"
12310 These variables are used in SMTP authenticators (see chapters
12311 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12312
12313 .vitem &$authenticated_id$&
12314 .cindex "authentication" "id"
12315 .vindex "&$authenticated_id$&"
12316 When a server successfully authenticates a client it may be configured to
12317 preserve some of the authentication information in the variable
12318 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12319 user/password authenticator configuration might preserve the user name for use
12320 in the routers. Note that this is not the same information that is saved in
12321 &$sender_host_authenticated$&.
12322
12323 When a message is submitted locally (that is, not over a TCP connection)
12324 the value of &$authenticated_id$& is normally the login name of the calling
12325 process. However, a trusted user can override this by means of the &%-oMai%&
12326 command line option.
12327 This second case also sets up information used by the
12328 &$authresults$& expansion item.
12329
12330 .vitem &$authenticated_fail_id$&
12331 .cindex "authentication" "fail" "id"
12332 .vindex "&$authenticated_fail_id$&"
12333 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12334 will contain the failed authentication id. If more than one authentication
12335 id is attempted, it will contain only the last one. The variable is
12336 available for processing in the ACL's, generally the quit or notquit ACL.
12337 A message to a local recipient could still be accepted without requiring
12338 authentication, which means this variable could also be visible in all of
12339 the ACL's as well.
12340
12341
12342 .tvar &$authenticated_sender$&
12343 .cindex "sender" "authenticated"
12344 .cindex "authentication" "sender"
12345 .cindex "AUTH" "on MAIL command"
12346 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12347 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12348 described in section &<<SECTauthparamail>>&. Unless the data is the string
12349 &"<>"&, it is set as the authenticated sender of the message, and the value is
12350 available during delivery in the &$authenticated_sender$& variable. If the
12351 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12352
12353 .vindex "&$qualify_domain$&"
12354 When a message is submitted locally (that is, not over a TCP connection), the
12355 value of &$authenticated_sender$& is an address constructed from the login
12356 name of the calling process and &$qualify_domain$&, except that a trusted user
12357 can override this by means of the &%-oMas%& command line option.
12358
12359
12360 .vitem &$authentication_failed$&
12361 .cindex "authentication" "failure"
12362 .vindex "&$authentication_failed$&"
12363 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12364 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12365 possible to distinguish between &"did not try to authenticate"&
12366 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12367 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12368 is empty and &$authentication_failed$& is set to &"1"&).
12369 Failure includes cancellation of a authentication attempt,
12370 and any negative response to an AUTH command,
12371 (including, for example, an attempt to use an undefined mechanism).
12372
12373 .vitem &$av_failed$&
12374 .cindex "content scanning" "AV scanner failure"
12375 This variable is available when Exim is compiled with the content-scanning
12376 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12377 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12378 the ACL malware condition.
12379
12380 .vitem &$body_linecount$&
12381 .cindex "message body" "line count"
12382 .cindex "body of message" "line count"
12383 .vindex "&$body_linecount$&"
12384 When a message is being received or delivered, this variable contains the
12385 number of lines in the message's body. See also &$message_linecount$&.
12386
12387 .vitem &$body_zerocount$&
12388 .cindex "message body" "binary zero count"
12389 .cindex "body of message" "binary zero count"
12390 .cindex "binary zero" "in message body"
12391 .vindex "&$body_zerocount$&"
12392 When a message is being received or delivered, this variable contains the
12393 number of binary zero bytes (ASCII NULs) in the message's body.
12394
12395 .vitem &$bounce_recipient$&
12396 .vindex "&$bounce_recipient$&"
12397 This is set to the recipient address of a bounce message while Exim is creating
12398 it. It is useful if a customized bounce message text file is in use (see
12399 chapter &<<CHAPemsgcust>>&).
12400
12401 .vitem &$bounce_return_size_limit$&
12402 .vindex "&$bounce_return_size_limit$&"
12403 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12404 up to a multiple of 1000. It is useful when a customized error message text
12405 file is in use (see chapter &<<CHAPemsgcust>>&).
12406
12407 .vitem &$caller_gid$&
12408 .cindex "gid (group id)" "caller"
12409 .vindex "&$caller_gid$&"
12410 The real group id under which the process that called Exim was running. This is
12411 not the same as the group id of the originator of a message (see
12412 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12413 incarnation normally contains the Exim gid.
12414
12415 .vitem &$caller_uid$&
12416 .cindex "uid (user id)" "caller"
12417 .vindex "&$caller_uid$&"
12418 The real user id under which the process that called Exim was running. This is
12419 not the same as the user id of the originator of a message (see
12420 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12421 incarnation normally contains the Exim uid.
12422
12423 .vitem &$callout_address$&
12424 .vindex "&$callout_address$&"
12425 After a callout for verification, spamd or malware daemon service, the
12426 address that was connected to.
12427
12428 .vitem &$compile_number$&
12429 .vindex "&$compile_number$&"
12430 The building process for Exim keeps a count of the number
12431 of times it has been compiled. This serves to distinguish different
12432 compilations of the same version of Exim.
12433
12434 .vitem &$config_dir$&
12435 .vindex "&$config_dir$&"
12436 The directory name of the main configuration file. That is, the content of
12437 &$config_file$& with the last component stripped. The value does not
12438 contain the trailing slash. If &$config_file$& does not contain a slash,
12439 &$config_dir$& is ".".
12440
12441 .vitem &$config_file$&
12442 .vindex "&$config_file$&"
12443 The name of the main configuration file Exim is using.
12444
12445 .vitem &$dkim_verify_status$&
12446 Results of DKIM verification.
12447 For details see section &<<SECDKIMVFY>>&.
12448
12449 .vitem &$dkim_cur_signer$& &&&
12450        &$dkim_verify_reason$& &&&
12451        &$dkim_domain$& &&&
12452        &$dkim_identity$& &&&
12453        &$dkim_selector$& &&&
12454        &$dkim_algo$& &&&
12455        &$dkim_canon_body$& &&&
12456        &$dkim_canon_headers$& &&&
12457        &$dkim_copiedheaders$& &&&
12458        &$dkim_bodylength$& &&&
12459        &$dkim_created$& &&&
12460        &$dkim_expires$& &&&
12461        &$dkim_headernames$& &&&
12462        &$dkim_key_testing$& &&&
12463        &$dkim_key_nosubdomains$& &&&
12464        &$dkim_key_srvtype$& &&&
12465        &$dkim_key_granularity$& &&&
12466        &$dkim_key_notes$& &&&
12467        &$dkim_key_length$&
12468 These variables are only available within the DKIM ACL.
12469 For details see section &<<SECDKIMVFY>>&.
12470
12471 .vitem &$dkim_signers$&
12472 .vindex &$dkim_signers$&
12473 When a message has been received this variable contains
12474 a colon-separated list of signer domains and identities for the message.
12475 For details see section &<<SECDKIMVFY>>&.
12476
12477 .vitem &$dmarc_domain_policy$& &&&
12478        &$dmarc_status$& &&&
12479        &$dmarc_status_text$& &&&
12480        &$dmarc_used_domains$&
12481 Results of DMARC verification.
12482 For details see section &<<SECDMARC>>&.
12483
12484 .vitem &$dnslist_domain$& &&&
12485        &$dnslist_matched$& &&&
12486        &$dnslist_text$& &&&
12487        &$dnslist_value$&
12488 .vindex "&$dnslist_domain$&"
12489 .vindex "&$dnslist_matched$&"
12490 .vindex "&$dnslist_text$&"
12491 .vindex "&$dnslist_value$&"
12492 .cindex "black list (DNS)"
12493 When a DNS (black) list lookup succeeds, these variables are set to contain
12494 the following data from the lookup: the list's domain name, the key that was
12495 looked up, the contents of any associated TXT record, and the value from the
12496 main A record. See section &<<SECID204>>& for more details.
12497
12498 .tvar &$domain$&
12499 When an address is being routed, or delivered on its own, this variable
12500 contains the domain. Uppercase letters in the domain are converted into lower
12501 case for &$domain$&.
12502
12503 Global address rewriting happens when a message is received, so the value of
12504 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12505 is set during user filtering, but not during system filtering, because a
12506 message may have many recipients and the system filter is called just once.
12507
12508 When more than one address is being delivered at once (for example, several
12509 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12510 have the same domain. Transports can be restricted to handling only one domain
12511 at a time if the value of &$domain$& is required at transport time &-- this is
12512 the default for local transports. For further details of the environment in
12513 which local transports are run, see chapter &<<CHAPenvironment>>&.
12514
12515 .oindex "&%delay_warning_condition%&"
12516 At the end of a delivery, if all deferred addresses have the same domain, it is
12517 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12518
12519 The &$domain$& variable is also used in some other circumstances:
12520
12521 .ilist
12522 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12523 the recipient address. The domain of the &'sender'& address is in
12524 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12525 normally set during the running of the MAIL ACL. However, if the sender address
12526 is verified with a callout during the MAIL ACL, the sender domain is placed in
12527 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12528 the &(smtp)& transport.
12529
12530 .next
12531 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12532 &$domain$& contains the domain portion of the address that is being rewritten;
12533 it can be used in the expansion of the replacement address, for example, to
12534 rewrite domains by file lookup.
12535
12536 .next
12537 With one important exception, whenever a domain list is being scanned,
12538 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12539 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12540 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12541 that, in a RCPT ACL, the sender domain list can be dependent on the
12542 recipient domain (which is what is in &$domain$& at this time).
12543
12544 .next
12545 .cindex "ETRN" "value of &$domain$&"
12546 .oindex "&%smtp_etrn_command%&"
12547 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12548 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12549 .endlist
12550
12551 .cindex "tainted data"
12552 If the origin of the data is an incoming message,
12553 the result of expanding this variable is tainted and may not
12554 be further expanded or used as a filename.
12555 When an untainted version is needed, one should be obtained from
12556 looking up the value in a local (therefore trusted) database.
12557 Often &$domain_data$& is usable in this role.
12558
12559
12560 .vitem &$domain_data$&
12561 .vindex "&$domain_data$&"
12562 When the &%domains%& condition on a router
12563 or an ACL
12564 matches a domain
12565 against a list, the match value is copied to &$domain_data$&.
12566 This is an enhancement over previous versions of Exim, when it only
12567 applied to the data read by a lookup.
12568 For details on match values see section &<<SECTlistresults>>& et. al.
12569
12570 If the router routes the
12571 address to a transport, the value is available in that transport. If the
12572 transport is handling multiple addresses, the value from the first address is
12573 used.
12574
12575 &$domain_data$& set in an ACL is available during
12576 the rest of the ACL statement.
12577
12578 .vitem &$exim_gid$&
12579 .vindex "&$exim_gid$&"
12580 This variable contains the numerical value of the Exim group id.
12581
12582 .vitem &$exim_path$&
12583 .vindex "&$exim_path$&"
12584 This variable contains the path to the Exim binary.
12585
12586 .vitem &$exim_uid$&
12587 .vindex "&$exim_uid$&"
12588 This variable contains the numerical value of the Exim user id.
12589
12590 .vitem &$exim_version$&
12591 .vindex "&$exim_version$&"
12592 This variable contains the version string of the Exim build.
12593 The first character is a major version number, currently 4.
12594 Then after a dot, the next group of digits is a minor version number.
12595 There may be other characters following the minor version.
12596 This value may be overridden by the &%exim_version%& main config option.
12597
12598 .vitem &$header_$&<&'name'&>
12599 .tmark
12600 This is not strictly an expansion variable. It is expansion syntax for
12601 inserting the message header line with the given name. Note that the name must
12602 be terminated by colon or white space, because it may contain a wide variety of
12603 characters. Note also that braces must &'not'& be used.
12604 See the full description in section &<<SECTexpansionitems>>& above.
12605
12606 .vitem &$headers_added$&
12607 .vindex "&$headers_added$&"
12608 Within an ACL this variable contains the headers added so far by
12609 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12610 The headers are a newline-separated list.
12611
12612 .vitem &$home$&
12613 .vindex "&$home$&"
12614 When the &%check_local_user%& option is set for a router, the user's home
12615 directory is placed in &$home$& when the check succeeds. In particular, this
12616 means it is set during the running of users' filter files. A router may also
12617 explicitly set a home directory for use by a transport; this can be overridden
12618 by a setting on the transport itself.
12619
12620 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12621 of the environment variable HOME, which is subject to the
12622 &%keep_environment%& and &%add_environment%& main config options.
12623
12624 .vitem &$host$&
12625 .vindex "&$host$&"
12626 If a router assigns an address to a transport (any transport), and passes a
12627 list of hosts with the address, the value of &$host$& when the transport starts
12628 to run is the name of the first host on the list. Note that this applies both
12629 to local and remote transports.
12630
12631 .cindex "transport" "filter"
12632 .cindex "filter" "transport filter"
12633 For the &(smtp)& transport, if there is more than one host, the value of
12634 &$host$& changes as the transport works its way through the list. In
12635 particular, when the &(smtp)& transport is expanding its options for encryption
12636 using TLS, or for specifying a transport filter (see chapter
12637 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12638 is connected.
12639
12640 When used in the client part of an authenticator configuration (see chapter
12641 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12642 client is connected.
12643
12644
12645 .vitem &$host_address$&
12646 .vindex "&$host_address$&"
12647 This variable is set to the remote host's IP address whenever &$host$& is set
12648 for a remote connection. It is also set to the IP address that is being checked
12649 when the &%ignore_target_hosts%& option is being processed.
12650
12651 .vitem &$host_data$&
12652 .vindex "&$host_data$&"
12653 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12654 result of the lookup is made available in the &$host_data$& variable. This
12655 allows you, for example, to do things like this:
12656 .code
12657 deny  hosts = net-lsearch;/some/file
12658       message = $host_data
12659 .endd
12660
12661 .vitem &$host_lookup_deferred$&
12662 .cindex "host name" "lookup, failure of"
12663 .vindex "&$host_lookup_deferred$&"
12664 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12665 message comes from a remote host and there is an attempt to look up the host's
12666 name from its IP address, and the attempt is not successful, one of these
12667 variables is set to &"1"&.
12668
12669 .ilist
12670 If the lookup receives a definite negative response (for example, a DNS lookup
12671 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12672
12673 .next
12674 If there is any kind of problem during the lookup, such that Exim cannot
12675 tell whether or not the host name is defined (for example, a timeout for a DNS
12676 lookup), &$host_lookup_deferred$& is set to &"1"&.
12677 .endlist ilist
12678
12679 Looking up a host's name from its IP address consists of more than just a
12680 single reverse lookup. Exim checks that a forward lookup of at least one of the
12681 names it receives from a reverse lookup yields the original IP address. If this
12682 is not the case, Exim does not accept the looked up name(s), and
12683 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12684 IP address (for example, the existence of a PTR record in the DNS) is not
12685 sufficient on its own for the success of a host name lookup. If the reverse
12686 lookup succeeds, but there is a lookup problem such as a timeout when checking
12687 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12688 &"1"&. See also &$sender_host_name$&.
12689
12690 .cindex authentication "expansion item"
12691 Performing these checks sets up information used by the
12692 &%authresults%& expansion item.
12693
12694
12695 .vitem &$host_lookup_failed$&
12696 .vindex "&$host_lookup_failed$&"
12697 See &$host_lookup_deferred$&.
12698
12699 .vitem &$host_port$&
12700 .vindex "&$host_port$&"
12701 This variable is set to the remote host's TCP port whenever &$host$& is set
12702 for an outbound connection.
12703
12704 .vitem &$initial_cwd$&
12705 .vindex "&$initial_cwd$&
12706 This variable contains the full path name of the initial working
12707 directory of the current Exim process. This may differ from the current
12708 working directory, as Exim changes this to "/" during early startup, and
12709 to &$spool_directory$& later.
12710
12711 .vitem &$inode$&
12712 .vindex "&$inode$&"
12713 The only time this variable is set is while expanding the &%directory_file%&
12714 option in the &(appendfile)& transport. The variable contains the inode number
12715 of the temporary file which is about to be renamed. It can be used to construct
12716 a unique name for the file.
12717
12718 .vitem &$interface_address$& &&&
12719        &$interface_port$&
12720 .vindex "&$interface_address$&"
12721 .vindex "&$interface_port$&"
12722 These are obsolete names for &$received_ip_address$& and &$received_port$&.
12723
12724 .vitem &$item$&
12725 .vindex "&$item$&"
12726 This variable is used during the expansion of &*forall*& and &*forany*&
12727 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12728 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12729 empty.
12730
12731 .vitem &$ldap_dn$&
12732 .vindex "&$ldap_dn$&"
12733 This variable, which is available only when Exim is compiled with LDAP support,
12734 contains the DN from the last entry in the most recently successful LDAP
12735 lookup.
12736
12737 .vitem &$load_average$&
12738 .vindex "&$load_average$&"
12739 This variable contains the system load average, multiplied by 1000 so that it
12740 is an integer. For example, if the load average is 0.21, the value of the
12741 variable is 210. The value is recomputed every time the variable is referenced.
12742
12743 .tvar &$local_part$&
12744 When an address is being routed, or delivered on its own, this
12745 variable contains the local part. When a number of addresses are being
12746 delivered together (for example, multiple RCPT commands in an SMTP
12747 session), &$local_part$& is not set.
12748
12749 Global address rewriting happens when a message is received, so the value of
12750 &$local_part$& during routing and delivery is the value after rewriting.
12751 &$local_part$& is set during user filtering, but not during system filtering,
12752 because a message may have many recipients and the system filter is called just
12753 once.
12754
12755 .cindex "tainted data"
12756 If the origin of the data is an incoming message,
12757 the result of expanding this variable is tainted and
12758 may not be further expanded or used as a filename.
12759
12760 &*Warning*&: the content of this variable is usually provided by a potential
12761 attacker.
12762 Consider carefully the implications of using it unvalidated as a name
12763 for file access.
12764 This presents issues for users' &_.forward_& and filter files.
12765 For traditional full user accounts, use &%check_local_users%& and the
12766 &$local_part_data$& variable rather than this one.
12767 For virtual users, store a suitable pathname component in the database
12768 which is used for account name validation, and use that retrieved value
12769 rather than this variable.
12770 Often &$local_part_data$& is usable in this role.
12771 If needed, use a router &%address_data%& or &%set%& option for
12772 the retrieved data.
12773
12774 When a message is being delivered to a file, pipe, or autoreply transport as a
12775 result of aliasing or forwarding, &$local_part$& is set to the local part of
12776 the parent address, not to the filename or command (see &$address_file$& and
12777 &$address_pipe$&).
12778
12779 When an ACL is running for a RCPT command, &$local_part$& contains the
12780 local part of the recipient address.
12781
12782 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12783 &$local_part$& contains the local part of the address that is being rewritten;
12784 it can be used in the expansion of the replacement address, for example.
12785
12786 In all cases, all quoting is removed from the local part. For example, for both
12787 the addresses
12788 .code
12789 "abc:xyz"@test.example
12790 abc\:xyz@test.example
12791 .endd
12792 the value of &$local_part$& is
12793 .code
12794 abc:xyz
12795 .endd
12796 If you use &$local_part$& to create another address, you should always wrap it
12797 inside a quoting operator. For example, in a &(redirect)& router you could
12798 have:
12799 .code
12800 data = ${quote_local_part:$local_part}@new.domain.example
12801 .endd
12802 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12803 to process local parts in a case-dependent manner in a router, you can set the
12804 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12805
12806 .vitem &$local_part_data$&
12807 .vindex "&$local_part_data$&"
12808 When the &%local_parts%& condition on a router or ACL
12809 matches a local part list
12810 the match value is copied to &$local_part_data$&.
12811 This is an enhancement over previous versions of Exim, when it only
12812 applied to the data read by a lookup.
12813 For details on match values see section &<<SECTlistresults>>& et. al.
12814
12815 The &%check_local_user%& router option also sets this variable.
12816
12817 .vindex &$local_part_prefix$& &&&
12818         &$local_part_prefix_v$& &&&
12819         &$local_part_suffix$& &&&
12820         &$local_part_suffix_v$&
12821 .cindex affix variables
12822 If a local part prefix or suffix has been recognized, it is not included in the
12823 value of &$local_part$& during routing and subsequent delivery. The values of
12824 any prefix or suffix are in &$local_part_prefix$& and
12825 &$local_part_suffix$&, respectively.
12826 .cindex "tainted data"
12827 If the specification did not include a wildcard then
12828 the affix variable value is not tainted.
12829
12830 If the affix specification included a wildcard then the portion of
12831 the affix matched by the wildcard is in
12832 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12833 and both the whole and varying values are tainted.
12834
12835 .vitem &$local_scan_data$&
12836 .vindex "&$local_scan_data$&"
12837 This variable contains the text returned by the &[local_scan()]& function when
12838 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12839
12840 .vitem &$local_user_gid$&
12841 .vindex "&$local_user_gid$&"
12842 See &$local_user_uid$&.
12843
12844 .vitem &$local_user_uid$&
12845 .vindex "&$local_user_uid$&"
12846 This variable and &$local_user_gid$& are set to the uid and gid after the
12847 &%check_local_user%& router precondition succeeds. This means that their values
12848 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12849 and &%condition%&), for the &%address_data%& expansion, and for any
12850 router-specific expansions. At all other times, the values in these variables
12851 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12852
12853 .vitem &$localhost_number$&
12854 .vindex "&$localhost_number$&"
12855 This contains the expanded value of the
12856 &%localhost_number%& option. The expansion happens after the main options have
12857 been read.
12858
12859 .vitem &$log_inodes$&
12860 .vindex "&$log_inodes$&"
12861 The number of free inodes in the disk partition where Exim's
12862 log files are being written. The value is recalculated whenever the variable is
12863 referenced. If the relevant file system does not have the concept of inodes,
12864 the value of is -1. See also the &%check_log_inodes%& option.
12865
12866 .vitem &$log_space$&
12867 .vindex "&$log_space$&"
12868 The amount of free space (as a number of kilobytes) in the disk
12869 partition where Exim's log files are being written. The value is recalculated
12870 whenever the variable is referenced. If the operating system does not have the
12871 ability to find the amount of free space (only true for experimental systems),
12872 the space value is -1. See also the &%check_log_space%& option.
12873
12874
12875 .vitem &$lookup_dnssec_authenticated$&
12876 .vindex "&$lookup_dnssec_authenticated$&"
12877 This variable is set after a DNS lookup done by
12878 a dnsdb lookup expansion, dnslookup router or smtp transport.
12879 .cindex "DNS" "DNSSEC"
12880 It will be empty if &(DNSSEC)& was not requested,
12881 &"no"& if the result was not labelled as authenticated data
12882 and &"yes"& if it was.
12883 Results that are labelled as authoritative answer that match
12884 the &%dns_trust_aa%& configuration variable count also
12885 as authenticated data.
12886
12887 .vitem &$mailstore_basename$&
12888 .vindex "&$mailstore_basename$&"
12889 This variable is set only when doing deliveries in &"mailstore"& format in the
12890 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12891 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12892 contains the basename of the files that are being written, that is, the name
12893 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12894 variable is empty.
12895
12896 .vitem &$malware_name$&
12897 .vindex "&$malware_name$&"
12898 This variable is available when Exim is compiled with the
12899 content-scanning extension. It is set to the name of the virus that was found
12900 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12901
12902 .vitem &$max_received_linelength$&
12903 .vindex "&$max_received_linelength$&"
12904 .cindex "maximum" "line length"
12905 .cindex "line length" "maximum"
12906 This variable contains the number of bytes in the longest line that was
12907 received as part of the message, not counting the line termination
12908 character(s).
12909 It is not valid if the &%spool_wireformat%& option is used.
12910
12911 .vitem &$message_age$&
12912 .cindex "message" "age of"
12913 .vindex "&$message_age$&"
12914 This variable is set at the start of a delivery attempt to contain the number
12915 of seconds since the message was received. It does not change during a single
12916 delivery attempt.
12917
12918 .tvar &$message_body$&
12919 .cindex "body of message" "expansion variable"
12920 .cindex "message body" "in expansion"
12921 .cindex "binary zero" "in message body"
12922 .oindex "&%message_body_visible%&"
12923 This variable contains the initial portion of a message's body while it is
12924 being delivered, and is intended mainly for use in filter files. The maximum
12925 number of characters of the body that are put into the variable is set by the
12926 &%message_body_visible%& configuration option; the default is 500.
12927
12928 .oindex "&%message_body_newlines%&"
12929 By default, newlines are converted into spaces in &$message_body$&, to make it
12930 easier to search for phrases that might be split over a line break. However,
12931 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12932 zeros are always converted into spaces.
12933
12934 .tvar &$message_body_end$&
12935 .cindex "body of message" "expansion variable"
12936 .cindex "message body" "in expansion"
12937 This variable contains the final portion of a message's
12938 body while it is being delivered. The format and maximum size are as for
12939 &$message_body$&.
12940
12941 .vitem &$message_body_size$&
12942 .cindex "body of message" "size"
12943 .cindex "message body" "size"
12944 .vindex "&$message_body_size$&"
12945 When a message is being delivered, this variable contains the size of the body
12946 in bytes. The count starts from the character after the blank line that
12947 separates the body from the header. Newlines are included in the count. See
12948 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12949
12950 If the spool file is wireformat
12951 (see the &%spool_wireformat%& main option)
12952 the CRLF line-terminators are included in the count.
12953
12954 .vitem &$message_exim_id$&
12955 .vindex "&$message_exim_id$&"
12956 When a message is being received or delivered, this variable contains the
12957 unique message id that is generated and used by Exim to identify the message.
12958 An id is not created for a message until after its header has been successfully
12959 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12960 line; it is the local id that Exim assigns to the message, for example:
12961 &`1BXTIK-0001yO-VA`&.
12962
12963 .tvar &$message_headers$&
12964 This variable contains a concatenation of all the header lines when a message
12965 is being processed, except for lines added by routers or transports. The header
12966 lines are separated by newline characters. Their contents are decoded in the
12967 same way as a header line that is inserted by &%bheader%&.
12968
12969 .tvar &$message_headers_raw$&
12970 This variable is like &$message_headers$& except that no processing of the
12971 contents of header lines is done.
12972
12973 .vitem &$message_id$&
12974 This is an old name for &$message_exim_id$&. It is now deprecated.
12975
12976 .vitem &$message_linecount$&
12977 .vindex "&$message_linecount$&"
12978 This variable contains the total number of lines in the header and body of the
12979 message. Compare &$body_linecount$&, which is the count for the body only.
12980 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12981 number of lines received. Before delivery happens (that is, before filters,
12982 routers, and transports run) the count is increased to include the
12983 &'Received:'& header line that Exim standardly adds, and also any other header
12984 lines that are added by ACLs. The blank line that separates the message header
12985 from the body is not counted.
12986
12987 As with the special case of &$message_size$&, during the expansion of the
12988 appendfile transport's maildir_tag option in maildir format, the value of
12989 &$message_linecount$& is the precise size of the number of newlines in the
12990 file that has been written (minus one for the blank line between the
12991 header and the body).
12992
12993 Here is an example of the use of this variable in a DATA ACL:
12994 .code
12995 deny condition = \
12996       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12997      message   = Too many lines in message header
12998 .endd
12999 In the MAIL and RCPT ACLs, the value is zero because at that stage the
13000 message has not yet been received.
13001
13002 This variable is not valid if the &%spool_wireformat%& option is used.
13003
13004 .vitem &$message_size$&
13005 .cindex "size" "of message"
13006 .cindex "message" "size"
13007 .vindex "&$message_size$&"
13008 When a message is being processed, this variable contains its size in bytes. In
13009 most cases, the size includes those headers that were received with the
13010 message, but not those (such as &'Envelope-to:'&) that are added to individual
13011 deliveries as they are written. However, there is one special case: during the
13012 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
13013 doing a delivery in maildir format, the value of &$message_size$& is the
13014 precise size of the file that has been written. See also
13015 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
13016
13017 .cindex "RCPT" "value of &$message_size$&"
13018 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13019 contains the size supplied on the MAIL command, or -1 if no size was given. The
13020 value may not, of course, be truthful.
13021
13022 .vitem &$mime_anomaly_level$& &&&
13023        &$mime_anomaly_text$& &&&
13024        &$mime_boundary$& &&&
13025        &$mime_charset$& &&&
13026        &$mime_content_description$& &&&
13027        &$mime_content_disposition$& &&&
13028        &$mime_content_id$& &&&
13029        &$mime_content_size$& &&&
13030        &$mime_content_transfer_encoding$& &&&
13031        &$mime_content_type$& &&&
13032        &$mime_decoded_filename$& &&&
13033        &$mime_filename$& &&&
13034        &$mime_is_coverletter$& &&&
13035        &$mime_is_multipart$& &&&
13036        &$mime_is_rfc822$& &&&
13037        &$mime_part_count$&
13038 A number of variables whose names start with &$mime$& are
13039 available when Exim is compiled with the content-scanning extension. For
13040 details, see section &<<SECTscanmimepart>>&.
13041
13042 .vitem "&$n0$& &-- &$n9$&"
13043 These variables are counters that can be incremented by means
13044 of the &%add%& command in filter files.
13045
13046 .tvar &$original_domain$&
13047 .vindex "&$domain$&"
13048 When a top-level address is being processed for delivery, this contains the
13049 same value as &$domain$&. However, if a &"child"& address (for example,
13050 generated by an alias, forward, or filter file) is being processed, this
13051 variable contains the domain of the original address (lower cased). This
13052 differs from &$parent_domain$& only when there is more than one level of
13053 aliasing or forwarding. When more than one address is being delivered in a
13054 single transport run, &$original_domain$& is not set.
13055
13056 If a new address is created by means of a &%deliver%& command in a system
13057 filter, it is set up with an artificial &"parent"& address. This has the local
13058 part &'system-filter'& and the default qualify domain.
13059
13060 .tvar &$original_local_part$&
13061 .vindex "&$local_part$&"
13062 When a top-level address is being processed for delivery, this contains the
13063 same value as &$local_part$&, unless a prefix or suffix was removed from the
13064 local part, because &$original_local_part$& always contains the full local
13065 part. When a &"child"& address (for example, generated by an alias, forward, or
13066 filter file) is being processed, this variable contains the full local part of
13067 the original address.
13068
13069 If the router that did the redirection processed the local part
13070 case-insensitively, the value in &$original_local_part$& is in lower case.
13071 This variable differs from &$parent_local_part$& only when there is more than
13072 one level of aliasing or forwarding. When more than one address is being
13073 delivered in a single transport run, &$original_local_part$& is not set.
13074
13075 If a new address is created by means of a &%deliver%& command in a system
13076 filter, it is set up with an artificial &"parent"& address. This has the local
13077 part &'system-filter'& and the default qualify domain.
13078
13079 .vitem &$originator_gid$&
13080 .cindex "gid (group id)" "of originating user"
13081 .cindex "sender" "gid"
13082 .vindex "&$caller_gid$&"
13083 .vindex "&$originator_gid$&"
13084 This variable contains the value of &$caller_gid$& that was set when the
13085 message was received. For messages received via the command line, this is the
13086 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13087 normally the gid of the Exim user.
13088
13089 .vitem &$originator_uid$&
13090 .cindex "uid (user id)" "of originating user"
13091 .cindex "sender" "uid"
13092 .vindex "&$caller_uid$&"
13093 .vindex "&$originator_uid$&"
13094 The value of &$caller_uid$& that was set when the message was received. For
13095 messages received via the command line, this is the uid of the sending user.
13096 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13097 user.
13098
13099 .tvar &$parent_domain$&
13100 This variable is similar to &$original_domain$& (see
13101 above), except that it refers to the immediately preceding parent address.
13102
13103 .tvar &$parent_local_part$&
13104 This variable is similar to &$original_local_part$&
13105 (see above), except that it refers to the immediately preceding parent address.
13106
13107 .vitem &$pid$&
13108 .cindex "pid (process id)" "of current process"
13109 .vindex "&$pid$&"
13110 This variable contains the current process id.
13111
13112 .vitem &$pipe_addresses$&
13113 .cindex "filter" "transport filter"
13114 .cindex "transport" "filter"
13115 .vindex "&$pipe_addresses$&"
13116 This is not an expansion variable, but is mentioned here because the string
13117 &`$pipe_addresses`& is handled specially in the command specification for the
13118 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13119 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13120 It cannot be used in general expansion strings, and provokes an &"unknown
13121 variable"& error if encountered.
13122 &*Note*&: This value permits data supplied by a potential attacker to
13123 be used in the command for a &(pipe)& transport.
13124 Such configurations should be carefully assessed for security vulnerbilities.
13125
13126 .vitem &$primary_hostname$&
13127 .vindex "&$primary_hostname$&"
13128 This variable contains the value set by &%primary_hostname%& in the
13129 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13130 a single-component name, Exim calls &[gethostbyname()]& (or
13131 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13132 qualified host name. See also &$smtp_active_hostname$&.
13133
13134
13135 .vitem &$proxy_external_address$& &&&
13136        &$proxy_external_port$& &&&
13137        &$proxy_local_address$& &&&
13138        &$proxy_local_port$& &&&
13139        &$proxy_session$&
13140 These variables are only available when built with Proxy Protocol
13141 or SOCKS5 support.
13142 For details see chapter &<<SECTproxyInbound>>&.
13143
13144 .vitem &$prdr_requested$&
13145 .cindex "PRDR" "variable for"
13146 This variable is set to &"yes"& if PRDR was requested by the client for the
13147 current message, otherwise &"no"&.
13148
13149 .vitem &$prvscheck_address$& &&&
13150        &$prvscheck_keynum$& &&&
13151        &$prvscheck_result$&
13152 These variables are used in conjunction with the &%prvscheck%& expansion item,
13153 which is described in sections &<<SECTexpansionitems>>& and
13154 &<<SECTverifyPRVS>>&.
13155
13156 .vitem &$qualify_domain$&
13157 .vindex "&$qualify_domain$&"
13158 The value set for the &%qualify_domain%& option in the configuration file.
13159
13160 .vitem &$qualify_recipient$&
13161 .vindex "&$qualify_recipient$&"
13162 The value set for the &%qualify_recipient%& option in the configuration file,
13163 or if not set, the value of &$qualify_domain$&.
13164
13165 .vitem &$queue_name$&
13166 .vindex &$queue_name$&
13167 .cindex "named queues" variable
13168 .cindex queues named
13169 The name of the spool queue in use; empty for the default queue.
13170
13171 .vitem &$queue_size$&
13172 .vindex "&$queue_size$&"
13173 .cindex "queue" "size of"
13174 .cindex "spool" "number of messages"
13175 This variable contains the number of messages queued.
13176 It is evaluated on demand, but no more often than once every minute.
13177 If there is no daemon notifier socket open, the value will be
13178 an empty string.
13179
13180 .vitem &$r_...$&
13181 .vindex &$r_...$&
13182 .cindex router variables
13183 Values can be placed in these variables by the &%set%& option of a router.
13184 They can be given any name that starts with &$r_$&.
13185 The values persist for the address being handled through subsequent routers
13186 and the eventual transport.
13187
13188 .vitem &$rcpt_count$&
13189 .vindex "&$rcpt_count$&"
13190 When a message is being received by SMTP, this variable contains the number of
13191 RCPT commands received for the current message. If this variable is used in a
13192 RCPT ACL, its value includes the current command.
13193
13194 .vitem &$rcpt_defer_count$&
13195 .vindex "&$rcpt_defer_count$&"
13196 .cindex "4&'xx'& responses" "count of"
13197 When a message is being received by SMTP, this variable contains the number of
13198 RCPT commands in the current message that have previously been rejected with a
13199 temporary (4&'xx'&) response.
13200
13201 .vitem &$rcpt_fail_count$&
13202 .vindex "&$rcpt_fail_count$&"
13203 When a message is being received by SMTP, this variable contains the number of
13204 RCPT commands in the current message that have previously been rejected with a
13205 permanent (5&'xx'&) response.
13206
13207 .vitem &$received_count$&
13208 .vindex "&$received_count$&"
13209 This variable contains the number of &'Received:'& header lines in the message,
13210 including the one added by Exim (so its value is always greater than zero). It
13211 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13212 delivering.
13213
13214 .tvar &$received_for$&
13215 If there is only a single recipient address in an incoming message, this
13216 variable contains that address when the &'Received:'& header line is being
13217 built. The value is copied after recipient rewriting has happened, but before
13218 the &[local_scan()]& function is run.
13219
13220 .vitem &$received_ip_address$& &&&
13221        &$received_port$&
13222 .vindex "&$received_ip_address$&"
13223 .vindex "&$received_port$&"
13224 As soon as an Exim server starts processing an incoming TCP/IP connection, these
13225 variables are set to the address and port on the local IP interface.
13226 (The remote IP address and port are in
13227 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13228 the port value is -1 unless it has been set using the &%-oMi%& command line
13229 option.
13230
13231 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13232 could be used, for example, to make the filename for a TLS certificate depend
13233 on which interface and/or port is being used for the incoming connection. The
13234 values of &$received_ip_address$& and &$received_port$& are saved with any
13235 messages that are received, thus making these variables available at delivery
13236 time.
13237 For outbound connections see &$sending_ip_address$&.
13238
13239 .vitem &$received_protocol$&
13240 .vindex "&$received_protocol$&"
13241 When a message is being processed, this variable contains the name of the
13242 protocol by which it was received. Most of the names used by Exim are defined
13243 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13244 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13245 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13246 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13247 connection and the client was successfully authenticated.
13248
13249 Exim uses the protocol name &"smtps"& for the case when encryption is
13250 automatically set up on connection without the use of STARTTLS (see
13251 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13252 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13253 where the client initially uses EHLO, sets up an encrypted connection using
13254 STARTTLS, and then uses HELO afterwards.
13255
13256 The &%-oMr%& option provides a way of specifying a custom protocol name for
13257 messages that are injected locally by trusted callers. This is commonly used to
13258 identify messages that are being re-injected after some kind of scanning.
13259
13260 .vitem &$received_time$&
13261 .vindex "&$received_time$&"
13262 This variable contains the date and time when the current message was received,
13263 as a number of seconds since the start of the Unix epoch.
13264
13265 .vitem &$recipient_data$&
13266 .vindex "&$recipient_data$&"
13267 This variable is set after an indexing lookup success in an ACL &%recipients%&
13268 condition. It contains the data from the lookup, and the value remains set
13269 until the next &%recipients%& test. Thus, you can do things like this:
13270 .display
13271 &`require recipients  = cdb*@;/some/file`&
13272 &`deny    `&&'some further test involving'& &`$recipient_data`&
13273 .endd
13274 &*Warning*&: This variable is set only when a lookup is used as an indexing
13275 method in the address list, using the semicolon syntax as in the example above.
13276 The variable is not set for a lookup that is used as part of the string
13277 expansion that all such lists undergo before being interpreted.
13278
13279 .vitem &$recipient_verify_failure$&
13280 .vindex "&$recipient_verify_failure$&"
13281 In an ACL, when a recipient verification fails, this variable contains
13282 information about the failure. It is set to one of the following words:
13283
13284 .ilist
13285 &"qualify"&: The address was unqualified (no domain), and the message
13286 was neither local nor came from an exempted host.
13287
13288 .next
13289 &"route"&: Routing failed.
13290
13291 .next
13292 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13293 or before the MAIL command (that is, on initial connection, HELO, or
13294 MAIL).
13295
13296 .next
13297 &"recipient"&: The RCPT command in a callout was rejected.
13298 .next
13299
13300 &"postmaster"&: The postmaster check in a callout was rejected.
13301 .endlist
13302
13303 The main use of this variable is expected to be to distinguish between
13304 rejections of MAIL and rejections of RCPT.
13305
13306 .tvar &$recipients$&
13307 This variable contains a list of envelope recipients for a message. A comma and
13308 a space separate the addresses in the replacement text. However, the variable
13309 is not generally available, to prevent exposure of Bcc recipients in
13310 unprivileged users' filter files. You can use &$recipients$& only in these
13311 cases:
13312
13313 .olist
13314 In a system filter file.
13315 .next
13316 In the ACLs associated with the DATA command and with non-SMTP messages, that
13317 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13318 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13319 &%acl_not_smtp_mime%&.
13320 .next
13321 From within a &[local_scan()]& function.
13322 .endlist
13323
13324
13325 .vitem &$recipients_count$&
13326 .vindex "&$recipients_count$&"
13327 When a message is being processed, this variable contains the number of
13328 envelope recipients that came with the message. Duplicates are not excluded
13329 from the count. While a message is being received over SMTP, the number
13330 increases for each accepted recipient. It can be referenced in an ACL.
13331
13332
13333 .vitem &$regex_match_string$&
13334 .vindex "&$regex_match_string$&"
13335 This variable is set to contain the matching regular expression after a
13336 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13337
13338 .vitem "&$regex1$&, &$regex2$&, etc"
13339 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13340 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13341 these variables contain the
13342 captured substrings identified by the regular expression.
13343 If the subject string was tainted then so will any captured substring.
13344
13345
13346 .tvar &$reply_address$&
13347 When a message is being processed, this variable contains the contents of the
13348 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13349 contents of the &'From:'& header line. Apart from the removal of leading
13350 white space, the value is not processed in any way. In particular, no RFC 2047
13351 decoding or character code translation takes place.
13352
13353 .vitem &$return_path$&
13354 .vindex "&$return_path$&"
13355 When a message is being delivered, this variable contains the return path &--
13356 the sender field that will be sent as part of the envelope. It is not enclosed
13357 in <> characters. At the start of routing an address, &$return_path$& has the
13358 same value as &$sender_address$&, but if, for example, an incoming message to a
13359 mailing list has been expanded by a router which specifies a different address
13360 for bounce messages, &$return_path$& subsequently contains the new bounce
13361 address, whereas &$sender_address$& always contains the original sender address
13362 that was received with the message. In other words, &$sender_address$& contains
13363 the incoming envelope sender, and &$return_path$& contains the outgoing
13364 envelope sender.
13365
13366 .vitem &$return_size_limit$&
13367 .vindex "&$return_size_limit$&"
13368 This is an obsolete name for &$bounce_return_size_limit$&.
13369
13370 .vitem &$router_name$&
13371 .cindex "router" "name"
13372 .cindex "name" "of router"
13373 .vindex "&$router_name$&"
13374 During the running of a router this variable contains its name.
13375
13376 .vitem &$runrc$&
13377 .cindex "return code" "from &%run%& expansion"
13378 .vindex "&$runrc$&"
13379 This variable contains the return code from a command that is run by the
13380 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13381 assume the order in which option values are expanded, except for those
13382 preconditions whose order of testing is documented. Therefore, you cannot
13383 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13384 another.
13385
13386 .vitem &$self_hostname$&
13387 .oindex "&%self%&" "value of host name"
13388 .vindex "&$self_hostname$&"
13389 When an address is routed to a supposedly remote host that turns out to be the
13390 local host, what happens is controlled by the &%self%& generic router option.
13391 One of its values causes the address to be passed to another router. When this
13392 happens, &$self_hostname$& is set to the name of the local host that the
13393 original router encountered. In other circumstances its contents are null.
13394
13395 .tvar &$sender_address$&
13396 When a message is being processed, this variable contains the sender's address
13397 that was received in the message's envelope. The case of letters in the address
13398 is retained, in both the local part and the domain. For bounce messages, the
13399 value of this variable is the empty string. See also &$return_path$&.
13400
13401 .vitem &$sender_address_data$&
13402 .vindex "&$address_data$&"
13403 .vindex "&$sender_address_data$&"
13404 If &$address_data$& is set when the routers are called from an ACL to verify a
13405 sender address, the final value is preserved in &$sender_address_data$&, to
13406 distinguish it from data from a recipient address. The value does not persist
13407 after the end of the current ACL statement. If you want to preserve it for
13408 longer, you can save it in an ACL variable.
13409
13410 .tvar &$sender_address_domain$&
13411 The domain portion of &$sender_address$&.
13412
13413 .tvar &$sender_address_local_part$&
13414 The local part portion of &$sender_address$&.
13415
13416 .vitem &$sender_data$&
13417 .vindex "&$sender_data$&"
13418 This variable is set after a lookup success in an ACL &%senders%& condition or
13419 in a router &%senders%& option. It contains the data from the lookup, and the
13420 value remains set until the next &%senders%& test. Thus, you can do things like
13421 this:
13422 .display
13423 &`require senders      = cdb*@;/some/file`&
13424 &`deny    `&&'some further test involving'& &`$sender_data`&
13425 .endd
13426 &*Warning*&: This variable is set only when a lookup is used as an indexing
13427 method in the address list, using the semicolon syntax as in the example above.
13428 The variable is not set for a lookup that is used as part of the string
13429 expansion that all such lists undergo before being interpreted.
13430
13431 .vitem &$sender_fullhost$&
13432 .vindex "&$sender_fullhost$&"
13433 When a message is received from a remote host, this variable contains the host
13434 name and IP address in a single string. It ends with the IP address in square
13435 brackets, followed by a colon and a port number if the logging of ports is
13436 enabled. The format of the rest of the string depends on whether the host
13437 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13438 looking up its IP address. (Looking up the IP address can be forced by the
13439 &%host_lookup%& option, independent of verification.) A plain host name at the
13440 start of the string is a verified host name; if this is not present,
13441 verification either failed or was not requested. A host name in parentheses is
13442 the argument of a HELO or EHLO command. This is omitted if it is identical to
13443 the verified host name or to the host's IP address in square brackets.
13444
13445 .vitem &$sender_helo_dnssec$&
13446 .vindex "&$sender_helo_dnssec$&"
13447 This boolean variable is true if a successful HELO verification was
13448 .cindex "DNS" "DNSSEC"
13449 done using DNS information the resolver library stated was authenticated data.
13450
13451 .tvar &$sender_helo_name$&
13452 When a message is received from a remote host that has issued a HELO or EHLO
13453 command, the argument of that command is placed in this variable. It is also
13454 set if HELO or EHLO is used when a message is received using SMTP locally via
13455 the &%-bs%& or &%-bS%& options.
13456
13457 .vitem &$sender_host_address$&
13458 .vindex "&$sender_host_address$&"
13459 When a message is received from a remote host using SMTP,
13460 this variable contains that
13461 host's IP address. For locally non-SMTP submitted messages, it is empty.
13462
13463 .vitem &$sender_host_authenticated$&
13464 .vindex "&$sender_host_authenticated$&"
13465 This variable contains the name (not the public name) of the authenticator
13466 driver that successfully authenticated the client from which the message was
13467 received. It is empty if there was no successful authentication. See also
13468 &$authenticated_id$&.
13469
13470 .vitem &$sender_host_dnssec$&
13471 .vindex "&$sender_host_dnssec$&"
13472 If an attempt to populate &$sender_host_name$& has been made
13473 (by reference, &%hosts_lookup%& or
13474 otherwise) then this boolean will have been set true if, and only if, the
13475 resolver library states that both
13476 the reverse and forward DNS were authenticated data.  At all
13477 other times, this variable is false.
13478
13479 .cindex "DNS" "DNSSEC"
13480 It is likely that you will need to coerce DNSSEC support on in the resolver
13481 library, by setting:
13482 .code
13483 dns_dnssec_ok = 1
13484 .endd
13485
13486 In addition, on Linux with glibc 2.31 or newer the resolver library will
13487 default to stripping out a successful validation status.
13488 This will break a previously working Exim installation.
13489 Provided that you do trust the resolver (ie, is on localhost) you can tell
13490 glibc to pass through any successful validation with a new option in
13491 &_/etc/resolv.conf_&:
13492 .code
13493 options trust-ad
13494 .endd
13495
13496 Exim does not perform DNSSEC validation itself, instead leaving that to a
13497 validating resolver (e.g. unbound, or bind with suitable configuration).
13498
13499 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13500 mechanism in the list, then this variable will be false.
13501
13502 This requires that your system resolver library support EDNS0 (and that
13503 DNSSEC flags exist in the system headers).  If the resolver silently drops
13504 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13505 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13506
13507
13508 .tvar &$sender_host_name$&
13509 When a message is received from a remote host, this variable contains the
13510 host's name as obtained by looking up its IP address. For messages received by
13511 other means, this variable is empty.
13512
13513 .vindex "&$host_lookup_failed$&"
13514 If the host name has not previously been looked up, a reference to
13515 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13516 A looked up name is accepted only if it leads back to the original IP address
13517 via a forward lookup. If either the reverse or the forward lookup fails to find
13518 any data, or if the forward lookup does not yield the original IP address,
13519 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13520
13521 .vindex "&$host_lookup_deferred$&"
13522 However, if either of the lookups cannot be completed (for example, there is a
13523 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13524 &$host_lookup_failed$& remains set to &"0"&.
13525
13526 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13527 host name again if there is a subsequent reference to &$sender_host_name$&
13528 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13529 is set to &"1"&.
13530
13531 Exim does not automatically look up every calling host's name. If you want
13532 maximum efficiency, you should arrange your configuration so that it avoids
13533 these lookups altogether. The lookup happens only if one or more of the
13534 following are true:
13535
13536 .ilist
13537 A string containing &$sender_host_name$& is expanded.
13538 .next
13539 The calling host matches the list in &%host_lookup%&. In the default
13540 configuration, this option is set to *, so it must be changed if lookups are
13541 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13542 .next
13543 Exim needs the host name in order to test an item in a host list. The items
13544 that require this are described in sections &<<SECThoslispatnam>>& and
13545 &<<SECThoslispatnamsk>>&.
13546 .next
13547 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13548 In this case, the host name is required to compare with the name quoted in any
13549 EHLO or HELO commands that the client issues.
13550 .next
13551 The remote host issues a EHLO or HELO command that quotes one of the
13552 domains in &%helo_lookup_domains%&. The default value of this option is
13553 . ==== As this is a nested list, any displays it contains must be indented
13554 . ==== as otherwise they are too far to the left.
13555 .code
13556   helo_lookup_domains = @ : @[]
13557 .endd
13558 which causes a lookup if a remote host (incorrectly) gives the server's name or
13559 IP address in an EHLO or HELO command.
13560 .endlist
13561
13562
13563 .vitem &$sender_host_port$&
13564 .vindex "&$sender_host_port$&"
13565 When a message is received from a remote host, this variable contains the port
13566 number that was used on the remote host.
13567
13568 .vitem &$sender_ident$&
13569 .vindex "&$sender_ident$&"
13570 When a message is received from a remote host, this variable contains the
13571 identification received in response to an RFC 1413 request. When a message has
13572 been received locally, this variable contains the login name of the user that
13573 called Exim.
13574
13575 .vitem &$sender_rate_$&&'xxx'&
13576 A number of variables whose names begin &$sender_rate_$& are set as part of the
13577 &%ratelimit%& ACL condition. Details are given in section
13578 &<<SECTratelimiting>>&.
13579
13580 .vitem &$sender_rcvhost$&
13581 .cindex "DNS" "reverse lookup"
13582 .cindex "reverse DNS lookup"
13583 .vindex "&$sender_rcvhost$&"
13584 This is provided specifically for use in &'Received:'& headers. It starts with
13585 either the verified host name (as obtained from a reverse DNS lookup) or, if
13586 there is no verified host name, the IP address in square brackets. After that
13587 there may be text in parentheses. When the first item is a verified host name,
13588 the first thing in the parentheses is the IP address in square brackets,
13589 followed by a colon and a port number if port logging is enabled. When the
13590 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13591 the parentheses.
13592
13593 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13594 was used and its argument was not identical to the real host name or IP
13595 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13596 all three items are present in the parentheses, a newline and tab are inserted
13597 into the string, to improve the formatting of the &'Received:'& header.
13598
13599 .vitem &$sender_verify_failure$&
13600 .vindex "&$sender_verify_failure$&"
13601 In an ACL, when a sender verification fails, this variable contains information
13602 about the failure. The details are the same as for
13603 &$recipient_verify_failure$&.
13604
13605 .vitem &$sending_ip_address$&
13606 .vindex "&$sending_ip_address$&"
13607 This variable is set whenever an outgoing SMTP connection to another host has
13608 been set up. It contains the IP address of the local interface that is being
13609 used. This is useful if a host that has more than one IP address wants to take
13610 on different personalities depending on which one is being used. For incoming
13611 connections, see &$received_ip_address$&.
13612
13613 .vitem &$sending_port$&
13614 .vindex "&$sending_port$&"
13615 This variable is set whenever an outgoing SMTP connection to another host has
13616 been set up. It contains the local port that is being used. For incoming
13617 connections, see &$received_port$&.
13618
13619 .vitem &$smtp_active_hostname$&
13620 .vindex "&$smtp_active_hostname$&"
13621 During an incoming SMTP session, this variable contains the value of the active
13622 host name, as specified by the &%smtp_active_hostname%& option. The value of
13623 &$smtp_active_hostname$& is saved with any message that is received, so its
13624 value can be consulted during routing and delivery.
13625
13626 .tvar &$smtp_command$&
13627 During the processing of an incoming SMTP command, this variable contains the
13628 entire command. This makes it possible to distinguish between HELO and EHLO in
13629 the HELO ACL, and also to distinguish between commands such as these:
13630 .code
13631 MAIL FROM:<>
13632 MAIL FROM: <>
13633 .endd
13634 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13635 command, the address in &$smtp_command$& is the original address before any
13636 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13637 the address after SMTP-time rewriting.
13638
13639 .tvar &$smtp_command_argument$&
13640 .cindex "SMTP" "command, argument for"
13641 While an ACL is running to check an SMTP command, this variable contains the
13642 argument, that is, the text that follows the command name, with leading white
13643 space removed. Following the introduction of &$smtp_command$&, this variable is
13644 somewhat redundant, but is retained for backwards compatibility.
13645
13646 .vitem &$smtp_command_history$&
13647 .cindex SMTP "command history"
13648 .vindex "&$smtp_command_history$&"
13649 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13650 received, in time-order left to right.  Only a limited number of commands
13651 are remembered.
13652
13653 .vitem &$smtp_count_at_connection_start$&
13654 .vindex "&$smtp_count_at_connection_start$&"
13655 This variable is set greater than zero only in processes spawned by the Exim
13656 daemon for handling incoming SMTP connections. The name is deliberately long,
13657 in order to emphasize what the contents are. When the daemon accepts a new
13658 connection, it increments this variable. A copy of the variable is passed to
13659 the child process that handles the connection, but its value is fixed, and
13660 never changes. It is only an approximation of how many incoming connections
13661 there actually are, because many other connections may come and go while a
13662 single connection is being processed. When a child process terminates, the
13663 daemon decrements its copy of the variable.
13664
13665 .vitem "&$sn0$& &-- &$sn9$&"
13666 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13667 that were current at the end of the system filter file. This allows a system
13668 filter file to set values that can be tested in users' filter files. For
13669 example, a system filter could set a value indicating how likely it is that a
13670 message is junk mail.
13671
13672 .vitem &$spam_score$& &&&
13673        &$spam_score_int$& &&&
13674        &$spam_bar$& &&&
13675        &$spam_report$& &&&
13676        &$spam_action$&
13677 A number of variables whose names start with &$spam$& are available when Exim
13678 is compiled with the content-scanning extension. For details, see section
13679 &<<SECTscanspamass>>&.
13680
13681 .vitem &$spf_header_comment$& &&&
13682        &$spf_received$& &&&
13683        &$spf_result$& &&&
13684        &$spf_result_guessed$& &&&
13685        &$spf_smtp_comment$&
13686 These variables are only available if Exim is built with SPF support.
13687 For details see section &<<SECSPF>>&.
13688
13689 .vitem &$spool_directory$&
13690 .vindex "&$spool_directory$&"
13691 The name of Exim's spool directory.
13692
13693 .vitem &$spool_inodes$&
13694 .vindex "&$spool_inodes$&"
13695 The number of free inodes in the disk partition where Exim's spool files are
13696 being written. The value is recalculated whenever the variable is referenced.
13697 If the relevant file system does not have the concept of inodes, the value of
13698 is -1. See also the &%check_spool_inodes%& option.
13699
13700 .vitem &$spool_space$&
13701 .vindex "&$spool_space$&"
13702 The amount of free space (as a number of kilobytes) in the disk partition where
13703 Exim's spool files are being written. The value is recalculated whenever the
13704 variable is referenced. If the operating system does not have the ability to
13705 find the amount of free space (only true for experimental systems), the space
13706 value is -1. For example, to check in an ACL that there is at least 50
13707 megabytes free on the spool, you could write:
13708 .code
13709 condition = ${if > {$spool_space}{50000}}
13710 .endd
13711 See also the &%check_spool_space%& option.
13712
13713
13714 .vitem &$thisaddress$&
13715 .vindex "&$thisaddress$&"
13716 This variable is set only during the processing of the &%foranyaddress%&
13717 command in a filter file. Its use is explained in the description of that
13718 command, which can be found in the separate document entitled &'Exim's
13719 interfaces to mail filtering'&.
13720
13721 .vitem &$tls_in_bits$&
13722 .vindex "&$tls_in_bits$&"
13723 Contains an approximation of the TLS cipher's bit-strength
13724 on the inbound connection; the meaning of
13725 this depends upon the TLS implementation used.
13726 If TLS has not been negotiated, the value will be 0.
13727 The value of this is automatically fed into the Cyrus SASL authenticator
13728 when acting as a server, to specify the "external SSF" (a SASL term).
13729
13730 The deprecated &$tls_bits$& variable refers to the inbound side
13731 except when used in the context of an outbound SMTP delivery, when it refers to
13732 the outbound.
13733
13734 .vitem &$tls_out_bits$&
13735 .vindex "&$tls_out_bits$&"
13736 Contains an approximation of the TLS cipher's bit-strength
13737 on an outbound SMTP connection; the meaning of
13738 this depends upon the TLS implementation used.
13739 If TLS has not been negotiated, the value will be 0.
13740
13741 .vitem &$tls_in_ourcert$&
13742 .vindex "&$tls_in_ourcert$&"
13743 .cindex certificate variables
13744 This variable refers to the certificate presented to the peer of an
13745 inbound connection when the message was received.
13746 It is only useful as the argument of a
13747 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13748 or a &%def%& condition.
13749
13750 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13751 when a list of more than one
13752 file is used for &%tls_certificate%&, this variable is not reliable.
13753 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13754
13755 .vitem &$tls_in_peercert$&
13756 .vindex "&$tls_in_peercert$&"
13757 This variable refers to the certificate presented by the peer of an
13758 inbound connection when the message was received.
13759 It is only useful as the argument of a
13760 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13761 or a &%def%& condition.
13762 If certificate verification fails it may refer to a failing chain element
13763 which is not the leaf.
13764
13765 .vitem &$tls_out_ourcert$&
13766 .vindex "&$tls_out_ourcert$&"
13767 This variable refers to the certificate presented to the peer of an
13768 outbound connection.  It is only useful as the argument of a
13769 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13770 or a &%def%& condition.
13771
13772 .vitem &$tls_out_peercert$&
13773 .vindex "&$tls_out_peercert$&"
13774 This variable refers to the certificate presented by the peer of an
13775 outbound connection.  It is only useful as the argument of a
13776 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13777 or a &%def%& condition.
13778 If certificate verification fails it may refer to a failing chain element
13779 which is not the leaf.
13780
13781 .vitem &$tls_in_certificate_verified$&
13782 .vindex "&$tls_in_certificate_verified$&"
13783 This variable is set to &"1"& if a TLS certificate was verified when the
13784 message was received, and &"0"& otherwise.
13785
13786 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13787 except when used in the context of an outbound SMTP delivery, when it refers to
13788 the outbound.
13789
13790 .vitem &$tls_out_certificate_verified$&
13791 .vindex "&$tls_out_certificate_verified$&"
13792 This variable is set to &"1"& if a TLS certificate was verified when an
13793 outbound SMTP connection was made,
13794 and &"0"& otherwise.
13795
13796 .vitem &$tls_in_cipher$&
13797 .vindex "&$tls_in_cipher$&"
13798 .vindex "&$tls_cipher$&"
13799 When a message is received from a remote host over an encrypted SMTP
13800 connection, this variable is set to the cipher suite that was negotiated, for
13801 example DES-CBC3-SHA. In other circumstances, in particular, for message
13802 received over unencrypted connections, the variable is empty. Testing
13803 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13804 non-encrypted connections during ACL processing.
13805
13806 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13807 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13808 becomes the same as &$tls_out_cipher$&.
13809
13810 .vitem &$tls_in_cipher_std$&
13811 .vindex "&$tls_in_cipher_std$&"
13812 As above, but returning the RFC standard name for the cipher suite.
13813
13814 .vitem &$tls_out_cipher$&
13815 .vindex "&$tls_out_cipher$&"
13816 This variable is
13817 cleared before any outgoing SMTP connection is made,
13818 and then set to the outgoing cipher suite if one is negotiated. See chapter
13819 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13820 details of the &(smtp)& transport.
13821
13822 .vitem &$tls_out_cipher_std$&
13823 .vindex "&$tls_out_cipher_std$&"
13824 As above, but returning the RFC standard name for the cipher suite.
13825
13826 .vitem &$tls_out_dane$&
13827 .vindex &$tls_out_dane$&
13828 DANE active status.  See section &<<SECDANE>>&.
13829
13830 .vitem &$tls_in_ocsp$&
13831 .vindex "&$tls_in_ocsp$&"
13832 When a message is received from a remote client connection
13833 the result of any OCSP request from the client is encoded in this variable:
13834 .code
13835 0 OCSP proof was not requested (default value)
13836 1 No response to request
13837 2 Response not verified
13838 3 Verification failed
13839 4 Verification succeeded
13840 .endd
13841
13842 .vitem &$tls_out_ocsp$&
13843 .vindex "&$tls_out_ocsp$&"
13844 When a message is sent to a remote host connection
13845 the result of any OCSP request made is encoded in this variable.
13846 See &$tls_in_ocsp$& for values.
13847
13848 .vitem &$tls_in_peerdn$&
13849 .vindex "&$tls_in_peerdn$&"
13850 .vindex "&$tls_peerdn$&"
13851 .cindex certificate "extracting fields"
13852 When a message is received from a remote host over an encrypted SMTP
13853 connection, and Exim is configured to request a certificate from the client,
13854 the value of the Distinguished Name of the certificate is made available in the
13855 &$tls_in_peerdn$& during subsequent processing.
13856 If certificate verification fails it may refer to a failing chain element
13857 which is not the leaf.
13858
13859 The deprecated &$tls_peerdn$& variable refers to the inbound side
13860 except when used in the context of an outbound SMTP delivery, when it refers to
13861 the outbound.
13862
13863 .vitem &$tls_out_peerdn$&
13864 .vindex "&$tls_out_peerdn$&"
13865 When a message is being delivered to a remote host over an encrypted SMTP
13866 connection, and Exim is configured to request a certificate from the server,
13867 the value of the Distinguished Name of the certificate is made available in the
13868 &$tls_out_peerdn$& during subsequent processing.
13869 If certificate verification fails it may refer to a failing chain element
13870 which is not the leaf.
13871
13872
13873 .vitem &$tls_in_resumption$& &&&
13874        &$tls_out_resumption$&
13875 .vindex &$tls_in_resumption$&
13876 .vindex &$tls_out_resumption$&
13877 .cindex TLS resumption
13878 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
13879
13880
13881 .tvar &$tls_in_sni$&
13882 .vindex "&$tls_sni$&"
13883 .cindex "TLS" "Server Name Indication"
13884 .cindex "TLS" SNI
13885 .cindex SNI "observability on server"
13886 When a TLS session is being established, if the client sends the Server
13887 Name Indication extension, the value will be placed in this variable.
13888 If the variable appears in &%tls_certificate%& then this option and
13889 some others, described in &<<SECTtlssni>>&,
13890 will be re-expanded early in the TLS session, to permit
13891 a different certificate to be presented (and optionally a different key to be
13892 used) to the client, based upon the value of the SNI extension.
13893
13894 The deprecated &$tls_sni$& variable refers to the inbound side
13895 except when used in the context of an outbound SMTP delivery, when it refers to
13896 the outbound.
13897
13898 .vitem &$tls_out_sni$&
13899 .vindex "&$tls_out_sni$&"
13900 .cindex "TLS" "Server Name Indication"
13901 .cindex "TLS" SNI
13902 .cindex SNI "observability in client"
13903 During outbound
13904 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13905 the transport.
13906
13907 .vitem &$tls_out_tlsa_usage$&
13908 .vindex &$tls_out_tlsa_usage$&
13909 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13910
13911 .vitem &$tls_in_ver$&
13912 .vindex "&$tls_in_ver$&"
13913 When a message is received from a remote host over an encrypted SMTP connection
13914 this variable is set to the protocol version, eg &'TLS1.2'&.
13915
13916 .vitem &$tls_out_ver$&
13917 .vindex "&$tls_out_ver$&"
13918 When a message is being delivered to a remote host over an encrypted SMTP connection
13919 this variable is set to the protocol version.
13920
13921
13922 .vitem &$tod_bsdinbox$&
13923 .vindex "&$tod_bsdinbox$&"
13924 The time of day and the date, in the format required for BSD-style mailbox
13925 files, for example: Thu Oct 17 17:14:09 1995.
13926
13927 .vitem &$tod_epoch$&
13928 .vindex "&$tod_epoch$&"
13929 The time and date as a number of seconds since the start of the Unix epoch.
13930
13931 .vitem &$tod_epoch_l$&
13932 .vindex "&$tod_epoch_l$&"
13933 The time and date as a number of microseconds since the start of the Unix epoch.
13934
13935 .vitem &$tod_full$&
13936 .vindex "&$tod_full$&"
13937 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13938 +0100. The timezone is always given as a numerical offset from UTC, with
13939 positive values used for timezones that are ahead (east) of UTC, and negative
13940 values for those that are behind (west).
13941
13942 .vitem &$tod_log$&
13943 .vindex "&$tod_log$&"
13944 The time and date in the format used for writing Exim's log files, for example:
13945 1995-10-12 15:32:29, but without a timezone.
13946
13947 .vitem &$tod_logfile$&
13948 .vindex "&$tod_logfile$&"
13949 This variable contains the date in the format yyyymmdd. This is the format that
13950 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13951 flag.
13952
13953 .vitem &$tod_zone$&
13954 .vindex "&$tod_zone$&"
13955 This variable contains the numerical value of the local timezone, for example:
13956 -0500.
13957
13958 .vitem &$tod_zulu$&
13959 .vindex "&$tod_zulu$&"
13960 This variable contains the UTC date and time in &"Zulu"& format, as specified
13961 by ISO 8601, for example: 20030221154023Z.
13962
13963 .vitem &$transport_name$&
13964 .cindex "transport" "name"
13965 .cindex "name" "of transport"
13966 .vindex "&$transport_name$&"
13967 During the running of a transport, this variable contains its name.
13968
13969 .vitem &$value$&
13970 .vindex "&$value$&"
13971 This variable contains the result of an expansion lookup, extraction operation,
13972 or external command, as described above. It is also used during a
13973 &*reduce*& expansion.
13974
13975 .vitem &$verify_mode$&
13976 .vindex "&$verify_mode$&"
13977 While a router or transport is being run in verify mode or for cutthrough delivery,
13978 contains "S" for sender-verification or "R" for recipient-verification.
13979 Otherwise, empty.
13980
13981 .vitem &$version_number$&
13982 .vindex "&$version_number$&"
13983 The version number of Exim. Same as &$exim_version$&, may be overridden
13984 by the &%exim_version%& main config option.
13985
13986 .vitem &$warn_message_delay$&
13987 .vindex "&$warn_message_delay$&"
13988 This variable is set only during the creation of a message warning about a
13989 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13990
13991 .vitem &$warn_message_recipients$&
13992 .vindex "&$warn_message_recipients$&"
13993 This variable is set only during the creation of a message warning about a
13994 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13995 .endlist
13996 .ecindex IIDstrexp
13997
13998
13999
14000 . ////////////////////////////////////////////////////////////////////////////
14001 . ////////////////////////////////////////////////////////////////////////////
14002
14003 .chapter "Embedded Perl" "CHAPperl"
14004 .scindex IIDperl "Perl" "calling from Exim"
14005 Exim can be built to include an embedded Perl interpreter. When this is done,
14006 Perl subroutines can be called as part of the string expansion process. To make
14007 use of the Perl support, you need version 5.004 or later of Perl installed on
14008 your system. To include the embedded interpreter in the Exim binary, include
14009 the line
14010 .code
14011 EXIM_PERL = perl.o
14012 .endd
14013 in your &_Local/Makefile_& and then build Exim in the normal way.
14014
14015
14016 .section "Setting up so Perl can be used" "SECID85"
14017 .oindex "&%perl_startup%&"
14018 Access to Perl subroutines is via a global configuration option called
14019 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14020 no &%perl_startup%& option in the Exim configuration file then no Perl
14021 interpreter is started and there is almost no overhead for Exim (since none of
14022 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14023 option then the associated value is taken to be Perl code which is executed in
14024 a newly created Perl interpreter.
14025
14026 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14027 need backslashes before any characters to escape special meanings. The option
14028 should usually be something like
14029 .code
14030 perl_startup = do '/etc/exim.pl'
14031 .endd
14032 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14033 use from Exim. Exim can be configured either to start up a Perl interpreter as
14034 soon as it is entered, or to wait until the first time it is needed. Starting
14035 the interpreter at the beginning ensures that it is done while Exim still has
14036 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14037 fact used in a particular run. Also, note that this does not mean that Exim is
14038 necessarily running as root when Perl is called at a later time. By default,
14039 the interpreter is started only when it is needed, but this can be changed in
14040 two ways:
14041
14042 .ilist
14043 .oindex "&%perl_at_start%&"
14044 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14045 a startup when Exim is entered.
14046 .next
14047 The command line option &%-ps%& also requests a startup when Exim is entered,
14048 overriding the setting of &%perl_at_start%&.
14049 .endlist
14050
14051 There is also a command line option &%-pd%& (for delay) which suppresses the
14052 initial startup, even if &%perl_at_start%& is set.
14053
14054 .ilist
14055 .oindex "&%perl_taintmode%&"
14056 .cindex "Perl" "taintmode"
14057 To provide more security executing Perl code via the embedded Perl
14058 interpreter, the &%perl_taintmode%& option can be set. This enables the
14059 taint mode of the Perl interpreter. You are encouraged to set this
14060 option to a true value. To avoid breaking existing installations, it
14061 defaults to false.
14062
14063 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14064
14065
14066 .section "Calling Perl subroutines" "SECID86"
14067 When the configuration file includes a &%perl_startup%& option you can make use
14068 of the string expansion item to call the Perl subroutines that are defined
14069 by the &%perl_startup%& code. The operator is used in any of the following
14070 forms:
14071 .code
14072 ${perl{foo}}
14073 ${perl{foo}{argument}}
14074 ${perl{foo}{argument1}{argument2} ... }
14075 .endd
14076 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14077 arguments may be passed. Passing more than this results in an expansion failure
14078 with an error message of the form
14079 .code
14080 Too many arguments passed to Perl subroutine "foo" (max is 8)
14081 .endd
14082 The return value of the Perl subroutine is evaluated in a scalar context before
14083 it is passed back to Exim to be inserted into the expanded string. If the
14084 return value is &'undef'&, the expansion is forced to fail in the same way as
14085 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14086 by obeying Perl's &%die%& function, the expansion fails with the error message
14087 that was passed to &%die%&.
14088
14089
14090 .section "Calling Exim functions from Perl" "SECID87"
14091 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14092 is available to call back into Exim's string expansion function. For example,
14093 the Perl code
14094 .code
14095 my $lp = Exim::expand_string('$local_part');
14096 .endd
14097 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14098 Note those are single quotes and not double quotes to protect against
14099 &$local_part$& being interpolated as a Perl variable.
14100
14101 If the string expansion is forced to fail by a &"fail"& item, the result of
14102 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14103 expansion string, the Perl call from the original expansion string fails with
14104 an appropriate error message, in the same way as if &%die%& were used.
14105
14106 .cindex "debugging" "from embedded Perl"
14107 .cindex "log" "writing from embedded Perl"
14108 Two other Exim functions are available for use from within Perl code.
14109 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14110 debugging is enabled. If you want a newline at the end, you must supply it.
14111 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14112 timestamp. In this case, you should not supply a terminating newline.
14113
14114
14115 .section "Use of standard output and error by Perl" "SECID88"
14116 .cindex "Perl" "standard output and error"
14117 You should not write to the standard error or output streams from within your
14118 Perl code, as it is not defined how these are set up. In versions of Exim
14119 before 4.50, it is possible for the standard output or error to refer to the
14120 SMTP connection during message reception via the daemon. Writing to this stream
14121 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14122 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14123 avoided, but the output is lost.
14124
14125 .cindex "Perl" "use of &%warn%&"
14126 The Perl &%warn%& statement writes to the standard error stream by default.
14127 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14128 you have no control. When Exim starts up the Perl interpreter, it arranges for
14129 output from the &%warn%& statement to be written to the Exim main log. You can
14130 change this by including appropriate Perl magic somewhere in your Perl code.
14131 For example, to discard &%warn%& output completely, you need this:
14132 .code
14133 $SIG{__WARN__} = sub { };
14134 .endd
14135 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14136 example, the code for the subroutine is empty, so it does nothing, but you can
14137 include any Perl code that you like. The text of the &%warn%& message is passed
14138 as the first subroutine argument.
14139 .ecindex IIDperl
14140
14141
14142 . ////////////////////////////////////////////////////////////////////////////
14143 . ////////////////////////////////////////////////////////////////////////////
14144
14145 .chapter "Starting the daemon and the use of network interfaces" &&&
14146          "CHAPinterfaces" &&&
14147          "Starting the daemon"
14148 .cindex "daemon" "starting"
14149 .cindex "interface" "listening"
14150 .cindex "network interface"
14151 .cindex "interface" "network"
14152 .cindex "IP address" "for listening"
14153 .cindex "daemon" "listening IP addresses"
14154 .cindex "TCP/IP" "setting listening interfaces"
14155 .cindex "TCP/IP" "setting listening ports"
14156 A host that is connected to a TCP/IP network may have one or more physical
14157 hardware network interfaces. Each of these interfaces may be configured as one
14158 or more &"logical"& interfaces, which are the entities that a program actually
14159 works with. Each of these logical interfaces is associated with an IP address.
14160 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14161 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14162 knowledge about the host's interfaces for use in three different circumstances:
14163
14164 .olist
14165 When a listening daemon is started, Exim needs to know which interfaces
14166 and ports to listen on.
14167 .next
14168 When Exim is routing an address, it needs to know which IP addresses
14169 are associated with local interfaces. This is required for the correct
14170 processing of MX lists by removing the local host and others with the
14171 same or higher priority values. Also, Exim needs to detect cases
14172 when an address is routed to an IP address that in fact belongs to the
14173 local host. Unless the &%self%& router option or the &%allow_localhost%&
14174 option of the smtp transport is set (as appropriate), this is treated
14175 as an error situation.
14176 .next
14177 When Exim connects to a remote host, it may need to know which interface to use
14178 for the outgoing connection.
14179 .endlist
14180
14181
14182 Exim's default behaviour is likely to be appropriate in the vast majority
14183 of cases. If your host has only one interface, and you want all its IP
14184 addresses to be treated in the same way, and you are using only the
14185 standard SMTP port, you should not need to take any special action. The
14186 rest of this chapter does not apply to you.
14187
14188 In a more complicated situation you may want to listen only on certain
14189 interfaces, or on different ports, and for this reason there are a number of
14190 options that can be used to influence Exim's behaviour. The rest of this
14191 chapter describes how they operate.
14192
14193 When a message is received over TCP/IP, the interface and port that were
14194 actually used are set in &$received_ip_address$& and &$received_port$&.
14195
14196
14197
14198 .section "Starting a listening daemon" "SECID89"
14199 When a listening daemon is started (by means of the &%-bd%& command line
14200 option), the interfaces and ports on which it listens are controlled by the
14201 following options:
14202
14203 .ilist
14204 &%daemon_smtp_ports%& contains a list of default ports
14205 or service names.
14206 (For backward compatibility, this option can also be specified in the singular.)
14207 .next
14208 &%local_interfaces%& contains list of interface IP addresses on which to
14209 listen. Each item may optionally also specify a port.
14210 .endlist
14211
14212 The default list separator in both cases is a colon, but this can be changed as
14213 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14214 it is usually best to change the separator to avoid having to double all the
14215 colons. For example:
14216 .code
14217 local_interfaces = <; 127.0.0.1 ; \
14218                       192.168.23.65 ; \
14219                       ::1 ; \
14220                       3ffe:ffff:836f::fe86:a061
14221 .endd
14222 There are two different formats for specifying a port along with an IP address
14223 in &%local_interfaces%&:
14224
14225 .olist
14226 The port is added onto the address with a dot separator. For example, to listen
14227 on port 1234 on two different IP addresses:
14228 .code
14229 local_interfaces = <; 192.168.23.65.1234 ; \
14230                       3ffe:ffff:836f::fe86:a061.1234
14231 .endd
14232 .next
14233 The IP address is enclosed in square brackets, and the port is added
14234 with a colon separator, for example:
14235 .code
14236 local_interfaces = <; [192.168.23.65]:1234 ; \
14237                       [3ffe:ffff:836f::fe86:a061]:1234
14238 .endd
14239 .endlist
14240
14241 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14242 default setting contains just one port:
14243 .code
14244 daemon_smtp_ports = smtp
14245 .endd
14246 If more than one port is listed, each interface that does not have its own port
14247 specified listens on all of them. Ports that are listed in
14248 &%daemon_smtp_ports%& can be identified either by name (defined in
14249 &_/etc/services_&) or by number. However, when ports are given with individual
14250 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14251
14252
14253
14254 .section "Special IP listening addresses" "SECID90"
14255 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14256 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14257 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14258 instead of setting up separate listening sockets for each interface. The
14259 default value of &%local_interfaces%& is
14260 .code
14261 local_interfaces = 0.0.0.0
14262 .endd
14263 when Exim is built without IPv6 support; otherwise it is:
14264 .code
14265 local_interfaces = <; ::0 ; 0.0.0.0
14266 .endd
14267 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14268
14269
14270
14271 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14272 The &%-oX%& command line option can be used to override the values of
14273 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14274 instance. Another way of doing this would be to use macros and the &%-D%&
14275 option. However, &%-oX%& can be used by any admin user, whereas modification of
14276 the runtime configuration by &%-D%& is allowed only when the caller is root or
14277 exim.
14278
14279 The value of &%-oX%& is a list of items. The default colon separator can be
14280 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14281 If there are any items that do not
14282 contain dots or colons (that is, are not IP addresses), the value of
14283 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14284 items that do contain dots or colons, the value of &%local_interfaces%& is
14285 replaced by those items. Thus, for example,
14286 .code
14287 -oX 1225
14288 .endd
14289 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14290 whereas
14291 .code
14292 -oX 192.168.34.5.1125
14293 .endd
14294 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14295 (However, since &%local_interfaces%& now contains no items without ports, the
14296 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14297
14298
14299
14300 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14301 .cindex "submissions protocol"
14302 .cindex "ssmtp protocol"
14303 .cindex "smtps protocol"
14304 .cindex "SMTP" "ssmtp protocol"
14305 .cindex "SMTP" "smtps protocol"
14306 Exim supports the use of TLS-on-connect, used by mail clients in the
14307 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14308 For some years, IETF Standards Track documents only blessed the
14309 STARTTLS-based Submission service (port 587) while common practice was to support
14310 the same feature set on port 465, but using TLS-on-connect.
14311 If your installation needs to provide service to mail clients
14312 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14313 the 465 TCP ports.
14314
14315 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14316 service names, connections to those ports must first establish TLS, before
14317 proceeding to the application layer use of the SMTP protocol.
14318
14319 The common use of this option is expected to be
14320 .code
14321 tls_on_connect_ports = 465
14322 .endd
14323 per RFC 8314.
14324 There is also a command line option &%-tls-on-connect%&, which forces all ports
14325 to behave in this way when a daemon is started.
14326
14327 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14328 daemon to listen on those ports. You must still specify them in
14329 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14330 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14331 connections via the daemon.)
14332
14333
14334
14335
14336 .section "IPv6 address scopes" "SECID92"
14337 .cindex "IPv6" "address scopes"
14338 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14339 can, in principle, have the same link-local IPv6 address on different
14340 interfaces. Thus, additional information is needed, over and above the IP
14341 address, to distinguish individual interfaces. A convention of using a
14342 percent sign followed by something (often the interface name) has been
14343 adopted in some cases, leading to addresses like this:
14344 .code
14345 fe80::202:b3ff:fe03:45c1%eth0
14346 .endd
14347 To accommodate this usage, a percent sign followed by an arbitrary string is
14348 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14349 to convert a textual IPv6 address for actual use. This function recognizes the
14350 percent convention in operating systems that support it, and it processes the
14351 address appropriately. Unfortunately, some older libraries have problems with
14352 &[getaddrinfo()]&. If
14353 .code
14354 IPV6_USE_INET_PTON=yes
14355 .endd
14356 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14357 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14358 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14359 function.) Of course, this means that the additional functionality of
14360 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14361
14362 .section "Disabling IPv6" "SECID93"
14363 .cindex "IPv6" "disabling"
14364 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14365 run on a host whose kernel does not support IPv6. The binary will fall back to
14366 using IPv4, but it may waste resources looking up AAAA records, and trying to
14367 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14368 .oindex "&%disable_ipv6%&"
14369 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14370 activities take place. AAAA records are never looked up, and any IPv6 addresses
14371 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14372 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14373 to handle IPv6 literal addresses.
14374
14375 On the other hand, when IPv6 is in use, there may be times when you want to
14376 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14377 option to globally suppress the lookup of AAAA records for specified domains,
14378 and you can use the &%ignore_target_hosts%& generic router option to ignore
14379 IPv6 addresses in an individual router.
14380
14381
14382
14383 .section "Examples of starting a listening daemon" "SECID94"
14384 The default case in an IPv6 environment is
14385 .code
14386 daemon_smtp_ports = smtp
14387 local_interfaces = <; ::0 ; 0.0.0.0
14388 .endd
14389 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14390 Either one or two sockets may be used, depending on the characteristics of
14391 the TCP/IP stack. (This is complicated and messy; for more information,
14392 read the comments in the &_daemon.c_& source file.)
14393
14394 To specify listening on ports 25 and 26 on all interfaces:
14395 .code
14396 daemon_smtp_ports = 25 : 26
14397 .endd
14398 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14399 .code
14400 local_interfaces = <; ::0.25     ; ::0.26 \
14401                       0.0.0.0.25 ; 0.0.0.0.26
14402 .endd
14403 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14404 IPv4 loopback address only:
14405 .code
14406 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14407 .endd
14408 To specify listening on the default port on specific interfaces only:
14409 .code
14410 local_interfaces = 10.0.0.67 : 192.168.34.67
14411 .endd
14412 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14413
14414
14415
14416 .section "Recognizing the local host" "SECTreclocipadd"
14417 The &%local_interfaces%& option is also used when Exim needs to determine
14418 whether or not an IP address refers to the local host. That is, the IP
14419 addresses of all the interfaces on which a daemon is listening are always
14420 treated as local.
14421
14422 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14423 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14424 available interfaces from the operating system, and extracts the relevant
14425 (that is, IPv4 or IPv6) addresses to use for checking.
14426
14427 Some systems set up large numbers of virtual interfaces in order to provide
14428 many virtual web servers. In this situation, you may want to listen for
14429 email on only a few of the available interfaces, but nevertheless treat all
14430 interfaces as local when routing. You can do this by setting
14431 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14432 &"all"& wildcard values. These addresses are recognized as local, but are not
14433 used for listening. Consider this example:
14434 .code
14435 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14436                       192.168.53.235 ; \
14437                       3ffe:2101:12:1:a00:20ff:fe86:a061
14438
14439 extra_local_interfaces = <; ::0 ; 0.0.0.0
14440 .endd
14441 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14442 address, but all available interface addresses are treated as local when
14443 Exim is routing.
14444
14445 In some environments the local host name may be in an MX list, but with an IP
14446 address that is not assigned to any local interface. In other cases it may be
14447 desirable to treat other host names as if they referred to the local host. Both
14448 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14449 This contains host names rather than IP addresses. When a host is referenced
14450 during routing, either via an MX record or directly, it is treated as the local
14451 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14452 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14453
14454
14455
14456 .section "Delivering to a remote host" "SECID95"
14457 Delivery to a remote host is handled by the smtp transport. By default, it
14458 allows the system's TCP/IP functions to choose which interface to use (if
14459 there is more than one) when connecting to a remote host. However, the
14460 &%interface%& option can be set to specify which interface is used. See the
14461 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14462 details.
14463
14464
14465
14466
14467 . ////////////////////////////////////////////////////////////////////////////
14468 . ////////////////////////////////////////////////////////////////////////////
14469
14470 .chapter "Main configuration" "CHAPmainconfig"
14471 .scindex IIDconfima "configuration file" "main section"
14472 .scindex IIDmaiconf "main configuration"
14473 The first part of the runtime configuration file contains three types of item:
14474
14475 .ilist
14476 Macro definitions: These lines start with an upper case letter. See section
14477 &<<SECTmacrodefs>>& for details of macro processing.
14478 .next
14479 Named list definitions: These lines start with one of the words &"domainlist"&,
14480 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14481 section &<<SECTnamedlists>>&.
14482 .next
14483 Main configuration settings: Each setting occupies one line of the file
14484 (with possible continuations). If any setting is preceded by the word
14485 &"hide"&, the &%-bP%& command line option displays its value to admin users
14486 only. See section &<<SECTcos>>& for a description of the syntax of these option
14487 settings.
14488 .endlist
14489
14490 This chapter specifies all the main configuration options, along with their
14491 types and default values. For ease of finding a particular option, they appear
14492 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14493 are now so many options, they are first listed briefly in functional groups, as
14494 an aid to finding the name of the option you are looking for. Some options are
14495 listed in more than one group.
14496
14497 .section "Miscellaneous" "SECID96"
14498 .table2
14499 .row &%add_environment%&             "environment variables"
14500 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14501 .row &%debug_store%&                 "do extra internal checks"
14502 .row &%disable_ipv6%&                "do no IPv6 processing"
14503 .row &%keep_environment%&            "environment variables"
14504 .row &%keep_malformed%&              "for broken files &-- should not happen"
14505 .row &%localhost_number%&            "for unique message ids in clusters"
14506 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14507 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14508 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14509 .row &%print_topbitchars%&           "top-bit characters are printing"
14510 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14511 .row &%timezone%&                    "force time zone"
14512 .endtable
14513
14514
14515 .section "Exim parameters" "SECID97"
14516 .table2
14517 .row &%exim_group%&                  "override compiled-in value"
14518 .row &%exim_path%&                   "override compiled-in value"
14519 .row &%exim_user%&                   "override compiled-in value"
14520 .row &%primary_hostname%&            "default from &[uname()]&"
14521 .row &%split_spool_directory%&       "use multiple directories"
14522 .row &%spool_directory%&             "override compiled-in value"
14523 .endtable
14524
14525
14526
14527 .section "Privilege controls" "SECID98"
14528 .table2
14529 .row &%admin_groups%&                "groups that are Exim admin users"
14530 .row &%commandline_checks_require_admin%& "require admin for various checks"
14531 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14532 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14533 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14534 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14535 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14536 .row &%never_users%&                 "do not run deliveries as these"
14537 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14538 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14539 .row &%trusted_groups%&              "groups that are trusted"
14540 .row &%trusted_users%&               "users that are trusted"
14541 .endtable
14542
14543
14544
14545 .section "Logging" "SECID99"
14546 .table2
14547 .row &%event_action%&                "custom logging"
14548 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14549 .row &%log_file_path%&               "override compiled-in value"
14550 .row &%log_selector%&                "set/unset optional logging"
14551 .row &%log_timezone%&                "add timezone to log lines"
14552 .row &%message_logs%&                "create per-message logs"
14553 .row &%preserve_message_logs%&       "after message completion"
14554 .row &%panic_coredump%&              "request coredump on fatal errors"
14555 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14556 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14557 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14558 .row &%syslog_facility%&             "set syslog &""facility""& field"
14559 .row &%syslog_pid%&                  "pid in syslog lines"
14560 .row &%syslog_processname%&          "set syslog &""ident""& field"
14561 .row &%syslog_timestamp%&            "timestamp syslog lines"
14562 .row &%write_rejectlog%&             "control use of message log"
14563 .endtable
14564
14565
14566
14567 .section "Frozen messages" "SECID100"
14568 .table2
14569 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14570 .row &%freeze_tell%&                 "send message when freezing"
14571 .row &%move_frozen_messages%&        "to another directory"
14572 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14573 .endtable
14574
14575
14576
14577 .section "Data lookups" "SECID101"
14578 .table2
14579 .row &%ibase_servers%&               "InterBase servers"
14580 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14581 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14582 .row &%ldap_cert_file%&              "client cert file for LDAP"
14583 .row &%ldap_cert_key%&               "client key file for LDAP"
14584 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14585 .row &%ldap_default_servers%&        "used if no server in query"
14586 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14587 .row &%ldap_start_tls%&              "require TLS within LDAP"
14588 .row &%ldap_version%&                "set protocol version"
14589 .row &%lookup_open_max%&             "lookup files held open"
14590 .row &%mysql_servers%&               "default MySQL servers"
14591 .row &%oracle_servers%&              "Oracle servers"
14592 .row &%pgsql_servers%&               "default PostgreSQL servers"
14593 .row &%sqlite_lock_timeout%&         "as it says"
14594 .endtable
14595
14596
14597
14598 .section "Message ids" "SECID102"
14599 .table2
14600 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14601 .row &%message_id_header_text%&      "ditto"
14602 .endtable
14603
14604
14605
14606 .section "Embedded Perl Startup" "SECID103"
14607 .table2
14608 .row &%perl_at_start%&               "always start the interpreter"
14609 .row &%perl_startup%&                "code to obey when starting Perl"
14610 .row &%perl_taintmode%&              "enable taint mode in Perl"
14611 .endtable
14612
14613
14614
14615 .section "Daemon" "SECID104"
14616 .table2
14617 .row &%daemon_smtp_ports%&           "default ports"
14618 .row &%daemon_startup_retries%&      "number of times to retry"
14619 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14620 .row &%extra_local_interfaces%&      "not necessarily listened on"
14621 .row &%local_interfaces%&            "on which to listen, with optional ports"
14622 .row &%notifier_socket%&             "override compiled-in value"
14623 .row &%pid_file_path%&               "override compiled-in value"
14624 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14625 .row &%smtp_backlog_monitor%&        "level to log listen backlog"
14626 .endtable
14627
14628
14629
14630 .section "Resource control" "SECID105"
14631 .table2
14632 .row &%check_log_inodes%&            "before accepting a message"
14633 .row &%check_log_space%&             "before accepting a message"
14634 .row &%check_spool_inodes%&          "before accepting a message"
14635 .row &%check_spool_space%&           "before accepting a message"
14636 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14637 .row &%queue_only_load%&             "queue incoming if load high"
14638 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14639 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14640 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14641 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14642 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14643 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14644 .row &%smtp_accept_max_per_connection%& "messages per connection"
14645 .row &%smtp_accept_max_per_host%&    "connections from one host"
14646 .row &%smtp_accept_queue%&           "queue mail if more connections"
14647 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14648                                            connection"
14649 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14650 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14651 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14652 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14653 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14654 .endtable
14655
14656
14657
14658 .section "Policy controls" "SECID106"
14659 .table2
14660 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14661 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14662 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14663 .row &%acl_smtp_auth%&               "ACL for AUTH"
14664 .row &%acl_smtp_connect%&            "ACL for connection"
14665 .row &%acl_smtp_data%&               "ACL for DATA"
14666 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14667 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14668 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14669 .row &%acl_smtp_expn%&               "ACL for EXPN"
14670 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14671 .row &%acl_smtp_mail%&               "ACL for MAIL"
14672 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14673 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14674 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14675 .row &%acl_smtp_predata%&            "ACL for start of data"
14676 .row &%acl_smtp_quit%&               "ACL for QUIT"
14677 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14678 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14679 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14680 .row &%av_scanner%&                  "specify virus scanner"
14681 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14682                                       words""&"
14683 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14684 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14685 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14686 .row &%header_maxsize%&              "total size of message header"
14687 .row &%header_line_maxsize%&         "individual header line limit"
14688 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14689 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14690 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14691 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14692 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14693 .row &%host_lookup%&                 "host name looked up for these hosts"
14694 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14695 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14696 .row &%host_reject_connection%&      "reject connection from these hosts"
14697 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14698 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14699 .row &%message_size_limit%&          "for all messages"
14700 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14701 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14702 .row &%spamd_address%&               "set interface to SpamAssassin"
14703 .row &%strict_acl_vars%&             "object to unset ACL variables"
14704 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14705 .endtable
14706
14707
14708
14709 .section "Callout cache" "SECID107"
14710 .table2
14711 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14712                                          item"
14713 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14714                                          item"
14715 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14716 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14717 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14718 .endtable
14719
14720
14721
14722 .section "TLS" "SECID108"
14723 .table2
14724 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14725 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14726 .row &%hosts_require_alpn%&          "mandatory ALPN"
14727 .row &%hosts_require_helo%&          "mandatory HELO/EHLO"
14728 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14729 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14730 .row &%tls_alpn%&                    "acceptable protocol names"
14731 .row &%tls_certificate%&             "location of server certificate"
14732 .row &%tls_crl%&                     "certificate revocation list"
14733 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14734 .row &%tls_dhparam%&                 "DH parameters for server"
14735 .row &%tls_eccurve%&                 "EC curve selection for server"
14736 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14737 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14738 .row &%tls_privatekey%&              "location of server private key"
14739 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14740 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14741 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14742 .row &%tls_verify_certificates%&     "expected client certificates"
14743 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14744 .endtable
14745
14746
14747
14748 .section "Local user handling" "SECID109"
14749 .table2
14750 .row &%finduser_retries%&            "useful in NIS environments"
14751 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14752 .row &%gecos_pattern%&               "ditto"
14753 .row &%max_username_length%&         "for systems that truncate"
14754 .row &%unknown_login%&               "used when no login name found"
14755 .row &%unknown_username%&            "ditto"
14756 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14757 .row &%uucp_from_sender%&            "ditto"
14758 .endtable
14759
14760
14761
14762 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14763 .table2
14764 .row &%header_maxsize%&              "total size of message header"
14765 .row &%header_line_maxsize%&         "individual header line limit"
14766 .row &%message_size_limit%&          "applies to all messages"
14767 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14768 .row &%received_header_text%&        "expanded to make &'Received:'&"
14769 .row &%received_headers_max%&        "for mail loop detection"
14770 .row &%recipients_max%&              "limit per message"
14771 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14772 .endtable
14773
14774
14775
14776
14777 .section "Non-SMTP incoming messages" "SECID111"
14778 .table2
14779 .row &%receive_timeout%&             "for non-SMTP messages"
14780 .endtable
14781
14782
14783
14784
14785
14786 .section "Incoming SMTP messages" "SECID112"
14787 See also the &'Policy controls'& section above.
14788
14789 .table2
14790 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14791 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14792 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14793 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14794 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14795 .row &%dmarc_history_file%&          "DMARC results log"
14796 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14797 .row &%host_lookup%&                 "host name looked up for these hosts"
14798 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14799 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14800 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14801 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14802 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14803 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14804 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14805 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14806 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14807 .row &%smtp_accept_max_per_connection%& "messages per connection"
14808 .row &%smtp_accept_max_per_host%&    "connections from one host"
14809 .row &%smtp_accept_queue%&           "queue mail if more connections"
14810 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14811                                            connection"
14812 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14813 .row &%smtp_active_hostname%&        "host name to use in messages"
14814 .row &%smtp_banner%&                 "text for welcome banner"
14815 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14816 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14817 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14818 .row &%smtp_etrn_command%&           "what to run for ETRN"
14819 .row &%smtp_etrn_serialize%&         "only one at once"
14820 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14821 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14822 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14823 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14824 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14825 .row &%smtp_receive_timeout%&        "per command or data line"
14826 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14827 .row &%smtp_return_error_details%&   "give detail on rejections"
14828 .endtable
14829
14830
14831
14832 .section "SMTP extensions" "SECID113"
14833 .table2
14834 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14835 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14836 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14837 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14838 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14839 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14840 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14841 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14842 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14843 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14844 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14845 .endtable
14846
14847
14848
14849 .section "Processing messages" "SECID114"
14850 .table2
14851 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14852 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14853 .row &%allow_utf8_domains%&          "in addresses"
14854 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14855                                       words""&"
14856 .row &%delivery_date_remove%&        "from incoming messages"
14857 .row &%envelope_to_remove%&          "from incoming messages"
14858 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14859 .row &%headers_charset%&             "default for translations"
14860 .row &%qualify_domain%&              "default for senders"
14861 .row &%qualify_recipient%&           "default for recipients"
14862 .row &%return_path_remove%&          "from incoming messages"
14863 .row &%strip_excess_angle_brackets%& "in addresses"
14864 .row &%strip_trailing_dot%&          "at end of addresses"
14865 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14866 .endtable
14867
14868
14869
14870 .section "System filter" "SECID115"
14871 .table2
14872 .row &%system_filter%&               "locate system filter"
14873 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14874                                             directory"
14875 .row &%system_filter_file_transport%& "transport for delivery to a file"
14876 .row &%system_filter_group%&         "group for filter running"
14877 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14878 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14879 .row &%system_filter_user%&          "user for filter running"
14880 .endtable
14881
14882
14883
14884 .section "Routing and delivery" "SECID116"
14885 .table2
14886 .row &%disable_ipv6%&                "do no IPv6 processing"
14887 .row &%dns_again_means_nonexist%&    "for broken domains"
14888 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14889 .row &%dns_dnssec_ok%&               "parameter for resolver"
14890 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14891 .row &%dns_retrans%&                 "parameter for resolver"
14892 .row &%dns_retry%&                   "parameter for resolver"
14893 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14894 .row &%dns_use_edns0%&               "parameter for resolver"
14895 .row &%hold_domains%&                "hold delivery for these domains"
14896 .row &%local_interfaces%&            "for routing checks"
14897 .row &%queue_domains%&               "no immediate delivery for these"
14898 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
14899 .row &%queue_only%&                  "no immediate delivery at all"
14900 .row &%queue_only_file%&             "no immediate delivery if file exists"
14901 .row &%queue_only_load%&             "no immediate delivery if load is high"
14902 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14903 .row &%queue_only_override%&         "allow command line to override"
14904 .row &%queue_run_in_order%&          "order of arrival"
14905 .row &%queue_run_max%&               "of simultaneous queue runners"
14906 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14907 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14908 .row &%remote_sort_domains%&         "order of remote deliveries"
14909 .row &%retry_data_expire%&           "timeout for retry data"
14910 .row &%retry_interval_max%&          "safety net for retry rules"
14911 .endtable
14912
14913
14914
14915 .section "Bounce and warning messages" "SECID117"
14916 .table2
14917 .row &%bounce_message_file%&         "content of bounce"
14918 .row &%bounce_message_text%&         "content of bounce"
14919 .row &%bounce_return_body%&          "include body if returning message"
14920 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14921 .row &%bounce_return_message%&       "include original message in bounce"
14922 .row &%bounce_return_size_limit%&    "limit on returned message"
14923 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14924 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14925 .row &%errors_copy%&                 "copy bounce messages"
14926 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14927 .row &%delay_warning%&               "time schedule"
14928 .row &%delay_warning_condition%&     "condition for warning messages"
14929 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14930 .row &%smtp_return_error_details%&   "give detail on rejections"
14931 .row &%warn_message_file%&           "content of warning message"
14932 .endtable
14933
14934
14935
14936 .section "Alphabetical list of main options" "SECTalomo"
14937 Those options that undergo string expansion before use are marked with
14938 &dagger;.
14939
14940 .option accept_8bitmime main boolean true
14941 .cindex "8BITMIME"
14942 .cindex "8-bit characters"
14943 .cindex "log" "selectors"
14944 .cindex "log" "8BITMIME"
14945 .cindex "ESMTP extensions" 8BITMIME
14946 This option causes Exim to send 8BITMIME in its response to an SMTP
14947 EHLO command, and to accept the BODY= parameter on MAIL commands.
14948 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14949 takes no steps to do anything special with messages received by this route.
14950
14951 Historically Exim kept this option off by default, but the maintainers
14952 feel that in today's Internet, this causes more problems than it solves.
14953 It now defaults to true.
14954 A more detailed analysis of the issues is provided by Dan Bernstein:
14955 .display
14956 &url(https://cr.yp.to/smtp/8bitmime.html)
14957 .endd
14958
14959 To log received 8BITMIME status use
14960 .code
14961 log_selector = +8bitmime
14962 .endd
14963
14964 .option acl_not_smtp main string&!! unset
14965 .cindex "&ACL;" "for non-SMTP messages"
14966 .cindex "non-SMTP messages" "ACLs for"
14967 This option defines the ACL that is run when a non-SMTP message has been
14968 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14969 further details.
14970
14971 .option acl_not_smtp_mime main string&!! unset
14972 This option defines the ACL that is run for individual MIME parts of non-SMTP
14973 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14974 SMTP messages.
14975
14976 .option acl_not_smtp_start main string&!! unset
14977 .cindex "&ACL;" "at start of non-SMTP message"
14978 .cindex "non-SMTP messages" "ACLs for"
14979 This option defines the ACL that is run before Exim starts reading a
14980 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14981
14982 .option acl_smtp_auth main string&!! unset
14983 .cindex "&ACL;" "setting up for SMTP commands"
14984 .cindex "AUTH" "ACL for"
14985 This option defines the ACL that is run when an SMTP AUTH command is
14986 received. See chapter &<<CHAPACL>>& for further details.
14987
14988 .option acl_smtp_connect main string&!! unset
14989 .cindex "&ACL;" "on SMTP connection"
14990 This option defines the ACL that is run when an SMTP connection is received.
14991 See chapter &<<CHAPACL>>& for further details.
14992
14993 .option acl_smtp_data main string&!! unset
14994 .cindex "DATA" "ACL for"
14995 This option defines the ACL that is run after an SMTP DATA command has been
14996 processed and the message itself has been received, but before the final
14997 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14998
14999 .option acl_smtp_data_prdr main string&!! accept
15000 .cindex "PRDR" "ACL for"
15001 .cindex "DATA" "PRDR ACL for"
15002 .cindex "&ACL;" "PRDR-related"
15003 .cindex "&ACL;" "per-user data processing"
15004 This option defines the ACL that,
15005 if the PRDR feature has been negotiated,
15006 is run for each recipient after an SMTP DATA command has been
15007 processed and the message itself has been received, but before the
15008 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15009
15010 .option acl_smtp_dkim main string&!! unset
15011 .cindex DKIM "ACL for"
15012 This option defines the ACL that is run for each DKIM signature
15013 (by default, or as specified in the dkim_verify_signers option)
15014 of a received message.
15015 See section &<<SECDKIMVFY>>& for further details.
15016
15017 .option acl_smtp_etrn main string&!! unset
15018 .cindex "ETRN" "ACL for"
15019 This option defines the ACL that is run when an SMTP ETRN command is
15020 received. See chapter &<<CHAPACL>>& for further details.
15021
15022 .option acl_smtp_expn main string&!! unset
15023 .cindex "EXPN" "ACL for"
15024 This option defines the ACL that is run when an SMTP EXPN command is
15025 received. See chapter &<<CHAPACL>>& for further details.
15026
15027 .option acl_smtp_helo main string&!! unset
15028 .cindex "EHLO" "ACL for"
15029 .cindex "HELO" "ACL for"
15030 This option defines the ACL that is run when an SMTP EHLO or HELO
15031 command is received. See chapter &<<CHAPACL>>& for further details.
15032
15033
15034 .option acl_smtp_mail main string&!! unset
15035 .cindex "MAIL" "ACL for"
15036 This option defines the ACL that is run when an SMTP MAIL command is
15037 received. See chapter &<<CHAPACL>>& for further details.
15038
15039 .option acl_smtp_mailauth main string&!! unset
15040 .cindex "AUTH" "on MAIL command"
15041 This option defines the ACL that is run when there is an AUTH parameter on
15042 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
15043 &<<CHAPSMTPAUTH>>& for details of authentication.
15044
15045 .option acl_smtp_mime main string&!! unset
15046 .cindex "MIME content scanning" "ACL for"
15047 This option is available when Exim is built with the content-scanning
15048 extension. It defines the ACL that is run for each MIME part in a message. See
15049 section &<<SECTscanmimepart>>& for details.
15050
15051 .option acl_smtp_notquit main string&!! unset
15052 .cindex "not-QUIT, ACL for"
15053 This option defines the ACL that is run when an SMTP session
15054 ends without a QUIT command being received.
15055 See chapter &<<CHAPACL>>& for further details.
15056
15057 .option acl_smtp_predata main string&!! unset
15058 This option defines the ACL that is run when an SMTP DATA command is
15059 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15060 further details.
15061
15062 .option acl_smtp_quit main string&!! unset
15063 .cindex "QUIT, ACL for"
15064 This option defines the ACL that is run when an SMTP QUIT command is
15065 received. See chapter &<<CHAPACL>>& for further details.
15066
15067 .option acl_smtp_rcpt main string&!! unset
15068 .cindex "RCPT" "ACL for"
15069 This option defines the ACL that is run when an SMTP RCPT command is
15070 received. See chapter &<<CHAPACL>>& for further details.
15071
15072 .option acl_smtp_starttls main string&!! unset
15073 .cindex "STARTTLS, ACL for"
15074 This option defines the ACL that is run when an SMTP STARTTLS command is
15075 received. See chapter &<<CHAPACL>>& for further details.
15076
15077 .option acl_smtp_vrfy main string&!! unset
15078 .cindex "VRFY" "ACL for"
15079 This option defines the ACL that is run when an SMTP VRFY command is
15080 received. See chapter &<<CHAPACL>>& for further details.
15081
15082 .option add_environment main "string list" empty
15083 .cindex "environment" "set values"
15084 This option adds individual environment variables that the
15085 currently linked libraries and programs in child processes may use.
15086 Each list element should be of the form &"name=value"&.
15087
15088 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15089
15090 .option admin_groups main "string list&!!" unset
15091 .cindex "admin user"
15092 This option is expanded just once, at the start of Exim's processing. If the
15093 current group or any of the supplementary groups of an Exim caller is in this
15094 colon-separated list, the caller has admin privileges. If all your system
15095 programmers are in a specific group, for example, you can give them all Exim
15096 admin privileges by putting that group in &%admin_groups%&. However, this does
15097 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15098 To permit this, you have to add individuals to the Exim group.
15099
15100 .option allow_domain_literals main boolean false
15101 .cindex "domain literal"
15102 If this option is set, the RFC 2822 domain literal format is permitted in
15103 email addresses. The option is not set by default, because the domain literal
15104 format is not normally required these days, and few people know about it. It
15105 has, however, been exploited by mail abusers.
15106
15107 Unfortunately, it seems that some DNS black list maintainers are using this
15108 format to report black listing to postmasters. If you want to accept messages
15109 addressed to your hosts by IP address, you need to set
15110 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15111 domains (defined in the named domain list &%local_domains%& in the default
15112 configuration). This &"magic string"& matches the domain literal form of all
15113 the local host's IP addresses.
15114
15115 .option allow_mx_to_ip main boolean false
15116 .cindex "MX record" "pointing to IP address"
15117 It appears that more and more DNS zone administrators are breaking the rules
15118 and putting domain names that look like IP addresses on the right hand side of
15119 MX records. Exim follows the rules and rejects this, giving an error message
15120 that explains the misconfiguration. However, some other MTAs support this
15121 practice, so to avoid &"Why can't Exim do this?"& complaints,
15122 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15123 recommended, except when you have no other choice.
15124
15125 .option allow_utf8_domains main boolean false
15126 .cindex "domain" "UTF-8 characters in"
15127 .cindex "UTF-8" "in domain name"
15128 Lots of discussion is going on about internationalized domain names. One
15129 camp is strongly in favour of just using UTF-8 characters, and it seems
15130 that at least two other MTAs permit this.
15131 This option allows Exim users to experiment if they wish.
15132
15133 If it is set true, Exim's domain parsing function allows valid
15134 UTF-8 multicharacters to appear in domain name components, in addition to
15135 letters, digits, and hyphens.
15136
15137 If Exim is built with internationalization support
15138 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15139 this option can be left as default.
15140 Without that,
15141 if you want to look up such domain names in the DNS, you must also
15142 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15143 suitable setting is:
15144 .code
15145 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15146   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15147 .endd
15148 Alternatively, you can just disable this feature by setting
15149 .code
15150 dns_check_names_pattern =
15151 .endd
15152 That is, set the option to an empty string so that no check is done.
15153
15154
15155 .option auth_advertise_hosts main "host list&!!" *
15156 .cindex "authentication" "advertising"
15157 .cindex "AUTH" "advertising"
15158 .cindex "ESMTP extensions" AUTH
15159 If any server authentication mechanisms are configured, Exim advertises them in
15160 response to an EHLO command only if the calling host matches this list.
15161 Otherwise, Exim does not advertise AUTH.
15162 Exim does not accept AUTH commands from clients to which it has not
15163 advertised the availability of AUTH. The advertising of individual
15164 authentication mechanisms can be controlled by the use of the
15165 &%server_advertise_condition%& generic authenticator option on the individual
15166 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15167
15168 Certain mail clients (for example, Netscape) require the user to provide a name
15169 and password for authentication if AUTH is advertised, even though it may
15170 not be needed (the host may accept messages from hosts on its local LAN without
15171 authentication, for example). The &%auth_advertise_hosts%& option can be used
15172 to make these clients more friendly by excluding them from the set of hosts to
15173 which Exim advertises AUTH.
15174
15175 .cindex "AUTH" "advertising when encrypted"
15176 If you want to advertise the availability of AUTH only when the connection
15177 is encrypted using TLS, you can make use of the fact that the value of this
15178 option is expanded, with a setting like this:
15179 .code
15180 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15181 .endd
15182 .vindex "&$tls_in_cipher$&"
15183 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15184 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15185 expansion is *, which matches all hosts.
15186
15187
15188 .option auto_thaw main time 0s
15189 .cindex "thawing messages"
15190 .cindex "unfreezing messages"
15191 If this option is set to a time greater than zero, a queue runner will try a
15192 new delivery attempt on any frozen message, other than a bounce message, if
15193 this much time has passed since it was frozen. This may result in the message
15194 being re-frozen if nothing has changed since the last attempt. It is a way of
15195 saying &"keep on trying, even though there are big problems"&.
15196
15197 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15198 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15199 thought to be very useful any more, and its use should probably be avoided.
15200
15201
15202 .option av_scanner main string "see below"
15203 This option is available if Exim is built with the content-scanning extension.
15204 It specifies which anti-virus scanner to use. The default value is:
15205 .code
15206 sophie:/var/run/sophie
15207 .endd
15208 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15209 before use. See section &<<SECTscanvirus>>& for further details.
15210
15211
15212 .option bi_command main string unset
15213 .oindex "&%-bi%&"
15214 This option supplies the name of a command that is run when Exim is called with
15215 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15216 just the command name, it is not a complete command line. If an argument is
15217 required, it must come from the &%-oA%& command line option.
15218
15219
15220 .option bounce_message_file main string&!! unset
15221 .cindex "bounce message" "customizing"
15222 .cindex "customizing" "bounce message"
15223 This option defines a template file containing paragraphs of text to be used
15224 for constructing bounce messages.  Details of the file's contents are given in
15225 chapter &<<CHAPemsgcust>>&.
15226 .cindex bounce_message_file "tainted data"
15227 The option is expanded to give the file path, which must be
15228 absolute and untainted.
15229 See also &%warn_message_file%&.
15230
15231
15232 .option bounce_message_text main string unset
15233 When this option is set, its contents are included in the default bounce
15234 message immediately after &"This message was created automatically by mail
15235 delivery software."& It is not used if &%bounce_message_file%& is set.
15236
15237 .option bounce_return_body main boolean true
15238 .cindex "bounce message" "including body"
15239 This option controls whether the body of an incoming message is included in a
15240 bounce message when &%bounce_return_message%& is true. The default setting
15241 causes the entire message, both header and body, to be returned (subject to the
15242 value of &%bounce_return_size_limit%&). If this option is false, only the
15243 message header is included. In the case of a non-SMTP message containing an
15244 error that is detected during reception, only those header lines preceding the
15245 point at which the error was detected are returned.
15246 .cindex "bounce message" "including original"
15247
15248 .option bounce_return_linesize_limit main integer 998
15249 .cindex "size" "of bounce lines, limit"
15250 .cindex "bounce message" "line length limit"
15251 .cindex "limit" "bounce message line length"
15252 This option sets a limit in bytes on the line length of messages
15253 that are returned to senders due to delivery problems,
15254 when &%bounce_return_message%& is true.
15255 The default value corresponds to RFC limits.
15256 If the message being returned has lines longer than this value it is
15257 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15258
15259 The option also applies to bounces returned when an error is detected
15260 during reception of a message.
15261 In this case lines from the original are truncated.
15262
15263 The option does not apply to messages generated by an &(autoreply)& transport.
15264
15265
15266 .option bounce_return_message main boolean true
15267 If this option is set false, none of the original message is included in
15268 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15269 &%bounce_return_body%&.
15270
15271
15272 .option bounce_return_size_limit main integer 100K
15273 .cindex "size" "of bounce, limit"
15274 .cindex "bounce message" "size limit"
15275 .cindex "limit" "bounce message size"
15276 This option sets a limit in bytes on the size of messages that are returned to
15277 senders as part of bounce messages when &%bounce_return_message%& is true. The
15278 limit should be less than the value of the global &%message_size_limit%& and of
15279 any &%message_size_limit%& settings on transports, to allow for the bounce text
15280 that Exim generates. If this option is set to zero there is no limit.
15281
15282 When the body of any message that is to be included in a bounce message is
15283 greater than the limit, it is truncated, and a comment pointing this out is
15284 added at the top. The actual cutoff may be greater than the value given, owing
15285 to the use of buffering for transferring the message in chunks (typically 8K in
15286 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15287 messages.
15288
15289 .option bounce_sender_authentication main string unset
15290 .cindex "bounce message" "sender authentication"
15291 .cindex "authentication" "bounce message"
15292 .cindex "AUTH" "on bounce message"
15293 This option provides an authenticated sender address that is sent with any
15294 bounce messages generated by Exim that are sent over an authenticated SMTP
15295 connection. A typical setting might be:
15296 .code
15297 bounce_sender_authentication = mailer-daemon@my.domain.example
15298 .endd
15299 which would cause bounce messages to be sent using the SMTP command:
15300 .code
15301 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15302 .endd
15303 The value of &%bounce_sender_authentication%& must always be a complete email
15304 address.
15305
15306 .option callout_domain_negative_expire main time 3h
15307 .cindex "caching" "callout timeouts"
15308 .cindex "callout" "caching timeouts"
15309 This option specifies the expiry time for negative callout cache data for a
15310 domain. See section &<<SECTcallver>>& for details of callout verification, and
15311 section &<<SECTcallvercache>>& for details of the caching.
15312
15313
15314 .option callout_domain_positive_expire main time 7d
15315 This option specifies the expiry time for positive callout cache data for a
15316 domain. See section &<<SECTcallver>>& for details of callout verification, and
15317 section &<<SECTcallvercache>>& for details of the caching.
15318
15319
15320 .option callout_negative_expire main time 2h
15321 This option specifies the expiry time for negative callout cache data for an
15322 address. See section &<<SECTcallver>>& for details of callout verification, and
15323 section &<<SECTcallvercache>>& for details of the caching.
15324
15325
15326 .option callout_positive_expire main time 24h
15327 This option specifies the expiry time for positive callout cache data for an
15328 address. See section &<<SECTcallver>>& for details of callout verification, and
15329 section &<<SECTcallvercache>>& for details of the caching.
15330
15331
15332 .option callout_random_local_part main string&!! "see below"
15333 This option defines the &"random"& local part that can be used as part of
15334 callout verification. The default value is
15335 .code
15336 $primary_hostname-$tod_epoch-testing
15337 .endd
15338 See section &<<CALLaddparcall>>& for details of how this value is used.
15339
15340
15341 .option check_log_inodes main integer 100
15342 See &%check_spool_space%& below.
15343
15344
15345 .option check_log_space main integer 10M
15346 See &%check_spool_space%& below.
15347
15348 .oindex "&%check_rfc2047_length%&"
15349 .cindex "RFC 2047" "disabling length check"
15350 .option check_rfc2047_length main boolean true
15351 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15352 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15353 word; strings to be encoded that exceed this length are supposed to use
15354 multiple encoded words. By default, Exim does not recognize encoded words that
15355 exceed the maximum length. However, it seems that some software, in violation
15356 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15357 set false, Exim recognizes encoded words of any length.
15358
15359
15360 .option check_spool_inodes main integer 100
15361 See &%check_spool_space%& below.
15362
15363
15364 .option check_spool_space main integer 10M
15365 .cindex "checking disk space"
15366 .cindex "disk space, checking"
15367 .cindex "spool directory" "checking space"
15368 The four &%check_...%& options allow for checking of disk resources before a
15369 message is accepted.
15370
15371 .vindex "&$log_inodes$&"
15372 .vindex "&$log_space$&"
15373 .vindex "&$spool_inodes$&"
15374 .vindex "&$spool_space$&"
15375 When any of these options are nonzero, they apply to all incoming messages. If you
15376 want to apply different checks to different kinds of message, you can do so by
15377 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15378 &$spool_space$& in an ACL with appropriate additional conditions.
15379
15380
15381 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15382 either value is greater than zero, for example:
15383 .code
15384 check_spool_space = 100M
15385 check_spool_inodes = 100
15386 .endd
15387 The spool partition is the one that contains the directory defined by
15388 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15389 transit.
15390
15391 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15392 files are written if either is greater than zero. These should be set only if
15393 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15394
15395 If there is less space or fewer inodes than requested, Exim refuses to accept
15396 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15397 error response to the MAIL command. If ESMTP is in use and there was a
15398 SIZE parameter on the MAIL command, its value is added to the
15399 &%check_spool_space%& value, and the check is performed even if
15400 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15401
15402 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15403 number of kilobytes (though specified in bytes).
15404 If a non-multiple of 1024 is specified, it is rounded up.
15405
15406 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15407 failure a message is written to stderr and Exim exits with a non-zero code, as
15408 it obviously cannot send an error message of any kind.
15409
15410 There is a slight performance penalty for these checks.
15411 Versions of Exim preceding 4.88 had these disabled by default;
15412 high-rate installations confident they will never run out of resources
15413 may wish to deliberately disable them.
15414
15415 .option chunking_advertise_hosts main "host list&!!" *
15416 .cindex CHUNKING advertisement
15417 .cindex "RFC 3030" "CHUNKING"
15418 .cindex "ESMTP extensions" CHUNKING
15419 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15420 these hosts.
15421 Hosts may use the BDAT command as an alternate to DATA.
15422
15423 .option commandline_checks_require_admin main boolean &`false`&
15424 .cindex "restricting access to features"
15425 This option restricts various basic checking features to require an
15426 administrative user.
15427 This affects most of the &%-b*%& options, such as &%-be%&.
15428
15429 .option debug_store main boolean &`false`&
15430 .cindex debugging "memory corruption"
15431 .cindex memory debugging
15432 This option, when true, enables extra checking in Exim's internal memory
15433 management.  For use when a memory corruption issue is being investigated,
15434 it should normally be left as default.
15435
15436 .option daemon_smtp_ports main string &`smtp`&
15437 .cindex "port" "for daemon"
15438 .cindex "TCP/IP" "setting listening ports"
15439 This option specifies one or more default SMTP ports on which the Exim daemon
15440 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15441 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15442
15443 .option daemon_startup_retries main integer 9
15444 .cindex "daemon startup, retrying"
15445 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15446 the daemon at startup when it cannot immediately bind a listening socket
15447 (typically because the socket is already in use): &%daemon_startup_retries%&
15448 defines the number of retries after the first failure, and
15449 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15450
15451 .option daemon_startup_sleep main time 30s
15452 See &%daemon_startup_retries%&.
15453
15454 .option delay_warning main "time list" 24h
15455 .cindex "warning of delay"
15456 .cindex "delay warning, specifying"
15457 .cindex "queue" "delay warning"
15458 When a message is delayed, Exim sends a warning message to the sender at
15459 intervals specified by this option. The data is a colon-separated list of times
15460 after which to send warning messages. If the value of the option is an empty
15461 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15462 message has been in the queue for longer than the last time, the last interval
15463 between the times is used to compute subsequent warning times. For example,
15464 with
15465 .code
15466 delay_warning = 4h:8h:24h
15467 .endd
15468 the first message is sent after 4 hours, the second after 8 hours, and
15469 the third one after 24 hours. After that, messages are sent every 16 hours,
15470 because that is the interval between the last two times on the list. If you set
15471 just one time, it specifies the repeat interval. For example, with:
15472 .code
15473 delay_warning = 6h
15474 .endd
15475 messages are repeated every six hours. To stop warnings after a given time, set
15476 a very large time at the end of the list. For example:
15477 .code
15478 delay_warning = 2h:12h:99d
15479 .endd
15480 Note that the option is only evaluated at the time a delivery attempt fails,
15481 which depends on retry and queue-runner configuration.
15482 Typically retries will be configured more frequently than warning messages.
15483
15484 .option delay_warning_condition main string&!! "see below"
15485 .vindex "&$domain$&"
15486 The string is expanded at the time a warning message might be sent. If all the
15487 deferred addresses have the same domain, it is set in &$domain$& during the
15488 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15489 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15490 &"false"& (the comparison being done caselessly) then the warning message is
15491 not sent. The default is:
15492 .code
15493 delay_warning_condition = ${if or {\
15494   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15495   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15496   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15497   } {no}{yes}}
15498 .endd
15499 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15500 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15501 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15502 &"auto-replied"& in an &'Auto-Submitted:'& header.
15503
15504 .option deliver_drop_privilege main boolean false
15505 .cindex "unprivileged delivery"
15506 .cindex "delivery" "unprivileged"
15507 If this option is set true, Exim drops its root privilege at the start of a
15508 delivery process, and runs as the Exim user throughout. This severely restricts
15509 the kinds of local delivery that are possible, but is viable in certain types
15510 of configuration. There is a discussion about the use of root privilege in
15511 chapter &<<CHAPsecurity>>&.
15512
15513 .option deliver_queue_load_max main fixed-point unset
15514 .cindex "load average"
15515 .cindex "queue runner" "abandoning"
15516 When this option is set, a queue run is abandoned if the system load average
15517 becomes greater than the value of the option. The option has no effect on
15518 ancient operating systems on which Exim cannot determine the load average.
15519 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15520
15521
15522 .option delivery_date_remove main boolean true
15523 .cindex "&'Delivery-date:'& header line"
15524 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15525 message when it is delivered, in exactly the same way as &'Return-path:'& is
15526 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15527 should not be present in incoming messages, and this option causes them to be
15528 removed at the time the message is received, to avoid any problems that might
15529 occur when a delivered message is subsequently sent on to some other recipient.
15530
15531 .option disable_fsync main boolean false
15532 .cindex "&[fsync()]&, disabling"
15533 This option is available only if Exim was built with the compile-time option
15534 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15535 a runtime configuration generates an &"unknown option"& error. You should not
15536 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15537 really, really, really understand what you are doing. &'No pre-compiled
15538 distributions of Exim should ever make this option available.'&
15539
15540 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15541 updated files' data to be written to disc before continuing. Unexpected events
15542 such as crashes and power outages may cause data to be lost or scrambled.
15543 Here be Dragons. &*Beware.*&
15544
15545
15546 .option disable_ipv6 main boolean false
15547 .cindex "IPv6" "disabling"
15548 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15549 activities take place. AAAA records are never looked up, and any IPv6 addresses
15550 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15551 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15552 to handle IPv6 literal addresses.
15553
15554
15555 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15556 .cindex DKIM "selecting signature algorithms"
15557 This option gives a list of hash types which are acceptable in signatures,
15558 and an order of processing.
15559 Signatures with algorithms not in the list will be ignored.
15560
15561 Acceptable values include:
15562 .code
15563 sha1
15564 sha256
15565 sha512
15566 .endd
15567
15568 Note that the acceptance of sha1 violates RFC 8301.
15569
15570 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15571 This option gives a list of key types which are acceptable in signatures,
15572 and an order of processing.
15573 Signatures with algorithms not in the list will be ignored.
15574
15575
15576 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15577 This option gives a list of key sizes which are acceptable in signatures.
15578 The list is keyed by the algorithm type for the key; the values are in bits.
15579 Signatures with keys smaller than given by this option will fail verification.
15580
15581 The default enforces the RFC 8301 minimum key size for RSA signatures.
15582
15583 .option dkim_verify_minimal main boolean false
15584 If set to true, verification of signatures will terminate after the
15585 first success.
15586
15587 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15588 .cindex DKIM "controlling calls to the ACL"
15589 This option gives a list of DKIM domains for which the DKIM ACL is run.
15590 It is expanded after the message is received; by default it runs
15591 the ACL once for each signature in the message.
15592 See section &<<SECDKIMVFY>>&.
15593
15594
15595 .option dmarc_forensic_sender main string&!! unset
15596 .option dmarc_history_file main string unset
15597 .option dmarc_tld_file main string unset
15598 .cindex DMARC "main section options"
15599 These options control DMARC processing.
15600 See section &<<SECDMARC>>& for details.
15601
15602
15603 .option dns_again_means_nonexist main "domain list&!!" unset
15604 .cindex "DNS" "&""try again""& response; overriding"
15605 DNS lookups give a &"try again"& response for the DNS errors
15606 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15607 keep trying to deliver a message, or to give repeated temporary errors to
15608 incoming mail. Sometimes the effect is caused by a badly set up name server and
15609 may persist for a long time. If a domain which exhibits this problem matches
15610 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15611 This option should be used with care. You can make it apply to reverse lookups
15612 by a setting such as this:
15613 .code
15614 dns_again_means_nonexist = *.in-addr.arpa
15615 .endd
15616 This option applies to all DNS lookups that Exim does. It also applies when the
15617 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15618 since these are most likely to be caused by DNS lookup problems. The
15619 &(dnslookup)& router has some options of its own for controlling what happens
15620 when lookups for MX or SRV records give temporary errors. These more specific
15621 options are applied after this global option.
15622
15623 .option dns_check_names_pattern main string "see below"
15624 .cindex "DNS" "pre-check of name syntax"
15625 When this option is set to a non-empty string, it causes Exim to check domain
15626 names for characters that are not allowed in host names before handing them to
15627 the DNS resolver, because some resolvers give temporary errors for names that
15628 contain unusual characters. If a domain name contains any unwanted characters,
15629 a &"not found"& result is forced, and the resolver is not called. The check is
15630 done by matching the domain name against a regular expression, which is the
15631 value of this option. The default pattern is
15632 .code
15633 dns_check_names_pattern = \
15634   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15635 .endd
15636 which permits only letters, digits, slashes, and hyphens in components, but
15637 they must start and end with a letter or digit. Slashes are not, in fact,
15638 permitted in host names, but they are found in certain NS records (which can be
15639 accessed in Exim by using a &%dnsdb%& lookup). If you set
15640 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15641 empty string.
15642
15643 .option dns_csa_search_limit main integer 5
15644 This option controls the depth of parental searching for CSA SRV records in the
15645 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15646
15647 .option dns_csa_use_reverse main boolean true
15648 This option controls whether or not an IP address, given as a CSA domain, is
15649 reversed and looked up in the reverse DNS, as described in more detail in
15650 section &<<SECTverifyCSA>>&.
15651
15652 .option dns_cname_loops main integer 1
15653 .cindex DNS "CNAME following"
15654 This option controls the following of CNAME chains, needed if the resolver does
15655 not do it internally.
15656 As of 2018 most should, and the default can be left.
15657 If you have an ancient one, a value of 10 is likely needed.
15658
15659 The default value of one CNAME-follow is needed
15660 thanks to the observed return for an MX request,
15661 given no MX presence but a CNAME to an A, of the CNAME.
15662
15663
15664 .option dns_dnssec_ok main integer -1
15665 .cindex "DNS" "resolver options"
15666 .cindex "DNS" "DNSSEC"
15667 If this option is set to a non-negative number then Exim will initialise the
15668 DNS resolver library to either use or not use DNSSEC, overriding the system
15669 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15670
15671 If the resolver library does not support DNSSEC then this option has no effect.
15672
15673 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15674 will default to stripping out a successful validation status.
15675 This will break a previously working Exim installation.
15676 Provided that you do trust the resolver (ie, is on localhost) you can tell
15677 glibc to pass through any successful validation with a new option in
15678 &_/etc/resolv.conf_&:
15679 .code
15680 options trust-ad
15681 .endd
15682
15683
15684 .option dns_ipv4_lookup main "domain list&!!" unset
15685 .cindex "IPv6" "DNS lookup for AAAA records"
15686 .cindex "DNS" "IPv6 lookup for AAAA records"
15687 .cindex DNS "IPv6 disabling"
15688 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15689 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15690 (A records) when trying to find IP addresses for hosts, unless the host's
15691 domain matches this list.
15692
15693 This is a fudge to help with name servers that give big delays or otherwise do
15694 not work for the AAAA record type. In due course, when the world's name
15695 servers have all been upgraded, there should be no need for this option.
15696 Note that all lookups, including those done for verification, are affected;
15697 this will result in verify failure for IPv6 connections or ones using names
15698 only valid for IPv6 addresses.
15699
15700
15701 .option dns_retrans main time 0s
15702 .cindex "DNS" "resolver options"
15703 .cindex timeout "dns lookup"
15704 .cindex "DNS" timeout
15705 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15706 retransmission and retry parameters for DNS lookups. Values of zero (the
15707 defaults) leave the system default settings unchanged. The first value is the
15708 time between retries, and the second is the number of retries. It isn't
15709 totally clear exactly how these settings affect the total time a DNS lookup may
15710 take. I haven't found any documentation about timeouts on DNS lookups; these
15711 parameter values are available in the external resolver interface structure,
15712 but nowhere does it seem to describe how they are used or what you might want
15713 to set in them.
15714 See also the &%slow_lookup_log%& option.
15715
15716
15717 .option dns_retry main integer 0
15718 See &%dns_retrans%& above.
15719
15720
15721 .option dns_trust_aa main "domain list&!!" unset
15722 .cindex "DNS" "resolver options"
15723 .cindex "DNS" "DNSSEC"
15724 If this option is set then lookup results marked with the AA bit
15725 (Authoritative Answer) are trusted the same way as if they were
15726 DNSSEC-verified. The authority section's name of the answer must
15727 match with this expanded domain list.
15728
15729 Use this option only if you talk directly to a resolver that is
15730 authoritative for some zones and does not set the AD (Authentic Data)
15731 bit in the answer. Some DNS servers may have an configuration option to
15732 mark the answers from their own zones as verified (they set the AD bit).
15733 Others do not have this option. It is considered as poor practice using
15734 a resolver that is an authoritative server for some zones.
15735
15736 Use this option only if you really have to (e.g. if you want
15737 to use DANE for remote delivery to a server that is listed in the DNS
15738 zones that your resolver is authoritative for).
15739
15740 If the DNS answer packet has the AA bit set and contains resource record
15741 in the answer section, the name of the first NS record appearing in the
15742 authority section is compared against the list. If the answer packet is
15743 authoritative but the answer section is empty, the name of the first SOA
15744 record in the authoritative section is used instead.
15745
15746 .cindex "DNS" "resolver options"
15747 .option dns_use_edns0 main integer -1
15748 .cindex "DNS" "resolver options"
15749 .cindex "DNS" "EDNS0"
15750 .cindex "DNS" "OpenBSD
15751 If this option is set to a non-negative number then Exim will initialise the
15752 DNS resolver library to either use or not use EDNS0 extensions, overriding
15753 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15754 on.
15755
15756 If the resolver library does not support EDNS0 then this option has no effect.
15757
15758 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15759 means that DNSSEC will not work with Exim on that platform either, unless Exim
15760 is linked against an alternative DNS client library.
15761
15762
15763 .option drop_cr main boolean false
15764 This is an obsolete option that is now a no-op. It used to affect the way Exim
15765 handled CR and LF characters in incoming messages. What happens now is
15766 described in section &<<SECTlineendings>>&.
15767
15768 .option dsn_advertise_hosts main "host list&!!" unset
15769 .cindex "bounce messages" "success"
15770 .cindex "DSN" "success"
15771 .cindex "Delivery Status Notification" "success"
15772 .cindex "ESMTP extensions" DSN
15773 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15774 and accepted from, these hosts.
15775 Hosts may use the NOTIFY and ORCPT options on RCPT TO commands,
15776 and RET and ENVID options on MAIL FROM commands.
15777 A NOTIFY=SUCCESS option requests success-DSN messages.
15778 A NOTIFY= option with no argument requests that no delay or failure DSNs
15779 are sent.
15780 &*Note*&: Supplying success-DSN messages has been criticised
15781 on privacy grounds; it can leak details of internal forwarding.
15782
15783 .option dsn_from main "string&!!" "see below"
15784 .cindex "&'From:'& header line" "in bounces"
15785 .cindex "bounce messages" "&'From:'& line, specifying"
15786 This option can be used to vary the contents of &'From:'& header lines in
15787 bounces and other automatically generated messages (&"Delivery Status
15788 Notifications"& &-- hence the name of the option). The default setting is:
15789 .code
15790 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15791 .endd
15792 The value is expanded every time it is needed. If the expansion fails, a
15793 panic is logged, and the default value is used.
15794
15795 .option envelope_to_remove main boolean true
15796 .cindex "&'Envelope-to:'& header line"
15797 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15798 message when it is delivered, in exactly the same way as &'Return-path:'& is
15799 handled. &'Envelope-to:'& records the original recipient address from the
15800 message's envelope that caused the delivery to happen. Such headers should not
15801 be present in incoming messages, and this option causes them to be removed at
15802 the time the message is received, to avoid any problems that might occur when a
15803 delivered message is subsequently sent on to some other recipient.
15804
15805
15806 .option errors_copy main "string list&!!" unset
15807 .cindex "bounce message" "copy to other address"
15808 .cindex "copy of bounce message"
15809 Setting this option causes Exim to send bcc copies of bounce messages that it
15810 generates to other addresses. &*Note*&: This does not apply to bounce messages
15811 coming from elsewhere. The value of the option is a colon-separated list of
15812 items. Each item consists of a pattern, terminated by white space, followed by
15813 a comma-separated list of email addresses. If a pattern contains spaces, it
15814 must be enclosed in double quotes.
15815
15816 Each pattern is processed in the same way as a single item in an address list
15817 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15818 the bounce message, the message is copied to the addresses on the list. The
15819 items are scanned in order, and once a matching one is found, no further items
15820 are examined. For example:
15821 .code
15822 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15823               rqps@mydomain   hostmaster@mydomain.example,\
15824                               postmaster@mydomain.example
15825 .endd
15826 .vindex "&$domain$&"
15827 .vindex "&$local_part$&"
15828 The address list is expanded before use. The expansion variables &$local_part$&
15829 and &$domain$& are set from the original recipient of the error message, and if
15830 there was any wildcard matching in the pattern, the expansion
15831 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15832 variables &$0$&, &$1$&, etc. are set in the normal way.
15833
15834
15835 .option errors_reply_to main string unset
15836 .cindex "bounce message" "&'Reply-to:'& in"
15837 By default, Exim's bounce and delivery warning messages contain the header line
15838 .display
15839 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15840 .endd
15841 .oindex &%quota_warn_message%&
15842 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15843 A warning message that is generated by the &%quota_warn_message%& option in an
15844 &(appendfile)& transport may contain its own &'From:'& header line that
15845 overrides the default.
15846
15847 Experience shows that people reply to bounce messages. If the
15848 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15849 and warning messages. For example:
15850 .code
15851 errors_reply_to = postmaster@my.domain.example
15852 .endd
15853 The value of the option is not expanded. It must specify a valid RFC 2822
15854 address. However, if a warning message that is generated by the
15855 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15856 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15857 not used.
15858
15859
15860 .option event_action main string&!! unset
15861 .cindex events
15862 This option declares a string to be expanded for Exim's events mechanism.
15863 For details see chapter &<<CHAPevents>>&.
15864
15865
15866 .option exim_group main string "compile-time configured"
15867 .cindex "gid (group id)" "Exim's own"
15868 .cindex "Exim group"
15869 This option changes the gid under which Exim runs when it gives up root
15870 privilege. The default value is compiled into the binary. The value of this
15871 option is used only when &%exim_user%& is also set. Unless it consists entirely
15872 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15873 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15874 security issues.
15875
15876
15877 .option exim_path main string "see below"
15878 .cindex "Exim binary, path name"
15879 This option specifies the path name of the Exim binary, which is used when Exim
15880 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15881 the directory configured at compile time by the BIN_DIRECTORY setting. It
15882 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15883 other place.
15884 &*Warning*&: Do not use a macro to define the value of this option, because
15885 you will break those Exim utilities that scan the configuration file to find
15886 where the binary is. (They then use the &%-bP%& option to extract option
15887 settings such as the value of &%spool_directory%&.)
15888
15889
15890 .option exim_user main string "compile-time configured"
15891 .cindex "uid (user id)" "Exim's own"
15892 .cindex "Exim user"
15893 This option changes the uid under which Exim runs when it gives up root
15894 privilege. The default value is compiled into the binary. Ownership of the run
15895 time configuration file and the use of the &%-C%& and &%-D%& command line
15896 options is checked against the values in the binary, not what is set here.
15897
15898 Unless it consists entirely of digits, the string is looked up using
15899 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15900 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15901 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15902
15903
15904 .option exim_version main string "current version"
15905 .cindex "Exim version"
15906 .cindex customizing "version number"
15907 .cindex "version number of Exim" override
15908 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15909 various places.  Use with care; this may fool stupid security scanners.
15910
15911
15912 .option extra_local_interfaces main "string list" unset
15913 This option defines network interfaces that are to be considered local when
15914 routing, but which are not used for listening by the daemon. See section
15915 &<<SECTreclocipadd>>& for details.
15916
15917
15918 . Allow this long option name to split; give it unsplit as a fifth argument
15919 . for the automatic .oindex that is generated by .option.
15920
15921 .option "extract_addresses_remove_arguments" main boolean true &&&
15922          extract_addresses_remove_arguments
15923 .oindex "&%-t%&"
15924 .cindex "command line" "addresses with &%-t%&"
15925 .cindex "Sendmail compatibility" "&%-t%& option"
15926 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15927 are present on the command line when the &%-t%& option is used to build an
15928 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15929 line addresses are removed from the recipients list. This is also how Smail
15930 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15931 command line addresses are added to those obtained from the header lines. When
15932 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15933 argument headers. If it is set false, Exim adds rather than removes argument
15934 addresses.
15935
15936
15937 .option finduser_retries main integer 0
15938 .cindex "NIS, retrying user lookups"
15939 On systems running NIS or other schemes in which user and group information is
15940 distributed from a remote system, there can be times when &[getpwnam()]& and
15941 related functions fail, even when given valid data, because things time out.
15942 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15943 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15944 many extra times to find a user or a group, waiting for one second between
15945 retries.
15946
15947 .cindex "&_/etc/passwd_&" "multiple reading of"
15948 You should not set this option greater than zero if your user information is in
15949 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15950 search the file multiple times for non-existent users, and also cause delay.
15951
15952
15953
15954 .option freeze_tell main "string list, comma separated" unset
15955 .cindex "freezing messages" "sending a message when freezing"
15956 On encountering certain errors, or when configured to do so in a system filter,
15957 ACL, or special router, Exim freezes a message. This means that no further
15958 delivery attempts take place until an administrator thaws the message, or the
15959 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15960 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15961 warning message whenever it freezes something, unless the message it is
15962 freezing is a locally-generated bounce message. (Without this exception there
15963 is the possibility of looping.) The warning message is sent to the addresses
15964 supplied as the comma-separated value of this option. If several of the
15965 message's addresses cause freezing, only a single message is sent. If the
15966 freezing was automatic, the reason(s) for freezing can be found in the message
15967 log. If you configure freezing in a filter or ACL, you must arrange for any
15968 logging that you require.
15969
15970
15971 .option gecos_name main string&!! unset
15972 .cindex "HP-UX"
15973 .cindex "&""gecos""& field, parsing"
15974 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15975 password file to hold other information in addition to users' real names. Exim
15976 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15977 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15978 of the field are used unchanged, except that, if an ampersand is encountered,
15979 it is replaced by the user's login name with the first character forced to
15980 upper case, since this is a convention that is observed on many systems.
15981
15982 When these options are set, &%gecos_pattern%& is treated as a regular
15983 expression that is to be applied to the field (again with && replaced by the
15984 login name), and if it matches, &%gecos_name%& is expanded and used as the
15985 user's name.
15986
15987 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15988 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15989 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15990 name terminates at the first comma, the following can be used:
15991 .code
15992 gecos_pattern = ([^,]*)
15993 gecos_name = $1
15994 .endd
15995
15996 .option gecos_pattern main string unset
15997 See &%gecos_name%& above.
15998
15999
16000 .option gnutls_compat_mode main boolean unset
16001 This option controls whether GnuTLS is used in compatibility mode in an Exim
16002 server. This reduces security slightly, but improves interworking with older
16003 implementations of TLS.
16004
16005
16006 .option gnutls_allow_auto_pkcs11 main boolean unset
16007 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
16008 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
16009
16010 See
16011 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
16012 for documentation.
16013
16014
16015
16016 .option headers_charset main string "see below"
16017 This option sets a default character set for translating from encoded MIME
16018 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16019 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16020 ultimate default is ISO-8859-1. For more details see the description of header
16021 insertions in section &<<SECTexpansionitems>>&.
16022
16023
16024
16025 .option header_maxsize main integer "see below"
16026 .cindex "header section" "maximum size of"
16027 .cindex "limit" "size of message header section"
16028 This option controls the overall maximum size of a message's header
16029 section. The default is the value of HEADER_MAXSIZE in
16030 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16031 sections are rejected.
16032
16033
16034 .option header_line_maxsize main integer 0
16035 .cindex "header lines" "maximum size of"
16036 .cindex "limit" "size of one header line"
16037 This option limits the length of any individual header line in a message, after
16038 all the continuations have been joined together. Messages with individual
16039 header lines that are longer than the limit are rejected. The default value of
16040 zero means &"no limit"&.
16041
16042
16043
16044
16045 .option helo_accept_junk_hosts main "host list&!!" unset
16046 .cindex "HELO" "accepting junk data"
16047 .cindex "EHLO" "accepting junk data"
16048 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16049 mail, and gives an error response for invalid data. Unfortunately, there are
16050 some SMTP clients that send syntactic junk. They can be accommodated by setting
16051 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16052 if you want to do semantic checking.
16053 See also &%helo_allow_chars%& for a way of extending the permitted character
16054 set.
16055
16056
16057 .option helo_allow_chars main string unset
16058 .cindex "HELO" "underscores in"
16059 .cindex "EHLO" "underscores in"
16060 .cindex "underscore in EHLO/HELO"
16061 This option can be set to a string of rogue characters that are permitted in
16062 all EHLO and HELO names in addition to the standard letters, digits,
16063 hyphens, and dots. If you really must allow underscores, you can set
16064 .code
16065 helo_allow_chars = _
16066 .endd
16067 Note that the value is one string, not a list.
16068
16069
16070 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16071 .cindex "HELO" "forcing reverse lookup"
16072 .cindex "EHLO" "forcing reverse lookup"
16073 If the domain given by a client in a HELO or EHLO command matches this
16074 list, a reverse lookup is done in order to establish the host's true name. The
16075 default forces a lookup if the client host gives the server's name or any of
16076 its IP addresses (in brackets), something that broken clients have been seen to
16077 do.
16078
16079
16080 .option helo_try_verify_hosts main "host list&!!" unset
16081 .cindex "HELO verifying" "optional"
16082 .cindex "EHLO" "verifying, optional"
16083 By default, Exim just checks the syntax of HELO and EHLO commands (see
16084 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16085 to do more extensive checking of the data supplied by these commands. The ACL
16086 condition &`verify = helo`& is provided to make this possible.
16087 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16088 to force the check to occur. From release 4.53 onwards, this is no longer
16089 necessary. If the check has not been done before &`verify = helo`& is
16090 encountered, it is done at that time. Consequently, this option is obsolete.
16091 Its specification is retained here for backwards compatibility.
16092
16093 When an EHLO or HELO command is received, if the calling host matches
16094 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16095 EHLO command either:
16096
16097 .ilist
16098 is an IP literal matching the calling address of the host, or
16099 .next
16100 .cindex "DNS" "reverse lookup"
16101 .cindex "reverse DNS lookup"
16102 matches the host name that Exim obtains by doing a reverse lookup of the
16103 calling host address, or
16104 .next
16105 when looked up in DNS yields the calling host address.
16106 .endlist
16107
16108 However, the EHLO or HELO command is not rejected if any of the checks
16109 fail. Processing continues, but the result of the check is remembered, and can
16110 be detected later in an ACL by the &`verify = helo`& condition.
16111
16112 If DNS was used for successful verification, the variable
16113 .cindex "DNS" "DNSSEC"
16114 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16115
16116 .option helo_verify_hosts main "host list&!!" unset
16117 .cindex "HELO verifying" "mandatory"
16118 .cindex "EHLO" "verifying, mandatory"
16119 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16120 backwards compatibility. For hosts that match this option, Exim checks the host
16121 name given in the HELO or EHLO in the same way as for
16122 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16123 rejected with a 550 error, and entries are written to the main and reject logs.
16124 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16125 error.
16126
16127 .option hold_domains main "domain list&!!" unset
16128 .cindex "domain" "delaying delivery"
16129 .cindex "delivery" "delaying certain domains"
16130 This option allows mail for particular domains to be held in the queue
16131 manually. The option is overridden if a message delivery is forced with the
16132 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16133 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16134 item in &%hold_domains%&, no routing or delivery for that address is done, and
16135 it is deferred every time the message is looked at.
16136
16137 This option is intended as a temporary operational measure for delaying the
16138 delivery of mail while some problem is being sorted out, or some new
16139 configuration tested. If you just want to delay the processing of some
16140 domains until a queue run occurs, you should use &%queue_domains%& or
16141 &%queue_smtp_domains%&, not &%hold_domains%&.
16142
16143 A setting of &%hold_domains%& does not override Exim's code for removing
16144 messages from the queue if they have been there longer than the longest retry
16145 time in any retry rule. If you want to hold messages for longer than the normal
16146 retry times, insert a dummy retry rule with a long retry time.
16147
16148
16149 .option host_lookup main "host list&!!" unset
16150 .cindex "host name" "lookup, forcing"
16151 Exim does not look up the name of a calling host from its IP address unless it
16152 is required to compare against some host list, or the host matches
16153 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16154 option (which normally contains IP addresses rather than host names). The
16155 default configuration file contains
16156 .code
16157 host_lookup = *
16158 .endd
16159 which causes a lookup to happen for all hosts. If the expense of these lookups
16160 is felt to be too great, the setting can be changed or removed.
16161
16162 After a successful reverse lookup, Exim does a forward lookup on the name it
16163 has obtained, to verify that it yields the IP address that it started with. If
16164 this check fails, Exim behaves as if the name lookup failed.
16165
16166 .vindex "&$host_lookup_failed$&"
16167 .vindex "&$sender_host_name$&"
16168 After any kind of failure, the host name (in &$sender_host_name$&) remains
16169 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16170 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16171 &`verify = reverse_host_lookup`& in ACLs.
16172
16173
16174 .option host_lookup_order main "string list" &`bydns:byaddr`&
16175 This option specifies the order of different lookup methods when Exim is trying
16176 to find a host name from an IP address. The default is to do a DNS lookup
16177 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16178 if that fails. You can change the order of these lookups, or omit one entirely,
16179 if you want.
16180
16181 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16182 multiple PTR records in the DNS and the IP address is not listed in
16183 &_/etc/hosts_&. Different operating systems give different results in this
16184 case. That is why the default tries a DNS lookup first.
16185
16186
16187
16188 .option host_reject_connection main "host list&!!" unset
16189 .cindex "host" "rejecting connections from"
16190 If this option is set, incoming SMTP calls from the hosts listed are rejected
16191 as soon as the connection is made.
16192 This option is mostly obsolete, retained for backward compatibility because
16193 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16194 connections immediately
16195 .new
16196 (except for tls-on-connect connections).
16197 .wen
16198
16199 The ability to give an immediate rejection (either by this option or using an
16200 ACL) is provided for use in unusual cases. Many hosts will just try again,
16201 sometimes without much delay. Normally, it is better to use an ACL to reject
16202 incoming messages at a later stage, such as after RCPT commands. See
16203 chapter &<<CHAPACL>>&.
16204
16205
16206 .option hosts_connection_nolog main "host list&!!" unset
16207 .cindex "host" "not logging connections from"
16208 This option defines a list of hosts for which connection logging does not
16209 happen, even though the &%smtp_connection%& log selector is set. For example,
16210 you might want not to log SMTP connections from local processes, or from
16211 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16212 the daemon; you should therefore strive to restrict its value to a short inline
16213 list of IP addresses and networks. To disable logging SMTP connections from
16214 local processes, you must create a host list with an empty item. For example:
16215 .code
16216 hosts_connection_nolog = :
16217 .endd
16218 .new
16219 The hosts affected by this option also do not log "no MAIL in SMTP connection"
16220 lines, as may commonly be produced by a monitoring system.
16221 .wen
16222
16223
16224 .option hosts_require_alpn main "host list&!!" unset
16225 .cindex ALPN "require negotiation in server"
16226 .cindex TLS ALPN
16227 .cindex TLS "Application Layer Protocol Names"
16228 If the TLS library supports ALPN
16229 then a successful negotiation of ALPN will be required for any client
16230 matching the list, for TLS to be used.
16231 See also the &%tls_alpn%& option.
16232
16233 &*Note*&: prevention of fallback to in-clear connection is not
16234 managed by this option, and should be done separately.
16235
16236
16237 .option hosts_require_helo main "host list&!!" *
16238 .cindex "HELO/EHLO" requiring
16239 Exim will require an accepted HELO or EHLO command from a host matching
16240 this list, before accepting a MAIL command.
16241
16242
16243 .option hosts_proxy main "host list&!!" unset
16244 .cindex proxy "proxy protocol"
16245 This option enables use of Proxy Protocol proxies for incoming
16246 connections.  For details see section &<<SECTproxyInbound>>&.
16247
16248
16249 .option hosts_treat_as_local main "domain list&!!" unset
16250 .cindex "local host" "domains treated as"
16251 .cindex "host" "treated as local"
16252 If this option is set, any host names that match the domain list are treated as
16253 if they were the local host when Exim is scanning host lists obtained from MX
16254 records
16255 or other sources. Note that the value of this option is a domain list, not a
16256 host list, because it is always used to check host names, not IP addresses.
16257
16258 This option also applies when Exim is matching the special items
16259 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16260 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16261 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16262 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16263 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16264 interfaces and recognizing the local host.
16265
16266
16267 .option ibase_servers main "string list" unset
16268 .cindex "InterBase" "server list"
16269 This option provides a list of InterBase servers and associated connection data,
16270 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16271 The option is available only if Exim has been built with InterBase support.
16272
16273
16274
16275 .option ignore_bounce_errors_after main time 10w
16276 .cindex "bounce message" "discarding"
16277 .cindex "discarding bounce message"
16278 This option affects the processing of bounce messages that cannot be delivered,
16279 that is, those that suffer a permanent delivery failure. (Bounce messages that
16280 suffer temporary delivery failures are of course retried in the usual way.)
16281
16282 After a permanent delivery failure, bounce messages are frozen,
16283 because there is no sender to whom they can be returned. When a frozen bounce
16284 message has been in the queue for more than the given time, it is unfrozen at
16285 the next queue run, and a further delivery is attempted. If delivery fails
16286 again, the bounce message is discarded. This makes it possible to keep failed
16287 bounce messages around for a shorter time than the normal maximum retry time
16288 for frozen messages. For example,
16289 .code
16290 ignore_bounce_errors_after = 12h
16291 .endd
16292 retries failed bounce message deliveries after 12 hours, discarding any further
16293 failures. If the value of this option is set to a zero time period, bounce
16294 failures are discarded immediately. Setting a very long time (as in the default
16295 value) has the effect of disabling this option. For ways of automatically
16296 dealing with other kinds of frozen message, see &%auto_thaw%& and
16297 &%timeout_frozen_after%&.
16298
16299
16300 .option ignore_fromline_hosts main "host list&!!" unset
16301 .cindex "&""From""& line"
16302 .cindex "UUCP" "&""From""& line"
16303 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16304 the headers of a message. By default this is treated as the start of the
16305 message's body, which means that any following headers are not recognized as
16306 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16307 match those hosts that insist on sending it. If the sender is actually a local
16308 process rather than a remote host, and is using &%-bs%& to inject the messages,
16309 &%ignore_fromline_local%& must be set to achieve this effect.
16310
16311
16312 .option ignore_fromline_local main boolean false
16313 See &%ignore_fromline_hosts%& above.
16314
16315 .option keep_environment main "string list" unset
16316 .cindex "environment" "values from"
16317 This option contains a string list of environment variables to keep.
16318 You have to trust these variables or you have to be sure that
16319 these variables do not impose any security risk. Keep in mind that
16320 during the startup phase Exim is running with an effective UID 0 in most
16321 installations. As the default value is an empty list, the default
16322 environment for using libraries, running embedded Perl code, or running
16323 external binaries is empty, and does not not even contain PATH or HOME.
16324
16325 Actually the list is interpreted as a list of patterns
16326 (&<<SECTlistexpand>>&), except that it is not expanded first.
16327
16328 WARNING: Macro substitution is still done first, so having a macro
16329 FOO and having FOO_HOME in your &%keep_environment%& option may have
16330 unexpected results. You may work around this using a regular expression
16331 that does not match the macro name: ^[F]OO_HOME$.
16332
16333 Current versions of Exim issue a warning during startup if you do not mention
16334 &%keep_environment%& in your runtime configuration file and if your
16335 current environment is not empty. Future versions may not issue that warning
16336 anymore.
16337
16338 See the &%add_environment%& main config option for a way to set
16339 environment variables to a fixed value.  The environment for &(pipe)&
16340 transports is handled separately, see section &<<SECTpipeenv>>& for
16341 details.
16342
16343
16344 .option keep_malformed main time 4d
16345 This option specifies the length of time to keep messages whose spool files
16346 have been corrupted in some way. This should, of course, never happen. At the
16347 next attempt to deliver such a message, it gets removed. The incident is
16348 logged.
16349
16350
16351 .option ldap_ca_cert_dir main string unset
16352 .cindex "LDAP", "TLS CA certificate directory"
16353 .cindex certificate "directory for LDAP"
16354 This option indicates which directory contains CA certificates for verifying
16355 a TLS certificate presented by an LDAP server.
16356 While Exim does not provide a default value, your SSL library may.
16357 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16358 and constrained to be a directory.
16359
16360
16361 .option ldap_ca_cert_file main string unset
16362 .cindex "LDAP", "TLS CA certificate file"
16363 .cindex certificate "file for LDAP"
16364 This option indicates which file contains CA certificates for verifying
16365 a TLS certificate presented by an LDAP server.
16366 While Exim does not provide a default value, your SSL library may.
16367 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16368 and constrained to be a file.
16369
16370
16371 .option ldap_cert_file main string unset
16372 .cindex "LDAP" "TLS client certificate file"
16373 .cindex certificate "file for LDAP"
16374 This option indicates which file contains an TLS client certificate which
16375 Exim should present to the LDAP server during TLS negotiation.
16376 Should be used together with &%ldap_cert_key%&.
16377
16378
16379 .option ldap_cert_key main string unset
16380 .cindex "LDAP" "TLS client key file"
16381 .cindex certificate "key for LDAP"
16382 This option indicates which file contains the secret/private key to use
16383 to prove identity to the LDAP server during TLS negotiation.
16384 Should be used together with &%ldap_cert_file%&, which contains the
16385 identity to be proven.
16386
16387
16388 .option ldap_cipher_suite main string unset
16389 .cindex "LDAP" "TLS cipher suite"
16390 This controls the TLS cipher-suite negotiation during TLS negotiation with
16391 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16392 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16393
16394
16395 .option ldap_default_servers main "string list" unset
16396 .cindex "LDAP" "default servers"
16397 This option provides a list of LDAP servers which are tried in turn when an
16398 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16399 details of LDAP queries. This option is available only when Exim has been built
16400 with LDAP support.
16401
16402
16403 .option ldap_require_cert main string unset.
16404 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16405 This should be one of the values "hard", "demand", "allow", "try" or "never".
16406 A value other than one of these is interpreted as "never".
16407 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16408 Although Exim does not set a default, the LDAP library probably defaults
16409 to hard/demand.
16410
16411
16412 .option ldap_start_tls main boolean false
16413 .cindex "LDAP" "whether or not to negotiate TLS"
16414 If set, Exim will attempt to negotiate TLS with the LDAP server when
16415 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16416 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16417 of SSL-on-connect.
16418 In the event of failure to negotiate TLS, the action taken is controlled
16419 by &%ldap_require_cert%&.
16420 This option is ignored for &`ldapi`& connections.
16421
16422
16423 .option ldap_version main integer unset
16424 .cindex "LDAP" "protocol version, forcing"
16425 This option can be used to force Exim to set a specific protocol version for
16426 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16427 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16428 the LDAP headers; otherwise it is 2. This option is available only when Exim
16429 has been built with LDAP support.
16430
16431
16432
16433 .option local_from_check main boolean true
16434 .cindex "&'Sender:'& header line" "disabling addition of"
16435 .cindex "&'From:'& header line" "disabling checking of"
16436 When a message is submitted locally (that is, not over a TCP/IP connection) by
16437 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16438 checks that the &'From:'& header line matches the login of the calling user and
16439 the domain specified by &%qualify_domain%&.
16440
16441 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16442 locally submitted message is automatically qualified by Exim, unless the
16443 &%-bnq%& command line option is used.
16444
16445 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16446 on the local part. If the &'From:'& header line does not match, Exim adds a
16447 &'Sender:'& header with an address constructed from the calling user's login
16448 and the default qualify domain.
16449
16450 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16451 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16452 &'Sender:'& header lines supplied by untrusted users, you must also set
16453 &%local_sender_retain%& to be true.
16454
16455 .cindex "envelope from"
16456 .cindex "envelope sender"
16457 These options affect only the header lines in the message. The envelope sender
16458 is still forced to be the login id at the qualify domain unless
16459 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16460
16461 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16462 request similar header line checking. See section &<<SECTthesenhea>>&, which
16463 has more details about &'Sender:'& processing.
16464
16465
16466
16467
16468 .option local_from_prefix main string unset
16469 When Exim checks the &'From:'& header line of locally submitted messages for
16470 matching the login id (see &%local_from_check%& above), it can be configured to
16471 ignore certain prefixes and suffixes in the local part of the address. This is
16472 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16473 appropriate lists, in the same form as the &%local_part_prefix%& and
16474 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16475 example, if
16476 .code
16477 local_from_prefix = *-
16478 .endd
16479 is set, a &'From:'& line containing
16480 .code
16481 From: anything-user@your.domain.example
16482 .endd
16483 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16484 matches the actual sender address that is constructed from the login name and
16485 qualify domain.
16486
16487
16488 .option local_from_suffix main string unset
16489 See &%local_from_prefix%& above.
16490
16491
16492 .option local_interfaces main "string list" "see below"
16493 This option controls which network interfaces are used by the daemon for
16494 listening; they are also used to identify the local host when routing. Chapter
16495 &<<CHAPinterfaces>>& contains a full description of this option and the related
16496 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16497 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16498 &%local_interfaces%& is
16499 .code
16500 local_interfaces = 0.0.0.0
16501 .endd
16502 when Exim is built without IPv6 support; otherwise it is
16503 .code
16504 local_interfaces = <; ::0 ; 0.0.0.0
16505 .endd
16506
16507 .option local_scan_timeout main time 5m
16508 .cindex "timeout" "for &[local_scan()]& function"
16509 .cindex "&[local_scan()]& function" "timeout"
16510 This timeout applies to the &[local_scan()]& function (see chapter
16511 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16512 the incoming message is rejected with a temporary error if it is an SMTP
16513 message. For a non-SMTP message, the message is dropped and Exim ends with a
16514 non-zero code. The incident is logged on the main and reject logs.
16515
16516
16517
16518 .option local_sender_retain main boolean false
16519 .cindex "&'Sender:'& header line" "retaining from local submission"
16520 When a message is submitted locally (that is, not over a TCP/IP connection) by
16521 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16522 do not want this to happen, you must set &%local_sender_retain%&, and you must
16523 also set &%local_from_check%& to be false (Exim will complain if you do not).
16524 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16525 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16526
16527
16528
16529
16530 .option localhost_number main string&!! unset
16531 .cindex "host" "locally unique number for"
16532 .cindex "message ids" "with multiple hosts"
16533 .vindex "&$localhost_number$&"
16534 Exim's message ids are normally unique only within the local host. If
16535 uniqueness among a set of hosts is required, each host must set a different
16536 value for the &%localhost_number%& option. The string is expanded immediately
16537 after reading the configuration file (so that a number can be computed from the
16538 host name, for example) and the result of the expansion must be a number in the
16539 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16540 systems). This is available in subsequent string expansions via the variable
16541 &$localhost_number$&. When &%localhost_number is set%&, the final two
16542 characters of the message id, instead of just being a fractional part of the
16543 time, are computed from the time and the local host number as described in
16544 section &<<SECTmessiden>>&.
16545
16546
16547
16548 .option log_file_path main "string list&!!" "set at compile time"
16549 .cindex "log" "file path for"
16550 This option sets the path which is used to determine the names of Exim's log
16551 files, or indicates that logging is to be to syslog, or both. It is expanded
16552 when Exim is entered, so it can, for example, contain a reference to the host
16553 name. If no specific path is set for the log files at compile or runtime,
16554 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16555 they are written in a sub-directory called &_log_& in Exim's spool directory.
16556 A path must start with a slash.
16557 To send to syslog, use the word &"syslog"&.
16558 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16559 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16560 used. If this string is fixed at your installation (contains no expansion
16561 variables) it is recommended that you do not set this option in the
16562 configuration file, but instead supply the path using LOG_FILE_PATH in
16563 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16564 early on &-- in particular, failure to read the configuration file.
16565
16566
16567 .option log_selector main string unset
16568 .cindex "log" "selectors"
16569 This option can be used to reduce or increase the number of things that Exim
16570 writes to its log files. Its argument is made up of names preceded by plus or
16571 minus characters. For example:
16572 .code
16573 log_selector = +arguments -retry_defer
16574 .endd
16575 A list of possible names and what they control is given in the chapter on
16576 logging, in section &<<SECTlogselector>>&.
16577
16578
16579 .option log_timezone main boolean false
16580 .cindex "log" "timezone for entries"
16581 .vindex "&$tod_log$&"
16582 .vindex "&$tod_zone$&"
16583 By default, the timestamps on log lines are in local time without the
16584 timezone. This means that if your timezone changes twice a year, the timestamps
16585 in log lines are ambiguous for an hour when the clocks go back. One way of
16586 avoiding this problem is to set the timezone to UTC. An alternative is to set
16587 &%log_timezone%& true. This turns on the addition of the timezone offset to
16588 timestamps in log lines. Turning on this option can add quite a lot to the size
16589 of log files because each line is extended by 6 characters. Note that the
16590 &$tod_log$& variable contains the log timestamp without the zone, but there is
16591 another variable called &$tod_zone$& that contains just the timezone offset.
16592
16593
16594 .option lookup_open_max main integer 25
16595 .cindex "too many open files"
16596 .cindex "open files, too many"
16597 .cindex "file" "too many open"
16598 .cindex "lookup" "maximum open files"
16599 .cindex "limit" "open files for lookups"
16600 This option limits the number of simultaneously open files for single-key
16601 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16602 Exim normally keeps these files open during routing, because often the same
16603 file is required several times. If the limit is reached, Exim closes the least
16604 recently used file. Note that if you are using the &'ndbm'& library, it
16605 actually opens two files for each logical DBM database, though it still counts
16606 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16607 open files"& errors with NDBM, you need to reduce the value of
16608 &%lookup_open_max%&.
16609
16610
16611 .option max_username_length main integer 0
16612 .cindex "length of login name"
16613 .cindex "user name" "maximum length"
16614 .cindex "limit" "user name length"
16615 Some operating systems are broken in that they truncate long arguments to
16616 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16617 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16618 an argument that is longer behaves as if &[getpwnam()]& failed.
16619
16620
16621 .option message_body_newlines main bool false
16622 .cindex "message body" "newlines in variables"
16623 .cindex "newline" "in message body variables"
16624 .vindex "&$message_body$&"
16625 .vindex "&$message_body_end$&"
16626 By default, newlines in the message body are replaced by spaces when setting
16627 the &$message_body$& and &$message_body_end$& expansion variables. If this
16628 option is set true, this no longer happens.
16629
16630
16631 .option message_body_visible main integer 500
16632 .cindex "body of message" "visible size"
16633 .cindex "message body" "visible size"
16634 .vindex "&$message_body$&"
16635 .vindex "&$message_body_end$&"
16636 This option specifies how much of a message's body is to be included in the
16637 &$message_body$& and &$message_body_end$& expansion variables.
16638
16639
16640 .option message_id_header_domain main string&!! unset
16641 .cindex "&'Message-ID:'& header line"
16642 If this option is set, the string is expanded and used as the right hand side
16643 (domain) of the &'Message-ID:'& header that Exim creates if a
16644 locally-originated incoming message does not have one. &"Locally-originated"&
16645 means &"not received over TCP/IP."&
16646 Otherwise, the primary host name is used.
16647 Only letters, digits, dot and hyphen are accepted; any other characters are
16648 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16649 empty string, the option is ignored.
16650
16651
16652 .option message_id_header_text main string&!! unset
16653 If this variable is set, the string is expanded and used to augment the text of
16654 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16655 message does not have one. The text of this header is required by RFC 2822 to
16656 take the form of an address. By default, Exim uses its internal message id as
16657 the local part, and the primary host name as the domain. If this option is set,
16658 it is expanded, and provided the expansion is not forced to fail, and does not
16659 yield an empty string, the result is inserted into the header immediately
16660 before the @, separated from the internal message id by a dot. Any characters
16661 that are illegal in an address are automatically converted into hyphens. This
16662 means that variables such as &$tod_log$& can be used, because the spaces and
16663 colons will become hyphens.
16664
16665
16666 .option message_logs main boolean true
16667 .cindex "message logs" "disabling"
16668 .cindex "log" "message log; disabling"
16669 If this option is turned off, per-message log files are not created in the
16670 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16671 Exim, by reducing the number of files involved in handling a message from a
16672 minimum of four (header spool file, body spool file, delivery journal, and
16673 per-message log) to three. The other major I/O activity is Exim's main log,
16674 which is not affected by this option.
16675
16676
16677 .option message_size_limit main string&!! 50M
16678 .cindex "message" "size limit"
16679 .cindex "limit" "message size"
16680 .cindex "size" "of message, limit"
16681 This option limits the maximum size of message that Exim will process. The
16682 value is expanded for each incoming connection so, for example, it can be made
16683 to depend on the IP address of the remote host for messages arriving via
16684 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16685 optionally followed by K or M.
16686
16687 .cindex "SIZE" "ESMTP extension, advertising"
16688 .cindex "ESMTP extensions" SIZE
16689 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16690 service extension keyword.
16691
16692 &*Note*&: This limit cannot be made to depend on a message's sender or any
16693 other properties of an individual message, because it has to be advertised in
16694 the server's response to EHLO. String expansion failure causes a temporary
16695 error. A value of zero means no limit, but its use is not recommended. See also
16696 &%bounce_return_size_limit%&.
16697
16698 Incoming SMTP messages are failed with a 552 error if the limit is
16699 exceeded; locally-generated messages either get a stderr message or a delivery
16700 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16701 an oversized message is logged in both the main and the reject logs. See also
16702 the generic transport option &%message_size_limit%&, which limits the size of
16703 message that an individual transport can process.
16704
16705 If you use a virus-scanner and set this option to to a value larger than the
16706 maximum size that your virus-scanner is configured to support, you may get
16707 failures triggered by large mails.  The right size to configure for the
16708 virus-scanner depends upon what data is passed and the options in use but it's
16709 probably safest to just set it to a little larger than this value.  E.g., with a
16710 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16711 some problems may result.
16712
16713 A value of 0 will disable size limit checking; Exim will still advertise the
16714 SIZE extension in an EHLO response, but without a limit, so as to permit
16715 SMTP clients to still indicate the message size along with the MAIL verb.
16716
16717
16718 .option move_frozen_messages main boolean false
16719 .cindex "frozen messages" "moving"
16720 This option, which is available only if Exim has been built with the setting
16721 .code
16722 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16723 .endd
16724 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16725 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16726 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16727 standard utilities for handling such moved messages, and they do not show up in
16728 lists generated by &%-bp%& or by the Exim monitor.
16729
16730
16731 .option mua_wrapper main boolean false
16732 Setting this option true causes Exim to run in a very restrictive mode in which
16733 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16734 contains a full description of this facility.
16735
16736
16737
16738 .option mysql_servers main "string list" unset
16739 .cindex "MySQL" "server list"
16740 This option provides a list of MySQL servers and associated connection data, to
16741 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16742 option is available only if Exim has been built with MySQL support.
16743
16744
16745 .option never_users main "string list&!!" unset
16746 This option is expanded just once, at the start of Exim's processing. Local
16747 message deliveries are normally run in processes that are setuid to the
16748 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16749 It is usually desirable to prevent any deliveries from running as root, as a
16750 safety precaution.
16751
16752 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16753 list of users that must not be used for local deliveries. This list is fixed in
16754 the binary and cannot be overridden by the configuration file. By default, it
16755 contains just the single user name &"root"&. The &%never_users%& runtime option
16756 can be used to add more users to the fixed list.
16757
16758 If a message is to be delivered as one of the users on the fixed list or the
16759 &%never_users%& list, an error occurs, and delivery is deferred. A common
16760 example is
16761 .code
16762 never_users = root:daemon:bin
16763 .endd
16764 Including root is redundant if it is also on the fixed list, but it does no
16765 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16766 transport driver.
16767
16768
16769 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16770 This option gives the name for a unix-domain socket on which the daemon
16771 listens for work and information-requests.
16772 Only installations running multiple daemons sharing a spool directory
16773 should need to modify the default.
16774
16775 The option is expanded before use.
16776 If the platform supports Linux-style abstract socket names, the result
16777 is used with a nul byte prefixed.
16778 Otherwise,
16779 it should be a full path name and use a directory accessible
16780 to Exim.
16781
16782 If this option is set as empty,
16783 or the command line &%-oY%& option is used, or
16784 the command line uses a &%-oX%& option and does not use &%-oP%&,
16785 then a notifier socket is not created.
16786
16787
16788 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16789 .cindex "OpenSSL "compatibility options"
16790 This option allows an administrator to adjust the SSL options applied
16791 by OpenSSL to connections.  It is given as a space-separated list of items,
16792 each one to be +added or -subtracted from the current value.
16793
16794 This option is only available if Exim is built against OpenSSL.  The values
16795 available for this option vary according to the age of your OpenSSL install.
16796 The &"all"& value controls a subset of flags which are available, typically
16797 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16798 list the values known on your system and Exim should support all the
16799 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16800 names lose the leading &"SSL_OP_"& and are lower-cased.
16801
16802 Note that adjusting the options can have severe impact upon the security of
16803 SSL as used by Exim.  It is possible to disable safety checks and shoot
16804 yourself in the foot in various unpleasant ways.  This option should not be
16805 adjusted lightly.  An unrecognised item will be detected at startup, by
16806 invoking Exim with the &%-bV%& flag.
16807
16808 The option affects Exim operating both as a server and as a client.
16809
16810 Historical note: prior to release 4.80, Exim defaulted this value to
16811 "+dont_insert_empty_fragments", which may still be needed for compatibility
16812 with some clients, but which lowers security by increasing exposure to
16813 some now infamous attacks.
16814
16815 Examples:
16816 .code
16817 # Make both old MS and old Eudora happy:
16818 openssl_options = -all +microsoft_big_sslv3_buffer \
16819                        +dont_insert_empty_fragments
16820
16821 # Disable older protocol versions:
16822 openssl_options = +no_sslv2 +no_sslv3
16823 .endd
16824
16825 Possible options may include:
16826 .ilist
16827 &`all`&
16828 .next
16829 &`allow_unsafe_legacy_renegotiation`&
16830 .next
16831 &`cipher_server_preference`&
16832 .next
16833 &`dont_insert_empty_fragments`&
16834 .next
16835 &`ephemeral_rsa`&
16836 .next
16837 &`legacy_server_connect`&
16838 .next
16839 &`microsoft_big_sslv3_buffer`&
16840 .next
16841 &`microsoft_sess_id_bug`&
16842 .next
16843 &`msie_sslv2_rsa_padding`&
16844 .next
16845 &`netscape_challenge_bug`&
16846 .next
16847 &`netscape_reuse_cipher_change_bug`&
16848 .next
16849 &`no_compression`&
16850 .next
16851 &`no_session_resumption_on_renegotiation`&
16852 .next
16853 &`no_sslv2`&
16854 .next
16855 &`no_sslv3`&
16856 .next
16857 &`no_ticket`&
16858 .next
16859 &`no_tlsv1`&
16860 .next
16861 &`no_tlsv1_1`&
16862 .next
16863 &`no_tlsv1_2`&
16864 .next
16865 &`safari_ecdhe_ecdsa_bug`&
16866 .next
16867 &`single_dh_use`&
16868 .next
16869 &`single_ecdh_use`&
16870 .next
16871 &`ssleay_080_client_dh_bug`&
16872 .next
16873 &`sslref2_reuse_cert_type_bug`&
16874 .next
16875 &`tls_block_padding_bug`&
16876 .next
16877 &`tls_d5_bug`&
16878 .next
16879 &`tls_rollback_bug`&
16880 .endlist
16881
16882 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16883 all clients connecting using the MacOS SecureTransport TLS facility prior
16884 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16885 to negotiate TLS then this option value might help, provided that your OpenSSL
16886 release is new enough to contain this work-around.  This may be a situation
16887 where you have to upgrade OpenSSL to get buggy clients working.
16888
16889
16890 .option oracle_servers main "string list" unset
16891 .cindex "Oracle" "server list"
16892 This option provides a list of Oracle servers and associated connection data,
16893 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16894 The option is available only if Exim has been built with Oracle support.
16895
16896
16897 .new
16898 .option panic_coredump main boolean false
16899 This option is rarely needed but can help for some debugging investigations.
16900 If set, when an internal error is detected by Exim which is sufficient
16901 to terminate the process
16902 (all such are logged in the paniclog)
16903 then a coredump is requested.
16904
16905 Note that most systems require additional administrative configuration
16906 to permit write a core file for a setuid program, which is Exim's
16907 common installed configuration.
16908 .wen
16909
16910 .option percent_hack_domains main "domain list&!!" unset
16911 .cindex "&""percent hack""&"
16912 .cindex "source routing" "in email address"
16913 .cindex "address" "source-routed"
16914 The &"percent hack"& is the convention whereby a local part containing a
16915 percent sign is re-interpreted as a new email address, with the percent
16916 replaced by @. This is sometimes called &"source routing"&, though that term is
16917 also applied to RFC 2822 addresses that begin with an @ character. If this
16918 option is set, Exim implements the percent facility for those domains listed,
16919 but no others. This happens before an incoming SMTP address is tested against
16920 an ACL.
16921
16922 &*Warning*&: The &"percent hack"& has often been abused by people who are
16923 trying to get round relaying restrictions. For this reason, it is best avoided
16924 if at all possible. Unfortunately, a number of less security-conscious MTAs
16925 implement it unconditionally. If you are running Exim on a gateway host, and
16926 routing mail through to internal MTAs without processing the local parts, it is
16927 a good idea to reject recipient addresses with percent characters in their
16928 local parts. Exim's default configuration does this.
16929
16930
16931 .option perl_at_start main boolean false
16932 .cindex "Perl"
16933 This option is available only when Exim is built with an embedded Perl
16934 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16935
16936
16937 .option perl_startup main string unset
16938 .cindex "Perl"
16939 This option is available only when Exim is built with an embedded Perl
16940 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16941
16942 .option perl_taintmode main boolean false
16943 .cindex "Perl"
16944 This option enables the taint mode of the embedded Perl interpreter.
16945
16946
16947 .option pgsql_servers main "string list" unset
16948 .cindex "PostgreSQL lookup type" "server list"
16949 This option provides a list of PostgreSQL servers and associated connection
16950 data, to be used in conjunction with &(pgsql)& lookups (see section
16951 &<<SECID72>>&). The option is available only if Exim has been built with
16952 PostgreSQL support.
16953
16954
16955 .option pid_file_path main string&!! "set at compile time"
16956 .cindex "daemon" "pid file path"
16957 .cindex "pid file, path for"
16958 This option sets the name of the file to which the Exim daemon writes its
16959 process id. The string is expanded, so it can contain, for example, references
16960 to the host name:
16961 .code
16962 pid_file_path = /var/log/$primary_hostname/exim.pid
16963 .endd
16964 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16965 spool directory.
16966 The value set by the option can be overridden by the &%-oP%& command line
16967 option. A pid file is not written if a &"non-standard"& daemon is run by means
16968 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16969
16970
16971 .option pipelining_advertise_hosts main "host list&!!" *
16972 .cindex "PIPELINING" "suppressing advertising"
16973 .cindex "ESMTP extensions" PIPELINING
16974 This option can be used to suppress the advertisement of the SMTP
16975 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16976 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16977 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16978 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16979 that clients will use it; &"out of order"& commands that are &"expected"& do
16980 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16981
16982 .option pipelining_connect_advertise_hosts main "host list&!!" *
16983 .cindex "pipelining" "early connection"
16984 .cindex "pipelining" PIPECONNECT
16985 .cindex "ESMTP extensions" PIPECONNECT
16986 If Exim is built without the DISABLE_PIPE_CONNECT build option
16987 this option controls which hosts the facility is advertised to
16988 and from which pipeline early-connection (before MAIL) SMTP
16989 commands are acceptable.
16990 When used, the pipelining saves on roundtrip times.
16991
16992 See also the &%hosts_pipe_connect%& smtp transport option.
16993
16994 The SMTP service extension keyword advertised is &"PIPECONNECT"&;
16995 it permits the client to pipeline
16996 TCP connection and hello command (inclear phase),
16997 or TLS-establishment and hello command (encrypted phase),
16998 on later connections to the same host.
16999
17000
17001 .option prdr_enable main boolean false
17002 .cindex "PRDR" "enabling on server"
17003 .cindex "ESMTP extensions" PRDR
17004 This option can be used to enable the Per-Recipient Data Response extension
17005 to SMTP, defined by Eric Hall.
17006 If the option is set, PRDR is advertised by Exim when operating as a server.
17007 If the client requests PRDR, and more than one recipient, for a message
17008 an additional ACL is called for each recipient after the message content
17009 is received.  See section &<<SECTPRDRACL>>&.
17010
17011 .option preserve_message_logs main boolean false
17012 .cindex "message logs" "preserving"
17013 If this option is set, message log files are not deleted when messages are
17014 completed. Instead, they are moved to a sub-directory of the spool directory
17015 called &_msglog.OLD_&, where they remain available for statistical or debugging
17016 purposes. This is a dangerous option to set on systems with any appreciable
17017 volume of mail. Use with care!
17018
17019
17020 .option primary_hostname main string "see below"
17021 .cindex "name" "of local host"
17022 .cindex "host" "name of local"
17023 .cindex "local host" "name of"
17024 .vindex "&$primary_hostname$&"
17025 This specifies the name of the current host. It is used in the default EHLO or
17026 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17027 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17028 The value is also used by default in some SMTP response messages from an Exim
17029 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17030
17031 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17032 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17033 contains only one component, Exim passes it to &[gethostbyname()]& (or
17034 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17035 version. The variable &$primary_hostname$& contains the host name, whether set
17036 explicitly by this option, or defaulted.
17037
17038
17039 .option print_topbitchars main boolean false
17040 .cindex "printing characters"
17041 .cindex "8-bit characters"
17042 By default, Exim considers only those characters whose codes lie in the range
17043 32&--126 to be printing characters. In a number of circumstances (for example,
17044 when writing log entries) non-printing characters are converted into escape
17045 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17046 is set, code values of 128 and above are also considered to be printing
17047 characters.
17048
17049 This option also affects the header syntax checks performed by the
17050 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17051 the user's full name when constructing From: and Sender: addresses (as
17052 described in section &<<SECTconstr>>&). Setting this option can cause
17053 Exim to generate eight bit message headers that do not conform to the
17054 standards.
17055
17056
17057 .option process_log_path main string unset
17058 .cindex "process log path"
17059 .cindex "log" "process log"
17060 .cindex "&'exiwhat'&"
17061 This option sets the name of the file to which an Exim process writes its
17062 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17063 utility script. If this option is unset, the file called &_exim-process.info_&
17064 in Exim's spool directory is used. The ability to specify the name explicitly
17065 can be useful in environments where two different Exims are running, using
17066 different spool directories.
17067
17068
17069 .option prod_requires_admin main boolean true
17070 .cindex "restricting access to features"
17071 .oindex "&%-M%&"
17072 .oindex "&%-R%&"
17073 .oindex "&%-q%&"
17074 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17075 admin user unless &%prod_requires_admin%& is set false. See also
17076 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17077
17078
17079 .option proxy_protocol_timeout main time 3s
17080 .cindex proxy "proxy protocol"
17081 This option sets the timeout for proxy protocol negotiation.
17082 For details see section &<<SECTproxyInbound>>&.
17083
17084
17085 .option qualify_domain main string "see below"
17086 .cindex "domain" "for qualifying addresses"
17087 .cindex "address" "qualification"
17088 This option specifies the domain name that is added to any envelope sender
17089 addresses that do not have a domain qualification. It also applies to
17090 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17091 are accepted by default only for locally-generated messages. Qualification is
17092 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17093 locally-generated messages, unless the &%-bnq%& command line option is used.
17094
17095 Messages from external sources must always contain fully qualified addresses,
17096 unless the sending host matches &%sender_unqualified_hosts%& or
17097 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17098 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17099 necessary. Internally, Exim always works with fully qualified envelope
17100 addresses. If &%qualify_domain%& is not set, it defaults to the
17101 &%primary_hostname%& value.
17102
17103
17104 .option qualify_recipient main string "see below"
17105 This option allows you to specify a different domain for qualifying recipient
17106 addresses to the one that is used for senders. See &%qualify_domain%& above.
17107
17108
17109
17110 .option queue_domains main "domain list&!!" unset
17111 .cindex "domain" "specifying non-immediate delivery"
17112 .cindex "queueing incoming messages"
17113 .cindex "message" "queueing certain domains"
17114 This option lists domains for which immediate delivery is not required.
17115 A delivery process is started whenever a message is received, but only those
17116 domains that do not match are processed. All other deliveries wait until the
17117 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17118
17119
17120 .option queue_fast_ramp main boolean true
17121 .cindex "queue runner" "two phase"
17122 .cindex "queue" "double scanning"
17123 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17124 command line, may start parallel delivery processes during their first
17125 phase.  This will be done when a threshold number of messages have been
17126 routed for a single host.
17127
17128
17129 .option queue_list_requires_admin main boolean true
17130 .cindex "restricting access to features"
17131 .oindex "&%-bp%&"
17132 The &%-bp%& command-line option, which lists the messages that are on the
17133 queue, requires the caller to be an admin user unless
17134 &%queue_list_requires_admin%& is set false.
17135 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17136
17137
17138 .option queue_only main boolean false
17139 .cindex "queueing incoming messages"
17140 .cindex "message" "queueing unconditionally"
17141 If &%queue_only%& is set, a delivery process is not automatically started
17142 whenever a message is received. Instead, the message waits in the queue for the
17143 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17144 delivered immediately when certain conditions (such as heavy load) occur.
17145
17146 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17147 and &%-odi%& command line options override &%queue_only%& unless
17148 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17149 &%queue_only_load%&, and &%smtp_accept_queue%&.
17150
17151
17152 .option queue_only_file main string unset
17153 .cindex "queueing incoming messages"
17154 .cindex "message" "queueing by file existence"
17155 This option can be set to a colon-separated list of absolute path names, each
17156 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17157 it tests for the existence of each listed path using a call to &[stat()]&. For
17158 each path that exists, the corresponding queueing option is set.
17159 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17160 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17161 .code
17162 queue_only_file = smtp/some/file
17163 .endd
17164 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17165 &_/some/file_& exists.
17166
17167
17168 .option queue_only_load main fixed-point unset
17169 .cindex "load average"
17170 .cindex "queueing incoming messages"
17171 .cindex "message" "queueing by load"
17172 If the system load average is higher than this value, incoming messages from
17173 all sources are queued, and no automatic deliveries are started. If this
17174 happens during local or remote SMTP input, all subsequent messages received on
17175 the same SMTP connection are queued by default, whatever happens to the load in
17176 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17177 false.
17178
17179 Deliveries will subsequently be performed by queue runner processes. This
17180 option has no effect on ancient operating systems on which Exim cannot
17181 determine the load average. See also &%deliver_queue_load_max%& and
17182 &%smtp_load_reserve%&.
17183
17184
17185 .option queue_only_load_latch main boolean true
17186 .cindex "load average" "re-evaluating per message"
17187 When this option is true (the default), once one message has been queued
17188 because the load average is higher than the value set by &%queue_only_load%&,
17189 all subsequent messages received on the same SMTP connection are also queued.
17190 This is a deliberate choice; even though the load average may fall below the
17191 threshold, it doesn't seem right to deliver later messages on the same
17192 connection when not delivering earlier ones. However, there are special
17193 circumstances such as very long-lived connections from scanning appliances
17194 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17195 should be set false. This causes the value of the load average to be
17196 re-evaluated for each message.
17197
17198
17199 .option queue_only_override main boolean true
17200 .cindex "queueing incoming messages"
17201 When this option is true, the &%-od%&&'x'& command line options override the
17202 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17203 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17204 to override; they are accepted, but ignored.
17205
17206
17207 .option queue_run_in_order main boolean false
17208 .cindex "queue runner" "processing messages in order"
17209 If this option is set, queue runs happen in order of message arrival instead of
17210 in an arbitrary order. For this to happen, a complete list of the entire queue
17211 must be set up before the deliveries start. When the queue is all held in a
17212 single directory (the default), a single list is created for both the ordered
17213 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17214 single list is not created when &%queue_run_in_order%& is false. In this case,
17215 the sub-directories are processed one at a time (in a random order), and this
17216 avoids setting up one huge list for the whole queue. Thus, setting
17217 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17218 when the queue is large, because of the extra work in setting up the single,
17219 large list. In most situations, &%queue_run_in_order%& should not be set.
17220
17221
17222
17223 .option queue_run_max main integer&!! 5
17224 .cindex "queue runner" "maximum number of"
17225 This controls the maximum number of queue runner processes that an Exim daemon
17226 can run simultaneously. This does not mean that it starts them all at once,
17227 but rather that if the maximum number are still running when the time comes to
17228 start another one, it refrains from starting another one. This can happen with
17229 very large queues and/or very sluggish deliveries. This option does not,
17230 however, interlock with other processes, so additional queue runners can be
17231 started by other means, or by killing and restarting the daemon.
17232
17233 Setting this option to zero does not suppress queue runs; rather, it disables
17234 the limit, allowing any number of simultaneous queue runner processes to be
17235 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17236 the daemon's command line.
17237
17238 .cindex queues named
17239 .cindex "named queues" "resource limit"
17240 To set limits for different named queues use
17241 an expansion depending on the &$queue_name$& variable.
17242
17243 .option queue_smtp_domains main "domain list&!!" unset
17244 .cindex "queueing incoming messages"
17245 .cindex "message" "queueing remote deliveries"
17246 .cindex "first pass routing"
17247 When this option is set, a delivery process is started whenever a message is
17248 received, routing is performed, and local deliveries take place.
17249 However, if any SMTP deliveries are required for domains that match
17250 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17251 message waits in the queue for the next queue run. Since routing of the message
17252 has taken place, Exim knows to which remote hosts it must be delivered, and so
17253 when the queue run happens, multiple messages for the same host are delivered
17254 over a single SMTP connection. The &%-odqs%& command line option causes all
17255 SMTP deliveries to be queued in this way, and is equivalent to setting
17256 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17257 &%queue_domains%&.
17258
17259
17260 .option receive_timeout main time 0s
17261 .cindex "timeout" "for non-SMTP input"
17262 This option sets the timeout for accepting a non-SMTP message, that is, the
17263 maximum time that Exim waits when reading a message on the standard input. If
17264 the value is zero, it will wait forever. This setting is overridden by the
17265 &%-or%& command line option. The timeout for incoming SMTP messages is
17266 controlled by &%smtp_receive_timeout%&.
17267
17268 .option received_header_text main string&!! "see below"
17269 .cindex "customizing" "&'Received:'& header"
17270 .cindex "&'Received:'& header line" "customizing"
17271 This string defines the contents of the &'Received:'& message header that is
17272 added to each message, except for the timestamp, which is automatically added
17273 on at the end (preceded by a semicolon). The string is expanded each time it is
17274 used. If the expansion yields an empty string, no &'Received:'& header line is
17275 added to the message. Otherwise, the string should start with the text
17276 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17277 header lines.
17278 The default setting is:
17279
17280 .code
17281 received_header_text = Received: \
17282   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17283     {${if def:sender_ident \
17284       {from ${quote_local_part:$sender_ident} }}\
17285         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17286   by $primary_hostname \
17287   ${if def:received_protocol {with $received_protocol }}\
17288   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17289   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17290   (Exim $version_number)\n\t\
17291   ${if def:sender_address \
17292   {(envelope-from <$sender_address>)\n\t}}\
17293   id $message_exim_id\
17294   ${if def:received_for {\n\tfor $received_for}}
17295 .endd
17296
17297 The references to the TLS version and cipher are
17298 omitted when Exim is built without TLS
17299 support. The use of conditional expansions ensures that this works for both
17300 locally generated messages and messages received from remote hosts, giving
17301 header lines such as the following:
17302 .code
17303 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17304 by marley.carol.example with esmtp (Exim 4.00)
17305 (envelope-from <bob@carol.example>)
17306 id 16IOWa-00019l-00
17307 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17308 Received: by scrooge.carol.example with local (Exim 4.00)
17309 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17310 .endd
17311 Until the body of the message has been received, the timestamp is the time when
17312 the message started to be received. Once the body has arrived, and all policy
17313 checks have taken place, the timestamp is updated to the time at which the
17314 message was accepted.
17315
17316
17317 .option received_headers_max main integer 30
17318 .cindex "loop" "prevention"
17319 .cindex "mail loop prevention"
17320 .cindex "&'Received:'& header line" "counting"
17321 When a message is to be delivered, the number of &'Received:'& headers is
17322 counted, and if it is greater than this parameter, a mail loop is assumed to
17323 have occurred, the delivery is abandoned, and an error message is generated.
17324 This applies to both local and remote deliveries.
17325
17326
17327 .option recipient_unqualified_hosts main "host list&!!" unset
17328 .cindex "unqualified addresses"
17329 .cindex "host" "unqualified addresses from"
17330 This option lists those hosts from which Exim is prepared to accept unqualified
17331 recipient addresses in message envelopes. The addresses are made fully
17332 qualified by the addition of the &%qualify_recipient%& value. This option also
17333 affects message header lines. Exim does not reject unqualified recipient
17334 addresses in headers, but it qualifies them only if the message came from a
17335 host that matches &%recipient_unqualified_hosts%&,
17336 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17337 option was not set.
17338
17339
17340 .option recipients_max main integer 50000
17341 .cindex "limit" "number of recipients"
17342 .cindex "recipient" "maximum number"
17343 If this option is set greater than zero, it specifies the maximum number of
17344 original recipients for any message. Additional recipients that are generated
17345 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17346 all recipients over the limit; earlier recipients are delivered as normal.
17347 Non-SMTP messages with too many recipients are failed, and no deliveries are
17348 done.
17349
17350 .cindex "RCPT" "maximum number of incoming"
17351 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17352 RCPT commands in a single message.
17353
17354
17355 .option recipients_max_reject main boolean false
17356 If this option is set true, Exim rejects SMTP messages containing too many
17357 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17358 error to the eventual DATA command. Otherwise (the default) it gives a 452
17359 error to the surplus RCPT commands and accepts the message on behalf of the
17360 initial set of recipients. The remote server should then re-send the message
17361 for the remaining recipients at a later time.
17362
17363
17364 .option remote_max_parallel main integer 4
17365 .cindex "delivery" "parallelism for remote"
17366 This option controls parallel delivery of one message to a number of remote
17367 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17368 does all the remote deliveries for a message one by one. Otherwise, if a single
17369 message has to be delivered to more than one remote host, or if several copies
17370 have to be sent to the same remote host, up to &%remote_max_parallel%&
17371 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17372 deliveries are required, the maximum number of processes are started, and as
17373 each one finishes, another is begun. The order of starting processes is the
17374 same as if sequential delivery were being done, and can be controlled by the
17375 &%remote_sort_domains%& option. If parallel delivery takes place while running
17376 with debugging turned on, the debugging output from each delivery process is
17377 tagged with its process id.
17378
17379 This option controls only the maximum number of parallel deliveries for one
17380 message in one Exim delivery process. Because Exim has no central queue
17381 manager, there is no way of controlling the total number of simultaneous
17382 deliveries if the configuration allows a delivery attempt as soon as a message
17383 is received.
17384
17385 See also the &%max_parallel%& generic transport option,
17386 and the &%serialize_hosts%& smtp transport option.
17387
17388 .cindex "number of deliveries"
17389 .cindex "delivery" "maximum number of"
17390 If you want to control the total number of deliveries on the system, you
17391 need to set the &%queue_only%& option. This ensures that all incoming messages
17392 are added to the queue without starting a delivery process. Then set up an Exim
17393 daemon to start queue runner processes at appropriate intervals (probably
17394 fairly often, for example, every minute), and limit the total number of queue
17395 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17396 delivers only one message at a time, the maximum number of deliveries that can
17397 then take place at once is &%queue_run_max%& multiplied by
17398 &%remote_max_parallel%&.
17399
17400 If it is purely remote deliveries you want to control, use
17401 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17402 doing the SMTP routing before queueing, so that several messages for the same
17403 host will eventually get delivered down the same connection.
17404
17405
17406 .option remote_sort_domains main "domain list&!!" unset
17407 .cindex "sorting remote deliveries"
17408 .cindex "delivery" "sorting remote"
17409 When there are a number of remote deliveries for a message, they are sorted by
17410 domain into the order given by this list. For example,
17411 .code
17412 remote_sort_domains = *.cam.ac.uk:*.uk
17413 .endd
17414 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17415 then to those in the &%uk%& domain, then to any others.
17416
17417
17418 .option retry_data_expire main time 7d
17419 .cindex "hints database" "data expiry"
17420 This option sets a &"use before"& time on retry information in Exim's hints
17421 database. Any older retry data is ignored. This means that, for example, once a
17422 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17423 past failures.
17424
17425
17426 .option retry_interval_max main time 24h
17427 .cindex "retry" "limit on interval"
17428 .cindex "limit" "on retry interval"
17429 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17430 intervals between delivery attempts for messages that cannot be delivered
17431 straight away. This option sets an overall limit to the length of time between
17432 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17433 the default value.
17434
17435
17436 .option return_path_remove main boolean true
17437 .cindex "&'Return-path:'& header line" "removing"
17438 RFC 2821, section 4.4, states that an SMTP server must insert a
17439 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17440 The &'Return-path:'& header preserves the sender address as received in the
17441 MAIL command. This description implies that this header should not be present
17442 in an incoming message. If &%return_path_remove%& is true, any existing
17443 &'Return-path:'& headers are removed from messages at the time they are
17444 received. Exim's transports have options for adding &'Return-path:'& headers at
17445 the time of delivery. They are normally used only for final local deliveries.
17446
17447
17448 .option return_size_limit main integer 100K
17449 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17450
17451
17452 .option rfc1413_hosts main "host list&!!" @[]
17453 .cindex "RFC 1413"
17454 .cindex "host" "for RFC 1413 calls"
17455 RFC 1413 identification calls are made to any client host which matches
17456 an item in the list.
17457 The default value specifies just this host, being any local interface
17458 for the system.
17459
17460 .option rfc1413_query_timeout main time 0s
17461 .cindex "RFC 1413" "query timeout"
17462 .cindex "timeout" "for RFC 1413 call"
17463 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17464 no RFC 1413 calls are ever made.
17465
17466
17467 .option sender_unqualified_hosts main "host list&!!" unset
17468 .cindex "unqualified addresses"
17469 .cindex "host" "unqualified addresses from"
17470 This option lists those hosts from which Exim is prepared to accept unqualified
17471 sender addresses. The addresses are made fully qualified by the addition of
17472 &%qualify_domain%&. This option also affects message header lines. Exim does
17473 not reject unqualified addresses in headers that contain sender addresses, but
17474 it qualifies them only if the message came from a host that matches
17475 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17476 using TCP/IP), and the &%-bnq%& option was not set.
17477
17478
17479 .option slow_lookup_log main integer 0
17480 .cindex "logging" "slow lookups"
17481 .cindex "dns" "logging slow lookups"
17482 This option controls logging of slow lookups.
17483 If the value is nonzero it is taken as a number of milliseconds
17484 and lookups taking longer than this are logged.
17485 Currently this applies only to DNS lookups.
17486
17487
17488
17489 .option smtp_accept_keepalive main boolean true
17490 .cindex "keepalive" "on incoming connection"
17491 This option controls the setting of the SO_KEEPALIVE option on incoming
17492 TCP/IP socket connections. When set, it causes the kernel to probe idle
17493 connections periodically, by sending packets with &"old"& sequence numbers. The
17494 other end of the connection should send an acknowledgment if the connection is
17495 still okay or a reset if the connection has been aborted. The reason for doing
17496 this is that it has the beneficial effect of freeing up certain types of
17497 connection that can get stuck when the remote host is disconnected without
17498 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17499 hours to detect unreachable hosts.
17500
17501
17502
17503 .option smtp_accept_max main integer 20
17504 .cindex "limit" "incoming SMTP connections"
17505 .cindex "SMTP" "incoming connection count"
17506 .cindex "inetd"
17507 This option specifies the maximum number of simultaneous incoming SMTP calls
17508 that Exim will accept. It applies only to the listening daemon; there is no
17509 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17510 value is set to zero, no limit is applied. However, it is required to be
17511 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17512 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17513
17514 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17515 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17516 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17517 and &%smtp_load_reserve%& are then checked before accepting the connection.
17518
17519
17520 .option smtp_accept_max_nonmail main integer 10
17521 .cindex "limit" "non-mail SMTP commands"
17522 .cindex "SMTP" "limiting non-mail commands"
17523 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17524 the connection if there are too many. This option defines &"too many"&. The
17525 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17526 client looping sending EHLO, for example. The check is applied only if the
17527 client host matches &%smtp_accept_max_nonmail_hosts%&.
17528
17529 When a new message is expected, one occurrence of RSET is not counted. This
17530 allows a client to send one RSET between messages (this is not necessary,
17531 but some clients do it). Exim also allows one uncounted occurrence of HELO
17532 or EHLO, and one occurrence of STARTTLS between messages. After
17533 starting up a TLS session, another EHLO is expected, and so it too is not
17534 counted. The first occurrence of AUTH in a connection, or immediately
17535 following STARTTLS is not counted. Otherwise, all commands other than
17536 MAIL, RCPT, DATA, and QUIT are counted.
17537
17538
17539 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17540 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17541 check by setting this option. The default value makes it apply to all hosts. By
17542 changing the value, you can exclude any badly-behaved hosts that you have to
17543 live with.
17544
17545
17546 . Allow this long option name to split; give it unsplit as a fifth argument
17547 . for the automatic .oindex that is generated by .option.
17548 . We insert " &~&~" which is both pretty nasty visually and results in
17549 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17550 . zero-width-space, which would be nicer visually and results in (at least)
17551 . html that Firefox will split on when it's forced to reflow (rather than
17552 . inserting a horizontal scrollbar).  However, the text is still not
17553 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17554 . the option name to split.
17555
17556 .option "smtp_accept_max_per_connection" main integer&!! 1000 &&&
17557          smtp_accept_max_per_connection
17558 .cindex "SMTP" "limiting incoming message count"
17559 .cindex "limit" "messages per SMTP connection"
17560 The value of this option limits the number of MAIL commands that Exim is
17561 prepared to accept over a single SMTP connection, whether or not each command
17562 results in the transfer of a message. After the limit is reached, a 421
17563 response is given to subsequent MAIL commands. This limit is a safety
17564 precaution against a client that goes mad (incidents of this type have been
17565 seen).
17566 The option is expanded after the HELO or EHLO is received
17567 and may depend on values available at that time.
17568 An empty or zero value after expansion removes the limit.
17569
17570
17571 .option smtp_accept_max_per_host main string&!! unset
17572 .cindex "limit" "SMTP connections from one host"
17573 .cindex "host" "limiting SMTP connections from"
17574 This option restricts the number of simultaneous IP connections from a single
17575 host (strictly, from a single IP address) to the Exim daemon. The option is
17576 expanded, to enable different limits to be applied to different hosts by
17577 reference to &$sender_host_address$&. Once the limit is reached, additional
17578 connection attempts from the same host are rejected with error code 421. This
17579 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17580 of zero imposes no limit. If this option is set greater than zero, it is
17581 required that &%smtp_accept_max%& be non-zero.
17582
17583 &*Warning*&: When setting this option you should not use any expansion
17584 constructions that take an appreciable amount of time. The expansion and test
17585 happen in the main daemon loop, in order to reject additional connections
17586 without forking additional processes (otherwise a denial-of-service attack
17587 could cause a vast number or processes to be created). While the daemon is
17588 doing this processing, it cannot accept any other incoming connections.
17589
17590
17591
17592 .option smtp_accept_queue main integer 0
17593 .cindex "SMTP" "incoming connection count"
17594 .cindex "queueing incoming messages"
17595 .cindex "message" "queueing by SMTP connection count"
17596 If the number of simultaneous incoming SMTP connections being handled via the
17597 listening daemon exceeds this value, messages received by SMTP are just placed
17598 in the queue; no delivery processes are started automatically. The count is
17599 fixed at the start of an SMTP connection. It cannot be updated in the
17600 subprocess that receives messages, and so the queueing or not queueing applies
17601 to all messages received in the same connection.
17602
17603 A value of zero implies no limit, and clearly any non-zero value is useful only
17604 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17605 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17606 various &%-od%&&'x'& command line options.
17607
17608
17609 . See the comment on smtp_accept_max_per_connection
17610
17611 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17612          smtp_accept_queue_per_connection
17613 .cindex "queueing incoming messages"
17614 .cindex "message" "queueing by message count"
17615 This option limits the number of delivery processes that Exim starts
17616 automatically when receiving messages via SMTP, whether via the daemon or by
17617 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17618 and the number of messages received in a single SMTP session exceeds this
17619 number, subsequent messages are placed in the queue, but no delivery processes
17620 are started. This helps to limit the number of Exim processes when a server
17621 restarts after downtime and there is a lot of mail waiting for it on other
17622 systems. On large systems, the default should probably be increased, and on
17623 dial-in client systems it should probably be set to zero (that is, disabled).
17624
17625
17626 .option smtp_accept_reserve main integer 0
17627 .cindex "SMTP" "incoming call count"
17628 .cindex "host" "reserved"
17629 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17630 number of SMTP connections that are reserved for connections from the hosts
17631 that are specified in &%smtp_reserve_hosts%&. The value set in
17632 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17633 restricted to this number of connections; the option specifies a minimum number
17634 of connection slots for them, not a maximum. It is a guarantee that this group
17635 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17636 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17637 individual host.
17638
17639 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17640 set to 5, once there are 45 active connections (from any hosts), new
17641 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17642 provided the other criteria for acceptance are met.
17643
17644
17645 .option smtp_active_hostname main string&!! unset
17646 .cindex "host" "name in SMTP responses"
17647 .cindex "SMTP" "host name in responses"
17648 .vindex "&$primary_hostname$&"
17649 This option is provided for multi-homed servers that want to masquerade as
17650 several different hosts. At the start of an incoming SMTP connection, its value
17651 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17652 responses. For example, it is used as domain name in the response to an
17653 incoming HELO or EHLO command.
17654
17655 .vindex "&$smtp_active_hostname$&"
17656 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17657 is saved with any messages that are received. It is therefore available for use
17658 in routers and transports when the message is later delivered.
17659
17660 If this option is unset, or if its expansion is forced to fail, or if the
17661 expansion results in an empty string, the value of &$primary_hostname$& is
17662 used. Other expansion failures cause a message to be written to the main and
17663 panic logs, and the SMTP command receives a temporary error. Typically, the
17664 value of &%smtp_active_hostname%& depends on the incoming interface address.
17665 For example:
17666 .code
17667 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17668   {cox.mydomain}{box.mydomain}}
17669 .endd
17670
17671 Although &$smtp_active_hostname$& is primarily concerned with incoming
17672 messages, it is also used as the default for HELO commands in callout
17673 verification if there is no remote transport from which to obtain a
17674 &%helo_data%& value.
17675
17676 .option smtp_backlog_monitor main integer 0
17677 .cindex "connection backlog" monitoring
17678 If this option is set to greater than zero, and the backlog of available
17679 TCP connections on a socket listening for SMTP is larger than it, a line
17680 is logged giving the value and the socket address and port.
17681 The value is retrived jsut before an accept call.
17682 This facility is only available on Linux.
17683
17684 .option smtp_banner main string&!! "see below"
17685 .cindex "SMTP" "welcome banner"
17686 .cindex "banner for SMTP"
17687 .cindex "welcome banner for SMTP"
17688 .cindex "customizing" "SMTP banner"
17689 This string, which is expanded every time it is used, is output as the initial
17690 positive response to an SMTP connection. The default setting is:
17691 .code
17692 smtp_banner = $smtp_active_hostname ESMTP Exim \
17693   $version_number $tod_full
17694 .endd
17695 Failure to expand the string causes a panic error. If you want to create a
17696 multiline response to the initial SMTP connection, use &"\n"& in the string at
17697 appropriate points, but not at the end. Note that the 220 code is not included
17698 in this string. Exim adds it automatically (several times in the case of a
17699 multiline response).
17700
17701
17702 .option smtp_check_spool_space main boolean true
17703 .cindex "checking disk space"
17704 .cindex "disk space, checking"
17705 .cindex "spool directory" "checking space"
17706 When this option is set, if an incoming SMTP session encounters the SIZE
17707 option on a MAIL command, it checks that there is enough space in the
17708 spool directory's partition to accept a message of that size, while still
17709 leaving free the amount specified by &%check_spool_space%& (even if that value
17710 is zero). If there isn't enough space, a temporary error code is returned.
17711
17712
17713 .option smtp_connect_backlog main integer 20
17714 .cindex "connection backlog" "set maximum"
17715 .cindex "SMTP" "connection backlog"
17716 .cindex "backlog of connections"
17717 This option specifies a maximum number of waiting SMTP connections. Exim passes
17718 this value to the TCP/IP system when it sets up its listener. Once this number
17719 of connections are waiting for the daemon's attention, subsequent connection
17720 attempts are refused at the TCP/IP level. At least, that is what the manuals
17721 say; in some circumstances such connection attempts have been observed to time
17722 out instead. For large systems it is probably a good idea to increase the
17723 value (to 50, say). It also gives some protection against denial-of-service
17724 attacks by SYN flooding.
17725
17726
17727 .option smtp_enforce_sync main boolean true
17728 .cindex "SMTP" "synchronization checking"
17729 .cindex "synchronization checking in SMTP"
17730 The SMTP protocol specification requires the client to wait for a response from
17731 the server at certain points in the dialogue. Without PIPELINING these
17732 synchronization points are after every command; with PIPELINING they are
17733 fewer, but they still exist.
17734
17735 Some spamming sites send out a complete set of SMTP commands without waiting
17736 for any response. Exim protects against this by rejecting a message if the
17737 client has sent further input when it should not have. The error response &"554
17738 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17739 for this error cannot be perfect because of transmission delays (unexpected
17740 input may be on its way but not yet received when Exim checks). However, it
17741 does detect many instances.
17742
17743 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17744 If you want to disable the check selectively (for example, only for certain
17745 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17746 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17747
17748
17749
17750 .option smtp_etrn_command main string&!! unset
17751 .cindex "ETRN" "command to be run"
17752 .cindex "ESMTP extensions" ETRN
17753 .vindex "&$domain$&"
17754 If this option is set, the given command is run whenever an SMTP ETRN
17755 command is received from a host that is permitted to issue such commands (see
17756 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17757 are independently expanded. The expansion variable &$domain$& is set to the
17758 argument of the ETRN command, and no syntax checking is done on it. For
17759 example:
17760 .code
17761 smtp_etrn_command = /etc/etrn_command $domain \
17762                     $sender_host_address
17763 .endd
17764 If the option is not set, the argument for the ETRN command must
17765 be a &'#'& followed by an address string.
17766 In this case an &'exim -R <string>'& command is used;
17767 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17768
17769 A new process is created to run the command, but Exim does not wait for it to
17770 complete. Consequently, its status cannot be checked. If the command cannot be
17771 run, a line is written to the panic log, but the ETRN caller still receives
17772 a 250 success response. Exim is normally running under its own uid when
17773 receiving SMTP, so it is not possible for it to change the uid before running
17774 the command.
17775
17776
17777 .option smtp_etrn_serialize main boolean true
17778 .cindex "ETRN" "serializing"
17779 When this option is set, it prevents the simultaneous execution of more than
17780 one identical command as a result of ETRN in an SMTP connection. See
17781 section &<<SECTETRN>>& for details.
17782
17783
17784 .option smtp_load_reserve main fixed-point unset
17785 .cindex "load average"
17786 If the system load average ever gets higher than this, incoming SMTP calls are
17787 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17788 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17789 the load is over the limit. The option has no effect on ancient operating
17790 systems on which Exim cannot determine the load average. See also
17791 &%deliver_queue_load_max%& and &%queue_only_load%&.
17792
17793
17794
17795 .option smtp_max_synprot_errors main integer 3
17796 .cindex "SMTP" "limiting syntax and protocol errors"
17797 .cindex "limit" "SMTP syntax and protocol errors"
17798 Exim rejects SMTP commands that contain syntax or protocol errors. In
17799 particular, a syntactically invalid email address, as in this command:
17800 .code
17801 RCPT TO:<abc xyz@a.b.c>
17802 .endd
17803 causes immediate rejection of the command, before any other tests are done.
17804 (The ACL cannot be run if there is no valid address to set up for it.) An
17805 example of a protocol error is receiving RCPT before MAIL. If there are
17806 too many syntax or protocol errors in one SMTP session, the connection is
17807 dropped. The limit is set by this option.
17808
17809 .cindex "PIPELINING" "expected errors"
17810 When the PIPELINING extension to SMTP is in use, some protocol errors are
17811 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17812 Exim assumes that PIPELINING will be used if it advertises it (see
17813 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17814 not count towards the limit.
17815
17816
17817
17818 .option smtp_max_unknown_commands main integer 3
17819 .cindex "SMTP" "limiting unknown commands"
17820 .cindex "limit" "unknown SMTP commands"
17821 If there are too many unrecognized commands in an incoming SMTP session, an
17822 Exim server drops the connection. This is a defence against some kinds of abuse
17823 that subvert web
17824 clients
17825 into making connections to SMTP ports; in these circumstances, a number of
17826 non-SMTP command lines are sent first.
17827
17828
17829
17830 .option smtp_ratelimit_hosts main "host list&!!" unset
17831 .cindex "SMTP" "rate limiting"
17832 .cindex "limit" "rate of message arrival"
17833 .cindex "RCPT" "rate limiting"
17834 Some sites find it helpful to be able to limit the rate at which certain hosts
17835 can send them messages, and the rate at which an individual message can specify
17836 recipients.
17837
17838 Exim has two rate-limiting facilities. This section describes the older
17839 facility, which can limit rates within a single connection. The newer
17840 &%ratelimit%& ACL condition can limit rates across all connections. See section
17841 &<<SECTratelimiting>>& for details of the newer facility.
17842
17843 When a host matches &%smtp_ratelimit_hosts%&, the values of
17844 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17845 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17846 respectively. Each option, if set, must contain a set of four comma-separated
17847 values:
17848
17849 .ilist
17850 A threshold, before which there is no rate limiting.
17851 .next
17852 An initial time delay. Unlike other times in Exim, numbers with decimal
17853 fractional parts are allowed here.
17854 .next
17855 A factor by which to increase the delay each time.
17856 .next
17857 A maximum value for the delay. This should normally be less than 5 minutes,
17858 because after that time, the client is liable to timeout the SMTP command.
17859 .endlist
17860
17861 For example, these settings have been used successfully at the site which
17862 first suggested this feature, for controlling mail from their customers:
17863 .code
17864 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17865 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17866 .endd
17867 The first setting specifies delays that are applied to MAIL commands after
17868 two have been received over a single connection. The initial delay is 0.5
17869 seconds, increasing by a factor of 1.05 each time. The second setting applies
17870 delays to RCPT commands when more than four occur in a single message.
17871
17872
17873 .option smtp_ratelimit_mail main string unset
17874 See &%smtp_ratelimit_hosts%& above.
17875
17876
17877 .option smtp_ratelimit_rcpt main string unset
17878 See &%smtp_ratelimit_hosts%& above.
17879
17880
17881 .option smtp_receive_timeout main time&!! 5m
17882 .cindex "timeout" "for SMTP input"
17883 .cindex "SMTP" "input timeout"
17884 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17885 input, including batch SMTP. If a line of input (either an SMTP command or a
17886 data line) is not received within this time, the SMTP connection is dropped and
17887 the message is abandoned.
17888 A line is written to the log containing one of the following messages:
17889 .code
17890 SMTP command timeout on connection from...
17891 SMTP data timeout on connection from...
17892 .endd
17893 The former means that Exim was expecting to read an SMTP command; the latter
17894 means that it was in the DATA phase, reading the contents of a message.
17895
17896 If the first character of the option is a &"$"& the option is
17897 expanded before use and may depend on
17898 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17899
17900
17901 .oindex "&%-os%&"
17902 The value set by this option can be overridden by the
17903 &%-os%& command-line option. A setting of zero time disables the timeout, but
17904 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17905 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17906 timeout is controlled by &%receive_timeout%& and &%-or%&.
17907
17908
17909 .option smtp_reserve_hosts main "host list&!!" unset
17910 This option defines hosts for which SMTP connections are reserved; see
17911 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17912
17913
17914 .option smtp_return_error_details main boolean false
17915 .cindex "SMTP" "details policy failures"
17916 .cindex "policy control" "rejection, returning details"
17917 In the default state, Exim uses bland messages such as
17918 &"Administrative prohibition"& when it rejects SMTP commands for policy
17919 reasons. Many sysadmins like this because it gives away little information
17920 to spammers. However, some other sysadmins who are applying strict checking
17921 policies want to give out much fuller information about failures. Setting
17922 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17923 example, instead of &"Administrative prohibition"&, it might give:
17924 .code
17925 550-Rejected after DATA: '>' missing at end of address:
17926 550 failing address in "From" header is: <user@dom.ain
17927 .endd
17928
17929
17930 .option smtputf8_advertise_hosts main "host list&!!" *
17931 .cindex "SMTPUTF8" "ESMTP extension, advertising"
17932 .cindex "ESMTP extensions" SMTPUTF8
17933 When Exim is built with support for internationalised mail names,
17934 the availability thereof is advertised in
17935 response to EHLO only to those client hosts that match this option. See
17936 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17937
17938
17939 .option spamd_address main string "127.0.0.1 783"
17940 This option is available when Exim is compiled with the content-scanning
17941 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17942 See section &<<SECTscanspamass>>& for more details.
17943
17944
17945
17946 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17947 This option is available when Exim is compiled with SPF support.
17948 See section &<<SECSPF>>& for more details.
17949
17950 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
17951 This option is available when Exim is compiled with SPF support.  It
17952 allows the customisation of the SMTP comment that the SPF library
17953 generates.  You are strongly encouraged to link to your own explanative
17954 site. The template must not contain spaces. If you need spaces in the
17955 output, use the proper placeholder. If libspf2 can not parse the
17956 template, it uses a built-in default broken link. The following placeholders
17957 (along with Exim variables (but see below)) are allowed in the template:
17958 .ilist
17959 &*%_*&: A space.
17960 .next
17961 &*%{L}*&: Envelope sender's local part.
17962 .next
17963 &*%{S}*&: Envelope sender.
17964 .next
17965 &*%{O}*&: Envelope sender's domain.
17966 .next
17967 &*%{D}*&: Current(?) domain.
17968 .next
17969 &*%{I}*&: SMTP client Ip.
17970 .next
17971 &*%{C}*&: SMTP client pretty IP.
17972 .next
17973 &*%{T}*&: Epoch time (UTC).
17974 .next
17975 &*%{P}*&: SMTP client domain name.
17976 .next
17977 &*%{V}*&: IP version.
17978 .next
17979 &*%{H}*&: EHLO/HELO domain.
17980 .next
17981 &*%{R}*&: Receiving domain.
17982 .endlist
17983 The capitalized placeholders do proper URL encoding, if you use them
17984 lowercased, no encoding takes place.  This list was compiled from the
17985 libspf2 sources.
17986
17987 A note on using Exim variables: As
17988 currently the SPF library is initialized before the SMTP EHLO phase,
17989 the variables useful for expansion are quite limited.
17990
17991
17992 .option split_spool_directory main boolean false
17993 .cindex "multiple spool directories"
17994 .cindex "spool directory" "split"
17995 .cindex "directories, multiple"
17996 If this option is set, it causes Exim to split its input directory into 62
17997 subdirectories, each with a single alphanumeric character as its name. The
17998 sixth character of the message id is used to allocate messages to
17999 subdirectories; this is the least significant base-62 digit of the time of
18000 arrival of the message.
18001
18002 Splitting up the spool in this way may provide better performance on systems
18003 where there are long mail queues, by reducing the number of files in any one
18004 directory. The msglog directory is also split up in a similar way to the input
18005 directory; however, if &%preserve_message_logs%& is set, all old msglog files
18006 are still placed in the single directory &_msglog.OLD_&.
18007
18008 It is not necessary to take any special action for existing messages when
18009 changing &%split_spool_directory%&. Exim notices messages that are in the
18010 &"wrong"& place, and continues to process them. If the option is turned off
18011 after a period of being on, the subdirectories will eventually empty and be
18012 automatically deleted.
18013
18014 When &%split_spool_directory%& is set, the behaviour of queue runner processes
18015 changes. Instead of creating a list of all messages in the queue, and then
18016 trying to deliver each one, in turn, it constructs a list of those in one
18017 sub-directory and tries to deliver them, before moving on to the next
18018 sub-directory. The sub-directories are processed in a random order. This
18019 spreads out the scanning of the input directories, and uses less memory. It is
18020 particularly beneficial when there are lots of messages in the queue. However,
18021 if &%queue_run_in_order%& is set, none of this new processing happens. The
18022 entire queue has to be scanned and sorted before any deliveries can start.
18023
18024
18025 .option spool_directory main string&!! "set at compile time"
18026 .cindex "spool directory" "path to"
18027 This defines the directory in which Exim keeps its spool, that is, the messages
18028 it is waiting to deliver. The default value is taken from the compile-time
18029 configuration setting, if there is one. If not, this option must be set. The
18030 string is expanded, so it can contain, for example, a reference to
18031 &$primary_hostname$&.
18032
18033 If the spool directory name is fixed on your installation, it is recommended
18034 that you set it at build time rather than from this option, particularly if the
18035 log files are being written to the spool directory (see &%log_file_path%&).
18036 Otherwise log files cannot be used for errors that are detected early on, such
18037 as failures in the configuration file.
18038
18039 By using this option to override the compiled-in path, it is possible to run
18040 tests of Exim without using the standard spool.
18041
18042 .option spool_wireformat main boolean false
18043 .cindex "spool directory" "file formats"
18044 If this option is set, Exim may for some messages use an alternative format
18045 for data-files in the spool which matches the wire format.
18046 Doing this permits more efficient message reception and transmission.
18047 Currently it is only done for messages received using the ESMTP CHUNKING
18048 option.
18049
18050 The following variables will not have useful values:
18051 .code
18052 $max_received_linelength
18053 $body_linecount
18054 $body_zerocount
18055 .endd
18056
18057 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18058 and any external programs which are passed a reference to a message data file
18059 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18060 will need to be aware of the different formats potentially available.
18061
18062 Using any of the ACL conditions noted will negate the reception benefit
18063 (as a Unix-mbox-format file is constructed for them).
18064 The transmission benefit is maintained.
18065
18066 .option sqlite_lock_timeout main time 5s
18067 .cindex "sqlite lookup type" "lock timeout"
18068 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18069 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18070
18071 .option strict_acl_vars main boolean false
18072 .cindex "&ACL;" "variables, handling unset"
18073 This option controls what happens if a syntactically valid but undefined ACL
18074 variable is referenced. If it is false (the default), an empty string
18075 is substituted; if it is true, an error is generated. See section
18076 &<<SECTaclvariables>>& for details of ACL variables.
18077
18078 .option strip_excess_angle_brackets main boolean false
18079 .cindex "angle brackets, excess"
18080 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18081 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18082 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18083 passed on to another MTA, the excess angle brackets are not passed on. If this
18084 option is not set, multiple pairs of angle brackets cause a syntax error.
18085
18086
18087 .option strip_trailing_dot main boolean false
18088 .cindex "trailing dot on domain"
18089 .cindex "dot" "trailing on domain"
18090 If this option is set, a trailing dot at the end of a domain in an address is
18091 ignored. If this is in the envelope and the message is passed on to another
18092 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18093 domain causes a syntax error.
18094 However, addresses in header lines are checked only when an ACL requests header
18095 syntax checking.
18096
18097
18098 .option syslog_duplication main boolean true
18099 .cindex "syslog" "duplicate log lines; suppressing"
18100 When Exim is logging to syslog, it writes the log lines for its three
18101 separate logs at different syslog priorities so that they can in principle
18102 be separated on the logging hosts. Some installations do not require this
18103 separation, and in those cases, the duplication of certain log lines is a
18104 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18105 particular log line is written to syslog. For lines that normally go to
18106 both the main log and the reject log, the reject log version (possibly
18107 containing message header lines) is written, at LOG_NOTICE priority.
18108 Lines that normally go to both the main and the panic log are written at
18109 the LOG_ALERT priority.
18110
18111
18112 .option syslog_facility main string unset
18113 .cindex "syslog" "facility; setting"
18114 This option sets the syslog &"facility"& name, used when Exim is logging to
18115 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18116 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18117 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18118 details of Exim's logging.
18119
18120
18121 .option syslog_pid main boolean true
18122 .cindex "syslog" "pid"
18123 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18124 omitted when these lines are sent to syslog. (Syslog normally prefixes
18125 the log lines with the PID of the logging process automatically.) You need
18126 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18127 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18128
18129
18130
18131 .option syslog_processname main string &`exim`&
18132 .cindex "syslog" "process name; setting"
18133 This option sets the syslog &"ident"& name, used when Exim is logging to
18134 syslog. The value must be no longer than 32 characters. See chapter
18135 &<<CHAPlog>>& for details of Exim's logging.
18136
18137
18138
18139 .option syslog_timestamp main boolean true
18140 .cindex "syslog" "timestamps"
18141 .cindex timestamps syslog
18142 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18143 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18144 details of Exim's logging.
18145
18146
18147 .option system_filter main string&!! unset
18148 .cindex "filter" "system filter"
18149 .cindex "system filter" "specifying"
18150 .cindex "Sieve filter" "not available for system filter"
18151 This option specifies an Exim filter file that is applied to all messages at
18152 the start of each delivery attempt, before any routing is done. System filters
18153 must be Exim filters; they cannot be Sieve filters. If the system filter
18154 generates any deliveries to files or pipes, or any new mail messages, the
18155 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18156 which transports are to be used. Details of this facility are given in chapter
18157 &<<CHAPsystemfilter>>&.
18158 A forced expansion failure results in no filter operation.
18159
18160
18161 .option system_filter_directory_transport main string&!! unset
18162 .vindex "&$address_file$&"
18163 This sets the name of the transport driver that is to be used when the
18164 &%save%& command in a system message filter specifies a path ending in &"/"&,
18165 implying delivery of each message into a separate file in some directory.
18166 During the delivery, the variable &$address_file$& contains the path name.
18167
18168
18169 .option system_filter_file_transport main string&!! unset
18170 .cindex "file" "transport for system filter"
18171 This sets the name of the transport driver that is to be used when the &%save%&
18172 command in a system message filter specifies a path not ending in &"/"&. During
18173 the delivery, the variable &$address_file$& contains the path name.
18174
18175 .option system_filter_group main string unset
18176 .cindex "gid (group id)" "system filter"
18177 This option is used only when &%system_filter_user%& is also set. It sets the
18178 gid under which the system filter is run, overriding any gid that is associated
18179 with the user. The value may be numerical or symbolic.
18180
18181 .option system_filter_pipe_transport main string&!! unset
18182 .cindex "&(pipe)& transport" "for system filter"
18183 .vindex "&$address_pipe$&"
18184 This specifies the transport driver that is to be used when a &%pipe%& command
18185 is used in a system filter. During the delivery, the variable &$address_pipe$&
18186 contains the pipe command.
18187
18188
18189 .option system_filter_reply_transport main string&!! unset
18190 .cindex "&(autoreply)& transport" "for system filter"
18191 This specifies the transport driver that is to be used when a &%mail%& command
18192 is used in a system filter.
18193
18194
18195 .option system_filter_user main string unset
18196 .cindex "uid (user id)" "system filter"
18197 If this option is set to root, the system filter is run in the main Exim
18198 delivery process, as root.  Otherwise, the system filter runs in a separate
18199 process, as the given user, defaulting to the Exim run-time user.
18200 Unless the string consists entirely of digits, it
18201 is looked up in the password data. Failure to find the named user causes a
18202 configuration error. The gid is either taken from the password data, or
18203 specified by &%system_filter_group%&. When the uid is specified numerically,
18204 &%system_filter_group%& is required to be set.
18205
18206 If the system filter generates any pipe, file, or reply deliveries, the uid
18207 under which the filter is run is used when transporting them, unless a
18208 transport option overrides.
18209
18210
18211 .option tcp_nodelay main boolean true
18212 .cindex "daemon" "TCP_NODELAY on sockets"
18213 .cindex "Nagle algorithm"
18214 .cindex "TCP_NODELAY on listening sockets"
18215 If this option is set false, it stops the Exim daemon setting the
18216 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18217 turns off the &"Nagle algorithm"&, which is a way of improving network
18218 performance in interactive (character-by-character) situations. Turning it off
18219 should improve Exim's performance a bit, so that is what happens by default.
18220 However, it appears that some broken clients cannot cope, and time out. Hence
18221 this option. It affects only those sockets that are set up for listening by the
18222 daemon. Sockets created by the smtp transport for delivering mail always set
18223 TCP_NODELAY.
18224
18225
18226 .option timeout_frozen_after main time 0s
18227 .cindex "frozen messages" "timing out"
18228 .cindex "timeout" "frozen messages"
18229 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18230 message of any kind that has been in the queue for longer than the given time
18231 is automatically cancelled at the next queue run. If the frozen message is a
18232 bounce message, it is just discarded; otherwise, a bounce is sent to the
18233 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18234 If you want to timeout frozen bounce messages earlier than other kinds of
18235 frozen message, see &%ignore_bounce_errors_after%&.
18236
18237 &*Note:*& the default value of zero means no timeouts; with this setting,
18238 frozen messages remain in the queue forever (except for any frozen bounce
18239 messages that are released by &%ignore_bounce_errors_after%&).
18240
18241
18242 .option timezone main string unset
18243 .cindex "timezone, setting"
18244 .cindex "environment" "values from"
18245 The value of &%timezone%& is used to set the environment variable TZ while
18246 running Exim (if it is different on entry). This ensures that all timestamps
18247 created by Exim are in the required timezone. If you want all your timestamps
18248 to be in UTC (aka GMT) you should set
18249 .code
18250 timezone = UTC
18251 .endd
18252 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18253 or, if that is not set, from the value of the TZ environment variable when Exim
18254 is built. If &%timezone%& is set to the empty string, either at build or run
18255 time, any existing TZ variable is removed from the environment when Exim
18256 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18257 unfortunately not all, operating systems.
18258
18259
18260 .option tls_advertise_hosts main "host list&!!" *
18261 .cindex "TLS" "advertising"
18262 .cindex "encryption" "on SMTP connection"
18263 .cindex "SMTP" "encrypted connection"
18264 .cindex "ESMTP extensions" STARTTLS
18265 When Exim is built with support for TLS encrypted connections, the availability
18266 of the STARTTLS command to set up an encrypted session is advertised in
18267 response to EHLO only to those client hosts that match this option. See
18268 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18269 Note that the default value requires that a certificate be supplied
18270 using the &%tls_certificate%& option.  If TLS support for incoming connections
18271 is not required the &%tls_advertise_hosts%& option should be set empty.
18272
18273
18274 .option tls_alpn main "string list&!!" "smtp : esmtp"
18275 .cindex TLS "Application Layer Protocol Names"
18276 .cindex TLS ALPN
18277 .cindex ALPN "set acceptable names for server"
18278 If this option is set,
18279 the TLS library supports ALPN,
18280 and the client offers either more than
18281 ALPN name or a name which does not match the list,
18282 the TLS connection is declined.
18283
18284
18285 .option tls_certificate main "string list&!!" unset
18286 .cindex "TLS" "server certificate; location of"
18287 .cindex "certificate" "server, location of"
18288 The value of this option is expanded, and must then be a list of absolute paths to
18289 files which contain the server's certificates (in PEM format).
18290 Commonly only one file is needed.
18291 The server's private key is also
18292 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18293 &<<CHAPTLS>>& for further details.
18294
18295 &*Note*&: The certificates defined by this option are used only when Exim is
18296 receiving incoming messages as a server. If you want to supply certificates for
18297 use when sending messages as a client, you must set the &%tls_certificate%&
18298 option in the relevant &(smtp)& transport.
18299
18300 &*Note*&: If you use filenames based on IP addresses, change the list
18301 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18302
18303 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18304 when a list of more than one
18305 file is used, the &$tls_in_ourcert$& variable is unreliable.
18306 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18307
18308 .cindex SNI "selecting server certificate based on"
18309 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18310 if the OpenSSL build supports TLS extensions and the TLS client sends the
18311 Server Name Indication extension, then this option and others documented in
18312 &<<SECTtlssni>>& will be re-expanded.
18313
18314 If this option is unset or empty a self-signed certificate will be
18315 used.
18316 Under Linux this is generated at daemon startup; on other platforms it will be
18317 generated fresh for every connection.
18318
18319 .option tls_crl main string&!! unset
18320 .cindex "TLS" "server certificate revocation list"
18321 .cindex "certificate" "revocation list for server"
18322 This option specifies a certificate revocation list. The expanded value must
18323 be the name of a file that contains CRLs in PEM format.
18324
18325 Under OpenSSL the option can specify a directory with CRL files.
18326
18327 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18328 for each signing element of the certificate chain (i.e. all but the leaf).
18329 For the file variant this can be multiple PEM blocks in the one file.
18330
18331 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18332
18333
18334 .option tls_dh_max_bits main integer 2236
18335 .cindex "TLS" "D-H bit count"
18336 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18337 the chosen TLS library.  That value might prove to be too high for
18338 interoperability.  This option provides a maximum clamp on the value
18339 suggested, trading off security for interoperability.
18340
18341 The value must be at least 1024.
18342
18343 The value 2236 was chosen because, at time of adding the option, it was the
18344 hard-coded maximum value supported by the NSS cryptographic library, as used
18345 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18346
18347 If you prefer more security and are willing to break some clients, raise this
18348 number.
18349
18350 Note that the value passed to GnuTLS for *generating* a new prime may be a
18351 little less than this figure, because GnuTLS is inexact and may produce a
18352 larger prime than requested.
18353
18354
18355 .option tls_dhparam main string&!! unset
18356 .cindex "TLS" "D-H parameters for server"
18357 The value of this option is expanded and indicates the source of DH parameters
18358 to be used by Exim.
18359
18360 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
18361 local DH parameters*&, which has been supported across all versions of Exim.  The
18362 other specific constants available are a fallback so that even when
18363 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18364
18365 If &%tls_dhparam%& is a filename starting with a &`/`&,
18366 then it names a file from which DH
18367 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18368 PKCS#3 representation of the DH prime.  If the file does not exist, for
18369 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18370 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18371 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18372 and treated as though the &%tls_dhparam%& were set to "none".
18373
18374 If this option expands to the string "none", then no DH parameters will be
18375 loaded by Exim.
18376
18377 If this option expands to the string "historic" and Exim is using GnuTLS, then
18378 Exim will attempt to load a file from inside the spool directory.  If the file
18379 does not exist, Exim will attempt to create it.
18380 See section &<<SECTgnutlsparam>>& for further details.
18381
18382 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18383 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18384
18385 In older versions of Exim the default was the 2048 bit prime described in section
18386 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18387 in IKE is assigned number 23.
18388
18389 Otherwise, the option must expand to the name used by Exim for any of a number
18390 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18391 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18392 the number used by IKE, or "default" which corresponds to
18393 &`exim.dev.20160529.3`&.
18394
18395 The available standard primes are:
18396 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18397 &`ike1`&, &`ike2`&, &`ike5`&,
18398 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18399 &`ike22`&, &`ike23`& and &`ike24`&.
18400
18401 The available additional primes are:
18402 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18403
18404 Some of these will be too small to be accepted by clients.
18405 Some may be too large to be accepted by clients.
18406 The open cryptographic community has suspicions about the integrity of some
18407 of the later IKE values, which led into RFC7919 providing new fixed constants
18408 (the "ffdhe" identifiers).
18409
18410 At this point, all of the "ike" values should be considered obsolete;
18411 they are still in Exim to avoid breaking unusual configurations, but are
18412 candidates for removal the next time we have backwards-incompatible changes.
18413 Two of them in particular (&`ike1`& and &`ike22`&) are called out by RFC 8247
18414 as MUST NOT use for IPSEC, and two more (&`ike23`& and &`ike24`&) as
18415 SHOULD NOT.
18416 Because of this, Exim regards them as deprecated; if either of the first pair
18417 are used, warnings will be logged in the paniclog, and if any are used then
18418 warnings will be logged in the mainlog.
18419 All four will be removed in a future Exim release.
18420
18421 The TLS protocol does not negotiate an acceptable size for this; clients tend
18422 to hard-drop connections if what is offered by the server is unacceptable,
18423 whether too large or too small, and there's no provision for the client to
18424 tell the server what these constraints are.  Thus, as a server operator, you
18425 need to make an educated guess as to what is most likely to work for your
18426 userbase.
18427
18428 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18429 is most likely to maximise interoperability.  The upper bound comes from
18430 applications using the Mozilla Network Security Services (NSS) library, which
18431 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18432 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18433 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18434 acceptable bound from 1024 to 2048.
18435
18436
18437 .option tls_eccurve main string&!! &`auto`&
18438 .cindex TLS "EC cryptography"
18439 This option selects a EC curve for use by Exim when used with OpenSSL.
18440 It has no effect when Exim is used with GnuTLS.
18441
18442 After expansion it must contain a valid EC curve parameter, such as
18443 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
18444 for valid selections.
18445
18446 For OpenSSL versions before (and not including) 1.0.2, the string
18447 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18448 &`auto`& tells the library to choose.
18449
18450 If the option expands to an empty string, no EC curves will be enabled.
18451
18452
18453 .option tls_ocsp_file main string&!! unset
18454 .cindex TLS "certificate status"
18455 .cindex TLS "OCSP proof file"
18456 This option
18457 must if set expand to the absolute path to a file which contains a current
18458 status proof for the server's certificate, as obtained from the
18459 Certificate Authority.
18460
18461 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18462 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18463
18464 For OpenSSL 1.1.0 or later, and
18465 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18466 of files, to match a list given for the &%tls_certificate%& option.
18467 The ordering of the two lists must match.
18468 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18469
18470 The file(s) should be in DER format,
18471 except for GnuTLS 3.6.3 or later
18472 or for OpenSSL,
18473 when an optional filetype prefix can be used.
18474 The prefix must be one of "DER" or "PEM", followed by
18475 a single space.  If one is used it sets the format for subsequent
18476 files in the list; the initial format is DER.
18477 If multiple proofs are wanted, for multiple chain elements
18478 (this only works under TLS1.3)
18479 they must be coded as a combined OCSP response.
18480
18481 Although GnuTLS will accept PEM files with multiple separate
18482 PEM blobs (ie. separate OCSP responses), it sends them in the
18483 TLS Certificate record interleaved with the certificates of the chain;
18484 although a GnuTLS client is happy with that, an OpenSSL client is not.
18485
18486 .option tls_on_connect_ports main "string list" unset
18487 .cindex SSMTP
18488 .cindex SMTPS
18489 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18490 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18491 set up without waiting for the client to issue a STARTTLS command. For
18492 further details, see section &<<SECTsupobssmt>>&.
18493
18494
18495
18496 .option tls_privatekey main "string list&!!" unset
18497 .cindex "TLS" "server private key; location of"
18498 The value of this option is expanded, and must then be a list of absolute paths to
18499 files which contains the server's private keys.
18500 If this option is unset, or if
18501 the expansion is forced to fail, or the result is an empty string, the private
18502 key is assumed to be in the same file as the server's certificates. See chapter
18503 &<<CHAPTLS>>& for further details.
18504
18505 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18506
18507
18508 .option tls_remember_esmtp main boolean false
18509 .cindex "TLS" "esmtp state; remembering"
18510 .cindex "TLS" "broken clients"
18511 If this option is set true, Exim violates the RFCs by remembering that it is in
18512 &"esmtp"& state after successfully negotiating a TLS session. This provides
18513 support for broken clients that fail to send a new EHLO after starting a
18514 TLS session.
18515
18516
18517 .option tls_require_ciphers main string&!! unset
18518 .cindex "TLS" "requiring specific ciphers"
18519 .cindex "cipher" "requiring specific"
18520 This option controls which ciphers can be used for incoming TLS connections.
18521 The &(smtp)& transport has an option of the same name for controlling outgoing
18522 connections. This option is expanded for each connection, so can be varied for
18523 different clients if required. The value of this option must be a list of
18524 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18525 in somewhat different ways. If GnuTLS is being used, the client controls the
18526 preference order of the available ciphers. Details are given in sections
18527 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18528
18529
18530 .option tls_resumption_hosts main "host list&!!" unset
18531 .cindex TLS resumption
18532 This option controls which connections to offer the TLS resumption feature.
18533 See &<<SECTresumption>>& for details.
18534
18535
18536 .option tls_try_verify_hosts main "host list&!!" unset
18537 .cindex "TLS" "client certificate verification"
18538 .cindex "certificate" "verification of client"
18539 See &%tls_verify_hosts%& below.
18540
18541
18542 .option tls_verify_certificates main string&!! system
18543 .cindex "TLS" "client certificate verification"
18544 .cindex "certificate" "verification of client"
18545 The value of this option is expanded, and must then be either the
18546 word "system"
18547 or the absolute path to
18548 a file or directory containing permitted certificates for clients that
18549 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18550
18551 The "system" value for the option will use a
18552 system default location compiled into the SSL library.
18553 This is not available for GnuTLS versions preceding 3.0.20,
18554 and will be taken as empty; an explicit location
18555 must be specified.
18556
18557 The use of a directory for the option value is not available for GnuTLS versions
18558 preceding 3.3.6 and a single file must be used.
18559
18560 With OpenSSL the certificates specified
18561 explicitly
18562 either by file or directory
18563 are added to those given by the system default location.
18564
18565 These certificates should be for the certificate authorities trusted, rather
18566 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18567 the value is a file then the certificates are sent by Exim as a server to
18568 connecting clients, defining the list of accepted certificate authorities.
18569 Thus the values defined should be considered public data.  To avoid this,
18570 use the explicit directory version. (If your peer is Exim up to 4.85,
18571 using GnuTLS, you may need to send the CAs (thus using the file
18572 variant). Otherwise the peer doesn't send its certificate.)
18573
18574 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18575
18576 A forced expansion failure or setting to an empty string is equivalent to
18577 being unset.
18578
18579
18580 .option tls_verify_hosts main "host list&!!" unset
18581 .cindex "TLS" "client certificate verification"
18582 .cindex "certificate" "verification of client"
18583 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18584 certificates from clients. The expected certificates are defined by
18585 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18586 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18587 &%tls_verify_certificates%& is not set.
18588
18589 Any client that matches &%tls_verify_hosts%& is constrained by
18590 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18591 present one of the listed certificates. If it does not, the connection is
18592 aborted.
18593 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18594 the host to use TLS. It can still send SMTP commands through unencrypted
18595 connections. Forcing a client to use TLS has to be done separately using an
18596 ACL to reject inappropriate commands when the connection is not encrypted.
18597
18598 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18599 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18600 certificate and checks it against &%tls_verify_certificates%&, but does not
18601 abort the connection if there is no certificate or if it does not match. This
18602 state can be detected in an ACL, which makes it possible to implement policies
18603 such as &"accept for relay only if a verified certificate has been received,
18604 but accept for local delivery if encrypted, even without a verified
18605 certificate"&.
18606
18607 Client hosts that match neither of these lists are not asked to present
18608 certificates.
18609
18610
18611 .option trusted_groups main "string list&!!" unset
18612 .cindex "trusted groups"
18613 .cindex "groups" "trusted"
18614 This option is expanded just once, at the start of Exim's processing. If this
18615 option is set, any process that is running in one of the listed groups, or
18616 which has one of them as a supplementary group, is trusted. The groups can be
18617 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18618 details of what trusted callers are permitted to do. If neither
18619 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18620 are trusted.
18621
18622 .option trusted_users main "string list&!!" unset
18623 .cindex "trusted users"
18624 .cindex "user" "trusted"
18625 This option is expanded just once, at the start of Exim's processing. If this
18626 option is set, any process that is running as one of the listed users is
18627 trusted. The users can be specified numerically or by name. See section
18628 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18629 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18630 Exim user are trusted.
18631
18632 .option unknown_login main string&!! unset
18633 .cindex "uid (user id)" "unknown caller"
18634 .vindex "&$caller_uid$&"
18635 This is a specialized feature for use in unusual configurations. By default, if
18636 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18637 gives up. The &%unknown_login%& option can be used to set a login name to be
18638 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18639 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18640 is used for the user's real name (gecos field), unless this has been set by the
18641 &%-F%& option.
18642
18643 .option unknown_username main string unset
18644 See &%unknown_login%&.
18645
18646 .option untrusted_set_sender main "address list&!!" unset
18647 .cindex "trusted users"
18648 .cindex "sender" "setting by untrusted user"
18649 .cindex "untrusted user setting sender"
18650 .cindex "user" "untrusted setting sender"
18651 .cindex "envelope from"
18652 .cindex "envelope sender"
18653 When an untrusted user submits a message to Exim using the standard input, Exim
18654 normally creates an envelope sender address from the user's login and the
18655 default qualification domain. Data from the &%-f%& option (for setting envelope
18656 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18657 is used) is ignored.
18658
18659 However, untrusted users are permitted to set an empty envelope sender address,
18660 to declare that a message should never generate any bounces. For example:
18661 .code
18662 exim -f '<>' user@domain.example
18663 .endd
18664 .vindex "&$sender_ident$&"
18665 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18666 other envelope sender addresses in a controlled way. When it is set, untrusted
18667 users are allowed to set envelope sender addresses that match any of the
18668 patterns in the list. Like all address lists, the string is expanded. The
18669 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18670 users to setting senders that start with their login ids
18671 followed by a hyphen
18672 by a setting like this:
18673 .code
18674 untrusted_set_sender = ^$sender_ident-
18675 .endd
18676 If you want to allow untrusted users to set envelope sender addresses without
18677 restriction, you can use
18678 .code
18679 untrusted_set_sender = *
18680 .endd
18681 The &%untrusted_set_sender%& option applies to all forms of local input, but
18682 only to the setting of the envelope sender. It does not permit untrusted users
18683 to use the other options which trusted user can use to override message
18684 parameters. Furthermore, it does not stop Exim from removing an existing
18685 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18686 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18687 overriding these actions. The handling of the &'Sender:'& header is also
18688 described in section &<<SECTthesenhea>>&.
18689
18690 The log line for a message's arrival shows the envelope sender following
18691 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18692 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18693 envelope sender address, the user's login is shown in parentheses after the
18694 sender address.
18695
18696
18697 .option uucp_from_pattern main string "see below"
18698 .cindex "&""From""& line"
18699 .cindex "UUCP" "&""From""& line"
18700 Some applications that pass messages to an MTA via a command line interface use
18701 an initial line starting with &"From&~"& to pass the envelope sender. In
18702 particular, this is used by UUCP software. Exim recognizes such a line by means
18703 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18704 matches, the sender address is constructed by expanding the contents of
18705 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18706 default pattern recognizes lines in the following two forms:
18707 .code
18708 From ph10 Fri Jan  5 12:35 GMT 1996
18709 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18710 .endd
18711 The pattern can be seen by running
18712 .code
18713 exim -bP uucp_from_pattern
18714 .endd
18715 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18716 year in the second case. The first word after &"From&~"& is matched in the
18717 regular expression by a parenthesized subpattern. The default value for
18718 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18719 (&"ph10"& in the example above) as the message's sender. See also
18720 &%ignore_fromline_hosts%&.
18721
18722
18723 .option uucp_from_sender main string&!! &`$1`&
18724 See &%uucp_from_pattern%& above.
18725
18726
18727 .option warn_message_file main string&!! unset
18728 .cindex "warning of delay" "customizing the message"
18729 .cindex "customizing" "warning message"
18730 This option defines a template file containing paragraphs of text to be used
18731 for constructing the warning message which is sent by Exim when a message has
18732 been in the queue for a specified amount of time, as specified by
18733 &%delay_warning%&. Details of the file's contents are given in chapter
18734 &<<CHAPemsgcust>>&.
18735 .cindex warn_message_file "tainted data"
18736 The option is expanded to give the file path, which must be
18737 absolute and untainted.
18738 See also &%bounce_message_file%&.
18739
18740
18741 .option write_rejectlog main boolean true
18742 .cindex "reject log" "disabling"
18743 If this option is set false, Exim no longer writes anything to the reject log.
18744 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18745 .ecindex IIDconfima
18746 .ecindex IIDmaiconf
18747
18748
18749
18750
18751 . ////////////////////////////////////////////////////////////////////////////
18752 . ////////////////////////////////////////////////////////////////////////////
18753
18754 .chapter "Generic options for routers" "CHAProutergeneric"
18755 .scindex IIDgenoprou1 "options" "generic; for routers"
18756 .scindex IIDgenoprou2 "generic options" "router"
18757 This chapter describes the generic options that apply to all routers.
18758 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18759
18760 For a general description of how a router operates, see sections
18761 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18762 which the preconditions are tested. The order of expansion of the options that
18763 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18764 &%headers_remove%&, &%transport%&.
18765
18766 The name of a router is limited to be &drivernamemax; ASCII characters long;
18767 prior to Exim 4.95 names would be silently truncated at this length, but now
18768 it is enforced.
18769
18770
18771 .option address_data routers string&!! unset
18772 .cindex "router" "data attached to address"
18773 The string is expanded just before the router is run, that is, after all the
18774 precondition tests have succeeded. If the expansion is forced to fail, the
18775 router declines, the value of &%address_data%& remains unchanged, and the
18776 &%more%& option controls what happens next. Other expansion failures cause
18777 delivery of the address to be deferred.
18778
18779 .vindex "&$address_data$&"
18780 When the expansion succeeds, the value is retained with the address, and can be
18781 accessed using the variable &$address_data$& in the current router, subsequent
18782 routers, and the eventual transport.
18783
18784 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18785 that runs a user's filter file, the contents of &$address_data$& are accessible
18786 in the filter. This is not normally a problem, because such data is usually
18787 either not confidential or it &"belongs"& to the current user, but if you do
18788 put confidential data into &$address_data$& you need to remember this point.
18789
18790 Even if the router declines or passes, the value of &$address_data$& remains
18791 with the address, though it can be changed by another &%address_data%& setting
18792 on a subsequent router. If a router generates child addresses, the value of
18793 &$address_data$& propagates to them. This also applies to the special kind of
18794 &"child"& that is generated by a router with the &%unseen%& option.
18795
18796 The idea of &%address_data%& is that you can use it to look up a lot of data
18797 for the address once, and then pick out parts of the data later. For example,
18798 you could use a single LDAP lookup to return a string of the form
18799 .code
18800 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18801 .endd
18802 In the transport you could pick out the mailbox by a setting such as
18803 .code
18804 file = ${extract{mailbox}{$address_data}}
18805 .endd
18806 This makes the configuration file less messy, and also reduces the number of
18807 lookups (though Exim does cache lookups).
18808
18809 See also the &%set%& option below.
18810
18811 .vindex "&$sender_address_data$&"
18812 .vindex "&$address_data$&"
18813 The &%address_data%& facility is also useful as a means of passing information
18814 from one router to another, and from a router to a transport. In addition, if
18815 &$address_data$& is set by a router when verifying a recipient address from an
18816 ACL, it remains available for use in the rest of the ACL statement. After
18817 verifying a sender, the value is transferred to &$sender_address_data$&.
18818
18819
18820
18821 .option address_test routers&!? boolean true
18822 .oindex "&%-bt%&"
18823 .cindex "router" "skipping when address testing"
18824 If this option is set false, the router is skipped when routing is being tested
18825 by means of the &%-bt%& command line option. This can be a convenience when
18826 your first router sends messages to an external scanner, because it saves you
18827 having to set the &"already scanned"& indicator when testing real address
18828 routing.
18829
18830
18831
18832 .option cannot_route_message routers string&!! unset
18833 .cindex "router" "customizing &""cannot route""& message"
18834 .cindex "customizing" "&""cannot route""& message"
18835 This option specifies a text message that is used when an address cannot be
18836 routed because Exim has run out of routers. The default message is
18837 &"Unrouteable address"&. This option is useful only on routers that have
18838 &%more%& set false, or on the very last router in a configuration, because the
18839 value that is used is taken from the last router that is considered. This
18840 includes a router that is skipped because its preconditions are not met, as
18841 well as a router that declines. For example, using the default configuration,
18842 you could put:
18843 .code
18844 cannot_route_message = Remote domain not found in DNS
18845 .endd
18846 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18847 and
18848 .code
18849 cannot_route_message = Unknown local user
18850 .endd
18851 on the final router that checks for local users. If string expansion fails for
18852 this option, the default message is used. Unless the expansion failure was
18853 explicitly forced, a message about the failure is written to the main and panic
18854 logs, in addition to the normal message about the routing failure.
18855
18856
18857 .option caseful_local_part routers boolean false
18858 .cindex "case of local parts"
18859 .cindex "router" "case of local parts"
18860 By default, routers handle the local parts of addresses in a case-insensitive
18861 manner, though the actual case is preserved for transmission with the message.
18862 If you want the case of letters to be significant in a router, you must set
18863 this option true. For individual router options that contain address or local
18864 part lists (for example, &%local_parts%&), case-sensitive matching can be
18865 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18866 more details.
18867
18868 .vindex "&$local_part$&"
18869 .vindex "&$original_local_part$&"
18870 .vindex "&$parent_local_part$&"
18871 The value of the &$local_part$& variable is forced to lower case while a
18872 router is running unless &%caseful_local_part%& is set. When a router assigns
18873 an address to a transport, the value of &$local_part$& when the transport runs
18874 is the same as it was in the router. Similarly, when a router generates child
18875 addresses by aliasing or forwarding, the values of &$original_local_part$&
18876 and &$parent_local_part$& are those that were used by the redirecting router.
18877
18878 This option applies to the processing of an address by a router. When a
18879 recipient address is being processed in an ACL, there is a separate &%control%&
18880 modifier that can be used to specify case-sensitive processing within the ACL
18881 (see section &<<SECTcontrols>>&).
18882
18883
18884
18885 .option check_local_user routers&!? boolean false
18886 .cindex "local user, checking in router"
18887 .cindex "router" "checking for local user"
18888 .cindex "&_/etc/passwd_&"
18889 .vindex "&$home$&"
18890 When this option is true, Exim checks that the local part of the recipient
18891 address (with affixes removed if relevant) is the name of an account on the
18892 local system. The check is done by calling the &[getpwnam()]& function rather
18893 than trying to read &_/etc/passwd_& directly. This means that other methods of
18894 holding password data (such as NIS) are supported. If the local part is a local
18895 user,
18896 .cindex "tainted data" "de-tainting"
18897 .cindex "de-tainting" "using router check_local_user option"
18898 &$local_part_data$& is set to an untainted version of the local part and
18899 &$home$& is set from the password data. The latter can be tested in other
18900 preconditions that are evaluated after this one (the order of evaluation is
18901 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18902 overridden by &%router_home_directory%&. If the local part is not a local user,
18903 the router is skipped.
18904
18905 If you want to check that the local part is either the name of a local user
18906 or matches something else, you cannot combine &%check_local_user%& with a
18907 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18908 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18909 setting to achieve this. For example:
18910 .code
18911 local_parts = passwd;$local_part : lsearch;/etc/other/users
18912 .endd
18913 Note, however, that the side effects of &%check_local_user%& (such as setting
18914 up a home directory) do not occur when a &(passwd)& lookup is used in a
18915 &%local_parts%& (or any other) precondition.
18916
18917
18918
18919 .option condition routers&!? string&!! unset
18920 .cindex "router" "customized precondition"
18921 This option specifies a general precondition test that has to succeed for the
18922 router to be called. The &%condition%& option is the last precondition to be
18923 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18924 result is a forced failure, or an empty string, or one of the strings &"0"& or
18925 &"no"& or &"false"& (checked without regard to the case of the letters), the
18926 router is skipped, and the address is offered to the next one.
18927
18928 If the result is any other value, the router is run (as this is the last
18929 precondition to be evaluated, all the other preconditions must be true).
18930
18931 This option is unusual in that multiple &%condition%& options may be present.
18932 All &%condition%& options must succeed.
18933
18934 The &%condition%& option provides a means of applying custom conditions to the
18935 running of routers. Note that in the case of a simple conditional expansion,
18936 the default expansion values are exactly what is wanted. For example:
18937 .code
18938 condition = ${if >{$message_age}{600}}
18939 .endd
18940 Because of the default behaviour of the string expansion, this is equivalent to
18941 .code
18942 condition = ${if >{$message_age}{600}{true}{}}
18943 .endd
18944
18945 A multiple condition example, which succeeds:
18946 .code
18947 condition = ${if >{$message_age}{600}}
18948 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18949 condition = foobar
18950 .endd
18951
18952 If the expansion fails (other than forced failure) delivery is deferred. Some
18953 of the other precondition options are common special cases that could in fact
18954 be specified using &%condition%&.
18955
18956 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18957 are far older, and use one set of semantics.  ACLs are newer and when
18958 they were created, the ACL &%condition%& process was given far stricter
18959 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18960 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18961 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18962 Router rules processing behavior.
18963
18964 This is best illustrated in an example:
18965 .code
18966 # If used in an ACL condition will fail with a syntax error, but
18967 # in a router condition any extra characters are treated as a string
18968
18969 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18970 true {yes} {no}}
18971
18972 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18973  {yes} {no}}
18974 .endd
18975 In each example above, the &%if%& statement actually ends after
18976 &"{google.com}}"&.  Since no true or false braces were defined, the
18977 default &%if%& behavior is to return a boolean true or a null answer
18978 (which evaluates to false). The rest of the line is then treated as a
18979 string. So the first example resulted in the boolean answer &"true"&
18980 with the string &" {yes} {no}}"& appended to it. The second example
18981 resulted in the null output (indicating false) with the string
18982 &" {yes} {no}}"& appended to it.
18983
18984 In fact you can put excess forward braces in too.  In the router
18985 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18986 mean something, like after a &"$"& or when required as part of a
18987 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18988 string characters.
18989
18990 Thus, in a Router, the above expansion strings will both always evaluate
18991 true, as the result of expansion is a non-empty string which doesn't
18992 match an explicit false value.  This can be tricky to debug.  By
18993 contrast, in an ACL either of those strings will always result in an
18994 expansion error because the result doesn't look sufficiently boolean.
18995
18996
18997 .option debug_print routers string&!! unset
18998 .cindex "testing" "variables in drivers"
18999 If this option is set and debugging is enabled (see the &%-d%& command line
19000 option) or in address-testing mode (see the &%-bt%& command line option),
19001 the string is expanded and included in the debugging output.
19002 If expansion of the string fails, the error message is written to the debugging
19003 output, and Exim carries on processing.
19004 This option is provided to help with checking out the values of variables and
19005 so on when debugging router configurations. For example, if a &%condition%&
19006 option appears not to be working, &%debug_print%& can be used to output the
19007 variables it references. The output happens after checks for &%domains%&,
19008 &%local_parts%&, and &%check_local_user%& but before any other preconditions
19009 are tested. A newline is added to the text if it does not end with one.
19010 The variable &$router_name$& contains the name of the router.
19011
19012
19013
19014 .option disable_logging routers boolean false
19015 If this option is set true, nothing is logged for any routing errors
19016 or for any deliveries caused by this router. You should not set this option
19017 unless you really, really know what you are doing. See also the generic
19018 transport option of the same name.
19019
19020 .option dnssec_request_domains routers "domain list&!!" *
19021 .cindex "MX record" "security"
19022 .cindex "DNSSEC" "MX lookup"
19023 .cindex "security" "MX lookup"
19024 .cindex "DNS" "DNSSEC"
19025 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
19026 the DNSSEC request bit set.
19027 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19028
19029 .option dnssec_require_domains routers "domain list&!!" unset
19030 .cindex "MX record" "security"
19031 .cindex "DNSSEC" "MX lookup"
19032 .cindex "security" "MX lookup"
19033 .cindex "DNS" "DNSSEC"
19034 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19035 the DNSSEC request bit set.  Any returns not having the Authenticated Data bit
19036 (AD bit) set will be ignored and logged as a host-lookup failure.
19037 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19038
19039
19040 .option domains routers&!? "domain list&!!" unset
19041 .cindex "router" "restricting to specific domains"
19042 .vindex "&$domain_data$&"
19043 If this option is set, the router is skipped unless the current domain matches
19044 the list. If the match is achieved by means of a file lookup, the data that the
19045 lookup returned for the domain is placed in &$domain_data$& for use in string
19046 expansions of the driver's private options and in the transport.
19047 See section &<<SECTrouprecon>>& for
19048 a list of the order in which preconditions are evaluated.
19049
19050
19051
19052 .option driver routers string unset
19053 This option must always be set. It specifies which of the available routers is
19054 to be used.
19055
19056
19057 .option dsn_lasthop routers boolean false
19058 .cindex "DSN" "success"
19059 .cindex "Delivery Status Notification" "success"
19060 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19061 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19062 instead send a success DSN as if the next hop does not support DSN.
19063 Not effective on redirect routers.
19064
19065
19066
19067 .option errors_to routers string&!! unset
19068 .cindex "envelope from"
19069 .cindex "envelope sender"
19070 .cindex "router" "changing address for errors"
19071 If a router successfully handles an address, it may assign the address to a
19072 transport for delivery or it may generate child addresses. In both cases, if
19073 there is a delivery problem during later processing, the resulting bounce
19074 message is sent to the address that results from expanding this string,
19075 provided that the address verifies successfully. The &%errors_to%& option is
19076 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19077
19078 The &%errors_to%& setting associated with an address can be overridden if it
19079 subsequently passes through other routers that have their own &%errors_to%&
19080 settings, or if the message is delivered by a transport with a &%return_path%&
19081 setting.
19082
19083 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19084 the expansion fails to verify, the errors address associated with the incoming
19085 address is used. At top level, this is the envelope sender. A non-forced
19086 expansion failure causes delivery to be deferred.
19087
19088 If an address for which &%errors_to%& has been set ends up being delivered over
19089 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19090 any bounces that are generated by other MTAs on the delivery route are also
19091 sent there. You can set &%errors_to%& to the empty string by either of these
19092 settings:
19093 .code
19094 errors_to =
19095 errors_to = ""
19096 .endd
19097 An expansion item that yields an empty string has the same effect. If you do
19098 this, a locally detected delivery error for addresses processed by this router
19099 no longer gives rise to a bounce message; the error is discarded. If the
19100 address is delivered to a remote host, the return path is set to &`<>`&, unless
19101 overridden by the &%return_path%& option on the transport.
19102
19103 .vindex "&$address_data$&"
19104 If for some reason you want to discard local errors, but use a non-empty
19105 MAIL command for remote delivery, you can preserve the original return
19106 path in &$address_data$& in the router, and reinstate it in the transport by
19107 setting &%return_path%&.
19108
19109 The most common use of &%errors_to%& is to direct mailing list bounces to the
19110 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19111 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19112
19113
19114
19115 .option expn routers&!? boolean true
19116 .cindex "address" "testing"
19117 .cindex "testing" "addresses"
19118 .cindex "EXPN" "router skipping"
19119 .cindex "router" "skipping for EXPN"
19120 If this option is turned off, the router is skipped when testing an address
19121 as a result of processing an SMTP EXPN command. You might, for example,
19122 want to turn it off on a router for users' &_.forward_& files, while leaving it
19123 on for the system alias file.
19124 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19125 are evaluated.
19126
19127 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19128 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19129 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19130
19131
19132
19133 .option fail_verify routers boolean false
19134 .cindex "router" "forcing verification failure"
19135 Setting this option has the effect of setting both &%fail_verify_sender%& and
19136 &%fail_verify_recipient%& to the same value.
19137
19138
19139
19140 .option fail_verify_recipient routers boolean false
19141 If this option is true and an address is accepted by this router when
19142 verifying a recipient, verification fails.
19143
19144
19145
19146 .option fail_verify_sender routers boolean false
19147 If this option is true and an address is accepted by this router when
19148 verifying a sender, verification fails.
19149
19150
19151
19152 .option fallback_hosts routers "string list" unset
19153 .cindex "router" "fallback hosts"
19154 .cindex "fallback" "hosts specified on router"
19155 String expansion is not applied to this option. The argument must be a
19156 colon-separated list of host names or IP addresses. The list separator can be
19157 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19158 each name or address. In fact, the format of each item is exactly the same as
19159 defined for the list of hosts in a &(manualroute)& router (see section
19160 &<<SECTformatonehostitem>>&).
19161
19162 If a router queues an address for a remote transport, this host list is
19163 associated with the address, and used instead of the transport's fallback host
19164 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19165 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19166 transport for further details.
19167
19168
19169 .option group routers string&!! "see below"
19170 .cindex "gid (group id)" "local delivery"
19171 .cindex "local transports" "uid and gid"
19172 .cindex "transport" "local"
19173 .cindex "router" "setting group"
19174 When a router queues an address for a transport, and the transport does not
19175 specify a group, the group given here is used when running the delivery
19176 process.
19177 The group may be specified numerically or by name. If expansion fails, the
19178 error is logged and delivery is deferred.
19179 The default is unset, unless &%check_local_user%& is set, when the default
19180 is taken from the password information. See also &%initgroups%& and &%user%&
19181 and the discussion in chapter &<<CHAPenvironment>>&.
19182
19183
19184
19185 .option headers_add routers list&!! unset
19186 .cindex "header lines" "adding"
19187 .cindex "router" "adding header lines"
19188 This option specifies a list of text headers,
19189 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19190 that is associated with any addresses that are accepted by the router.
19191 Each item is separately expanded, at routing time.  However, this
19192 option has no effect when an address is just being verified. The way in which
19193 the text is used to add header lines at transport time is described in section
19194 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19195 message is in the process of being transported. This means that references to
19196 header lines in string expansions in the transport's configuration do not
19197 &"see"& the added header lines.
19198
19199 The &%headers_add%& option is expanded after &%errors_to%&, but before
19200 &%headers_remove%& and &%transport%&. If an item is empty, or if
19201 an item expansion is forced to fail, the item has no effect. Other expansion
19202 failures are treated as configuration errors.
19203
19204 Unlike most options, &%headers_add%& can be specified multiple times
19205 for a router; all listed headers are added.
19206
19207 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19208 router that has the &%one_time%& option set.
19209
19210 .cindex "duplicate addresses"
19211 .oindex "&%unseen%&"
19212 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19213 additions are deleted when the address is passed on to subsequent routers.
19214 For a &%redirect%& router, if a generated address is the same as the incoming
19215 address, this can lead to duplicate addresses with different header
19216 modifications. Exim does not do duplicate deliveries (except, in certain
19217 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19218 which of the duplicates is discarded, so this ambiguous situation should be
19219 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19220
19221
19222
19223 .option headers_remove routers list&!! unset
19224 .cindex "header lines" "removing"
19225 .cindex "router" "removing header lines"
19226 This option specifies a list of text headers,
19227 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19228 that is associated with any addresses that are accepted by the router.
19229 However, the option has no effect when an address is just being verified.
19230 Each list item is separately expanded, at transport time.
19231 If an item ends in *, it will match any header with the given prefix.
19232 The way in which
19233 the text is used to remove header lines at transport time is described in
19234 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19235 the message is in the process of being transported. This means that references
19236 to header lines in string expansions in the transport's configuration still
19237 &"see"& the original header lines.
19238
19239 The &%headers_remove%& option is handled after &%errors_to%& and
19240 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19241 the item has no effect. Other expansion failures are treated as configuration
19242 errors.
19243
19244 Unlike most options, &%headers_remove%& can be specified multiple times
19245 for a router; all listed headers are removed.
19246
19247 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19248 router that has the &%one_time%& option set.
19249
19250 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19251 removal requests are deleted when the address is passed on to subsequent
19252 routers, and this can lead to problems with duplicates -- see the similar
19253 warning for &%headers_add%& above.
19254
19255 &*Warning 3*&: Because of the separate expansion of the list items,
19256 items that contain a list separator must have it doubled.
19257 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19258
19259
19260
19261 .option ignore_target_hosts routers "host list&!!" unset
19262 .cindex "IP address" "discarding"
19263 .cindex "router" "discarding IP addresses"
19264 Although this option is a host list, it should normally contain IP address
19265 entries rather than names. If any host that is looked up by the router has an
19266 IP address that matches an item in this list, Exim behaves as if that IP
19267 address did not exist. This option allows you to cope with rogue DNS entries
19268 like
19269 .code
19270 remote.domain.example.  A  127.0.0.1
19271 .endd
19272 by setting
19273 .code
19274 ignore_target_hosts = 127.0.0.1
19275 .endd
19276 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19277 discarded in this way, the router declines. In a conventional configuration, an
19278 attempt to mail to such a domain would normally provoke the &"unrouteable
19279 domain"& error, and an attempt to verify an address in the domain would fail.
19280 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19281 router declines if presented with one of the listed addresses.
19282
19283 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19284 means of the first or the second of the following settings, respectively:
19285 .code
19286 ignore_target_hosts = 0.0.0.0/0
19287 ignore_target_hosts = <; 0::0/0
19288 .endd
19289 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19290 in the second line matches all IPv6 addresses.
19291
19292 This option may also be useful for ignoring link-local and site-local IPv6
19293 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19294 is expanded before use as a list, it is possible to make it dependent on the
19295 domain that is being routed.
19296
19297 .vindex "&$host_address$&"
19298 During its expansion, &$host_address$& is set to the IP address that is being
19299 checked.
19300
19301 .option initgroups routers boolean false
19302 .cindex "additional groups"
19303 .cindex "groups" "additional"
19304 .cindex "local transports" "uid and gid"
19305 .cindex "transport" "local"
19306 If the router queues an address for a transport, and this option is true, and
19307 the uid supplied by the router is not overridden by the transport, the
19308 &[initgroups()]& function is called when running the transport to ensure that
19309 any additional groups associated with the uid are set up. See also &%group%&
19310 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19311
19312
19313
19314 .option local_part_prefix routers&!? "string list" unset
19315 .cindex affix "router precondition"
19316 .cindex "router" "prefix for local part"
19317 .cindex "prefix" "for local part, used in router"
19318 If this option is set, the router is skipped unless the local part starts with
19319 one of the given strings, or &%local_part_prefix_optional%& is true. See
19320 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19321 evaluated.
19322
19323 The list is scanned from left to right, and the first prefix that matches is
19324 used. A limited form of wildcard is available; if the prefix begins with an
19325 asterisk, it matches the longest possible sequence of arbitrary characters at
19326 the start of the local part. An asterisk should therefore always be followed by
19327 some character that does not occur in normal local parts.
19328 .cindex "multiple mailboxes"
19329 .cindex "mailbox" "multiple"
19330 Wildcarding can be used to set up multiple user mailboxes, as described in
19331 section &<<SECTmulbox>>&.
19332
19333 .vindex "&$local_part$&"
19334 .vindex "&$local_part_prefix$&"
19335 During the testing of the &%local_parts%& option, and while the router is
19336 running, the prefix is removed from the local part, and is available in the
19337 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19338 the router accepts the address, this remains true during subsequent delivery by
19339 a transport. In particular, the local part that is transmitted in the RCPT
19340 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19341 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19342 the relevant transport.
19343
19344 .vindex &$local_part_prefix_v$&
19345 If wildcarding (above) was used then the part of the prefix matching the
19346 wildcard is available in &$local_part_prefix_v$&.
19347
19348 When an address is being verified, &%local_part_prefix%& affects only the
19349 behaviour of the router. If the callout feature of verification is in use, this
19350 means that the full address, including the prefix, will be used during the
19351 callout.
19352
19353 The prefix facility is commonly used to handle local parts of the form
19354 &%owner-something%&. Another common use is to support local parts of the form
19355 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19356 to tell a user their forwarding is broken &-- by placing a router like this one
19357 immediately before the router that handles &_.forward_& files:
19358 .code
19359 real_localuser:
19360   driver = accept
19361   local_part_prefix = real-
19362   check_local_user
19363   transport = local_delivery
19364 .endd
19365 For security, it would probably be a good idea to restrict the use of this
19366 router to locally-generated messages, using a condition such as this:
19367 .code
19368   condition = ${if match {$sender_host_address}\
19369                          {\N^(|127\.0\.0\.1)$\N}}
19370 .endd
19371
19372 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19373 both conditions must be met if not optional. Care must be taken if wildcards
19374 are used in both a prefix and a suffix on the same router. Different
19375 separator characters must be used to avoid ambiguity.
19376
19377
19378 .option local_part_prefix_optional routers boolean false
19379 See &%local_part_prefix%& above.
19380
19381
19382
19383 .option local_part_suffix routers&!? "string list" unset
19384 .cindex "router" "suffix for local part"
19385 .cindex "suffix for local part" "used in router"
19386 This option operates in the same way as &%local_part_prefix%&, except that the
19387 local part must end (rather than start) with the given string, the
19388 &%local_part_suffix_optional%& option determines whether the suffix is
19389 mandatory, and the wildcard * character, if present, must be the last
19390 character of the suffix. This option facility is commonly used to handle local
19391 parts of the form &%something-request%& and multiple user mailboxes of the form
19392 &%username-foo%&.
19393
19394
19395 .option local_part_suffix_optional routers boolean false
19396 See &%local_part_suffix%& above.
19397
19398
19399
19400 .option local_parts routers&!? "local part list&!!" unset
19401 .cindex "router" "restricting to specific local parts"
19402 .cindex "local part" "checking in router"
19403 The router is run only if the local part of the address matches the list.
19404 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19405 are evaluated, and
19406 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19407 string is expanded, it is possible to make it depend on the domain, for
19408 example:
19409 .code
19410 local_parts = dbm;/usr/local/specials/$domain_data
19411 .endd
19412 .vindex "&$local_part_data$&"
19413 If the match is achieved by a lookup, the data that the lookup returned
19414 for the local part is placed in the variable &$local_part_data$& for use in
19415 expansions of the router's private options or in the transport.
19416 You might use this option, for
19417 example, if you have a large number of local virtual domains, and you want to
19418 send all postmaster mail to the same place without having to set up an alias in
19419 each virtual domain:
19420 .code
19421 postmaster:
19422   driver = redirect
19423   local_parts = postmaster
19424   data = postmaster@real.domain.example
19425 .endd
19426
19427
19428 .option log_as_local routers boolean "see below"
19429 .cindex "log" "delivery line"
19430 .cindex "delivery" "log line format"
19431 Exim has two logging styles for delivery, the idea being to make local
19432 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19433 recipient address is given just as the local part, without a domain. The use of
19434 this style is controlled by this option. It defaults to true for the &(accept)&
19435 router, and false for all the others. This option applies only when a
19436 router assigns an address to a transport. It has no effect on routers that
19437 redirect addresses.
19438
19439
19440
19441 .option more routers boolean&!! true
19442 The result of string expansion for this option must be a valid boolean value,
19443 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19444 result causes an error, and delivery is deferred. If the expansion is forced to
19445 fail, the default value for the option (true) is used. Other failures cause
19446 delivery to be deferred.
19447
19448 If this option is set false, and the router declines to handle the address, no
19449 further routers are tried, routing fails, and the address is bounced.
19450 .oindex "&%self%&"
19451 However, if the router explicitly passes an address to the following router by
19452 means of the setting
19453 .code
19454 self = pass
19455 .endd
19456 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19457 does not affect the behaviour if one of the precondition tests fails. In that
19458 case, the address is always passed to the next router.
19459
19460 Note that &%address_data%& is not considered to be a precondition. If its
19461 expansion is forced to fail, the router declines, and the value of &%more%&
19462 controls what happens next.
19463
19464
19465 .option pass_on_timeout routers boolean false
19466 .cindex "timeout" "of router"
19467 .cindex "router" "timeout"
19468 If a router times out during a host lookup, it normally causes deferral of the
19469 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19470 router, overriding &%no_more%&. This may be helpful for systems that are
19471 intermittently connected to the Internet, or those that want to pass to a smart
19472 host any messages that cannot immediately be delivered.
19473
19474 There are occasional other temporary errors that can occur while doing DNS
19475 lookups. They are treated in the same way as a timeout, and this option
19476 applies to all of them.
19477
19478
19479
19480 .option pass_router routers string unset
19481 .cindex "router" "go to after &""pass""&"
19482 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19483 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19484 routing to continue, and overriding a false setting of &%more%&. When one of
19485 these routers returns &"pass"&, the address is normally handed on to the next
19486 router in sequence. This can be changed by setting &%pass_router%& to the name
19487 of another router. However (unlike &%redirect_router%&) the named router must
19488 be below the current router, to avoid loops. Note that this option applies only
19489 to the special case of &"pass"&. It does not apply when a router returns
19490 &"decline"& because it cannot handle an address.
19491
19492
19493
19494 .option redirect_router routers string unset
19495 .cindex "router" "start at after redirection"
19496 Sometimes an administrator knows that it is pointless to reprocess addresses
19497 generated from alias or forward files with the same router again. For
19498 example, if an alias file translates real names into login ids there is no
19499 point searching the alias file a second time, especially if it is a large file.
19500
19501 The &%redirect_router%& option can be set to the name of any router instance.
19502 It causes the routing of any generated addresses to start at the named router
19503 instead of at the first router. This option has no effect if the router in
19504 which it is set does not generate new addresses.
19505
19506
19507
19508 .option require_files routers&!? "string list&!!" unset
19509 .cindex "file" "requiring for router"
19510 .cindex "router" "requiring file existence"
19511 This option provides a general mechanism for predicating the running of a
19512 router on the existence or non-existence of certain files or directories.
19513 Before running a router, as one of its precondition tests, Exim works its way
19514 through the &%require_files%& list, expanding each item separately.
19515
19516 Because the list is split before expansion, any colons in expansion items must
19517 be doubled, or the facility for using a different list separator must be used
19518 (&<<SECTlistsepchange>>&).
19519 If any expansion is forced to fail, the item is ignored. Other expansion
19520 failures cause routing of the address to be deferred.
19521
19522 If any expanded string is empty, it is ignored. Otherwise, except as described
19523 below, each string must be a fully qualified file path, optionally preceded by
19524 &"!"&. The paths are passed to the &[stat()]& function to test for the
19525 existence of the files or directories. The router is skipped if any paths not
19526 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19527
19528 .cindex "NFS"
19529 If &[stat()]& cannot determine whether a file exists or not, delivery of
19530 the message is deferred. This can happen when NFS-mounted filesystems are
19531 unavailable.
19532
19533 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19534 options, so you cannot use it to check for the existence of a file in which to
19535 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19536 full list of the order in which preconditions are evaluated.) However, as
19537 these options are all expanded, you can use the &%exists%& expansion condition
19538 to make such tests. The &%require_files%& option is intended for checking files
19539 that the router may be going to use internally, or which are needed by a
19540 transport (e.g., &_.procmailrc_&).
19541
19542 During delivery, the &[stat()]& function is run as root, but there is a
19543 facility for some checking of the accessibility of a file by another user.
19544 This is not a proper permissions check, but just a &"rough"& check that
19545 operates as follows:
19546
19547 If an item in a &%require_files%& list does not contain any forward slash
19548 characters, it is taken to be the user (and optional group, separated by a
19549 comma) to be checked for subsequent files in the list. If no group is specified
19550 but the user is specified symbolically, the gid associated with the uid is
19551 used. For example:
19552 .code
19553 require_files = mail:/some/file
19554 require_files = $local_part_data:$home/.procmailrc
19555 .endd
19556 If a user or group name in a &%require_files%& list does not exist, the
19557 &%require_files%& condition fails.
19558
19559 Exim performs the check by scanning along the components of the file path, and
19560 checking the access for the given uid and gid. It checks for &"x"& access on
19561 directories, and &"r"& access on the final file. Note that this means that file
19562 access control lists, if the operating system has them, are ignored.
19563
19564 &*Warning 1*&: When the router is being run to verify addresses for an
19565 incoming SMTP message, Exim is not running as root, but under its own uid. This
19566 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19567 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19568 user is not permitted to read one of the directories on the file's path.
19569
19570 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19571 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19572 without root access. In this case, if a check for access by a particular user
19573 is requested, Exim creates a subprocess that runs as that user, and tries the
19574 check again in that process.
19575
19576 The default action for handling an unresolved EACCES is to consider it to
19577 be caused by a configuration error, and routing is deferred because the
19578 existence or non-existence of the file cannot be determined. However, in some
19579 circumstances it may be desirable to treat this condition as if the file did
19580 not exist. If the filename (or the exclamation mark that precedes the filename
19581 for non-existence) is preceded by a plus sign, the EACCES error is treated
19582 as if the file did not exist. For example:
19583 .code
19584 require_files = +/some/file
19585 .endd
19586 If the router is not an essential part of verification (for example, it
19587 handles users' &_.forward_& files), another solution is to set the &%verify%&
19588 option false so that the router is skipped when verifying.
19589
19590
19591
19592 .option retry_use_local_part routers boolean "see below"
19593 .cindex "hints database" "retry keys"
19594 .cindex "local part" "in retry keys"
19595 When a delivery suffers a temporary routing failure, a retry record is created
19596 in Exim's hints database. For addresses whose routing depends only on the
19597 domain, the key for the retry record should not involve the local part, but for
19598 other addresses, both the domain and the local part should be included.
19599 Usually, remote routing is of the former kind, and local routing is of the
19600 latter kind.
19601
19602 This option controls whether the local part is used to form the key for retry
19603 hints for addresses that suffer temporary errors while being handled by this
19604 router. The default value is true for any router that has any of
19605 &%check_local_user%&,
19606 &%local_parts%&,
19607 &%condition%&,
19608 &%local_part_prefix%&,
19609 &%local_part_suffix%&,
19610 &%senders%& or
19611 &%require_files%&
19612 set, and false otherwise. Note that this option does not apply to hints keys
19613 for transport delays; they are controlled by a generic transport option of the
19614 same name.
19615
19616 Failing to set this option when it is needed
19617 (because a remote router handles only some of the local-parts for a domain)
19618 can result in incorrect error messages being generated.
19619
19620 The setting of &%retry_use_local_part%& applies only to the router on which it
19621 appears. If the router generates child addresses, they are routed
19622 independently; this setting does not become attached to them.
19623
19624
19625
19626 .option router_home_directory routers string&!! unset
19627 .cindex "router" "home directory for"
19628 .cindex "home directory" "for router"
19629 .vindex "&$home$&"
19630 This option sets a home directory for use while the router is running. (Compare
19631 &%transport_home_directory%&, which sets a home directory for later
19632 transporting.) In particular, if used on a &(redirect)& router, this option
19633 sets a value for &$home$& while a filter is running. The value is expanded;
19634 forced expansion failure causes the option to be ignored &-- other failures
19635 cause the router to defer.
19636
19637 Expansion of &%router_home_directory%& happens immediately after the
19638 &%check_local_user%& test (if configured), before any further expansions take
19639 place.
19640 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19641 are evaluated.)
19642 While the router is running, &%router_home_directory%& overrides the value of
19643 &$home$& that came from &%check_local_user%&.
19644
19645 When a router accepts an address and assigns it to a local transport (including
19646 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19647 delivery), the home directory setting for the transport is taken from the first
19648 of these values that is set:
19649
19650 .ilist
19651 The &%home_directory%& option on the transport;
19652 .next
19653 The &%transport_home_directory%& option on the router;
19654 .next
19655 The password data if &%check_local_user%& is set on the router;
19656 .next
19657 The &%router_home_directory%& option on the router.
19658 .endlist
19659
19660 In other words, &%router_home_directory%& overrides the password data for the
19661 router, but not for the transport.
19662
19663
19664
19665 .option self routers string freeze
19666 .cindex "MX record" "pointing to local host"
19667 .cindex "local host" "MX pointing to"
19668 This option applies to those routers that use a recipient address to find a
19669 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19670 and &(manualroute)& routers.
19671 Certain configurations of the &(queryprogram)& router can also specify a list
19672 of remote hosts.
19673 Usually such routers are configured to send the message to a remote host via an
19674 &(smtp)& transport. The &%self%& option specifies what happens when the first
19675 host on the list turns out to be the local host.
19676 The way in which Exim checks for the local host is described in section
19677 &<<SECTreclocipadd>>&.
19678
19679 Normally this situation indicates either an error in Exim's configuration (for
19680 example, the router should be configured not to process this domain), or an
19681 error in the DNS (for example, the MX should not point to this host). For this
19682 reason, the default action is to log the incident, defer the address, and
19683 freeze the message. The following alternatives are provided for use in special
19684 cases:
19685
19686 .vlist
19687 .vitem &%defer%&
19688 Delivery of the message is tried again later, but the message is not frozen.
19689
19690 .vitem "&%reroute%&: <&'domain'&>"
19691 The domain is changed to the given domain, and the address is passed back to
19692 be reprocessed by the routers. No rewriting of headers takes place. This
19693 behaviour is essentially a redirection.
19694
19695 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19696 The domain is changed to the given domain, and the address is passed back to be
19697 reprocessed by the routers. Any headers that contain the original domain are
19698 rewritten.
19699
19700 .vitem &%pass%&
19701 .oindex "&%more%&"
19702 .vindex "&$self_hostname$&"
19703 The router passes the address to the next router, or to the router named in the
19704 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19705 subsequent routing and delivery, the variable &$self_hostname$& contains the
19706 name of the local host that the router encountered. This can be used to
19707 distinguish between different cases for hosts with multiple names. The
19708 combination
19709 .code
19710 self = pass
19711 no_more
19712 .endd
19713 ensures that only those addresses that routed to the local host are passed on.
19714 Without &%no_more%&, addresses that were declined for other reasons would also
19715 be passed to the next router.
19716
19717 .vitem &%fail%&
19718 Delivery fails and an error report is generated.
19719
19720 .vitem &%send%&
19721 .cindex "local host" "sending to"
19722 The anomaly is ignored and the address is queued for the transport. This
19723 setting should be used with extreme caution. For an &(smtp)& transport, it
19724 makes sense only in cases where the program that is listening on the SMTP port
19725 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19726 different configuration file that handles the domain in another way.
19727 .endlist
19728
19729
19730
19731 .option senders routers&!? "address list&!!" unset
19732 .cindex "router" "checking senders"
19733 If this option is set, the router is skipped unless the message's sender
19734 address matches something on the list.
19735 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19736 are evaluated.
19737
19738 There are issues concerning verification when the running of routers is
19739 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19740 setting, it sets the sender to the null string. When using the &%-bt%& option
19741 to check a configuration file, it is necessary also to use the &%-f%& option to
19742 set an appropriate sender. For incoming mail, the sender is unset when
19743 verifying the sender, but is available when verifying any recipients. If the
19744 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19745 matters.
19746
19747
19748 .option set routers "string list" unset
19749 .cindex router variables
19750 This option may be used multiple times on a router;
19751 because of this the list aspect is mostly irrelevant.
19752 The list separator is a semicolon but can be changed in the
19753 usual way.
19754
19755 Each list-element given must be of the form &"name = value"&
19756 and the names used must start with the string &"r_"&.
19757 Values containing a list-separator should have them doubled.
19758 When a router runs, the strings are evaluated in order,
19759 to create variables which are added to the set associated with
19760 the address.
19761 This is done immediately after all the preconditions, before the
19762 evaluation of the &%address_data%& option.
19763 The variable is set with the expansion of the value.
19764 The variables can be used by the router options
19765 (not including any preconditions)
19766 and by the transport.
19767 Later definitions of a given named variable will override former ones.
19768 Variable use is via the usual &$r_...$& syntax.
19769
19770 This is similar to the &%address_data%& option, except that
19771 many independent variables can be used, with choice of naming.
19772
19773
19774 .option translate_ip_address routers string&!! unset
19775 .cindex "IP address" "translating"
19776 .cindex "packet radio"
19777 .cindex "router" "IP address translation"
19778 There exist some rare networking situations (for example, packet radio) where
19779 it is helpful to be able to translate IP addresses generated by normal routing
19780 mechanisms into other IP addresses, thus performing a kind of manual IP
19781 routing. This should be done only if the normal IP routing of the TCP/IP stack
19782 is inadequate or broken. Because this is an extremely uncommon requirement, the
19783 code to support this option is not included in the Exim binary unless
19784 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19785
19786 .vindex "&$host_address$&"
19787 The &%translate_ip_address%& string is expanded for every IP address generated
19788 by the router, with the generated address set in &$host_address$&. If the
19789 expansion is forced to fail, no action is taken.
19790 For any other expansion error, delivery of the message is deferred.
19791 If the result of the expansion is an IP address, that replaces the original
19792 address; otherwise the result is assumed to be a host name &-- this is looked
19793 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19794 produce one or more replacement IP addresses. For example, to subvert all IP
19795 addresses in some specific networks, this could be added to a router:
19796 .code
19797 translate_ip_address = \
19798   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19799     {$value}fail}}
19800 .endd
19801 The file would contain lines like
19802 .code
19803 10.2.3.128/26    some.host
19804 10.8.4.34/26     10.44.8.15
19805 .endd
19806 You should not make use of this facility unless you really understand what you
19807 are doing.
19808
19809
19810
19811 .option transport routers string&!! unset
19812 This option specifies the transport to be used when a router accepts an address
19813 and sets it up for delivery. A transport is never needed if a router is used
19814 only for verification. The value of the option is expanded at routing time,
19815 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19816 and result must be the name of one of the configured transports. If it is not,
19817 delivery is deferred.
19818
19819 The &%transport%& option is not used by the &(redirect)& router, but it does
19820 have some private options that set up transports for pipe and file deliveries
19821 (see chapter &<<CHAPredirect>>&).
19822
19823
19824
19825 .option transport_current_directory routers string&!! unset
19826 .cindex "current directory for local transport"
19827 This option associates a current directory with any address that is routed
19828 to a local transport. This can happen either because a transport is
19829 explicitly configured for the router, or because it generates a delivery to a
19830 file or a pipe. During the delivery process (that is, at transport time), this
19831 option string is expanded and is set as the current directory, unless
19832 overridden by a setting on the transport.
19833 If the expansion fails for any reason, including forced failure, an error is
19834 logged, and delivery is deferred.
19835 See chapter &<<CHAPenvironment>>& for details of the local delivery
19836 environment.
19837
19838
19839
19840
19841 .option transport_home_directory routers string&!! "see below"
19842 .cindex "home directory" "for local transport"
19843 This option associates a home directory with any address that is routed to a
19844 local transport. This can happen either because a transport is explicitly
19845 configured for the router, or because it generates a delivery to a file or a
19846 pipe. During the delivery process (that is, at transport time), the option
19847 string is expanded and is set as the home directory, unless overridden by a
19848 setting of &%home_directory%& on the transport.
19849 If the expansion fails for any reason, including forced failure, an error is
19850 logged, and delivery is deferred.
19851
19852 If the transport does not specify a home directory, and
19853 &%transport_home_directory%& is not set for the router, the home directory for
19854 the transport is taken from the password data if &%check_local_user%& is set for
19855 the router. Otherwise it is taken from &%router_home_directory%& if that option
19856 is set; if not, no home directory is set for the transport.
19857
19858 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19859 environment.
19860
19861
19862
19863
19864 .option unseen routers boolean&!! false
19865 .cindex "router" "carrying on after success"
19866 The result of string expansion for this option must be a valid boolean value,
19867 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19868 result causes an error, and delivery is deferred. If the expansion is forced to
19869 fail, the default value for the option (false) is used. Other failures cause
19870 delivery to be deferred.
19871
19872 When this option is set true, routing does not cease if the router accepts the
19873 address. Instead, a copy of the incoming address is passed to the next router,
19874 overriding a false setting of &%more%&. There is little point in setting
19875 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19876 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19877 sometimes true and sometimes false).
19878
19879 .cindex "copy of message (&%unseen%& option)"
19880 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19881 qualifier in filter files. It can be used to cause copies of messages to be
19882 delivered to some other destination, while also carrying out a normal delivery.
19883 In effect, the current address is made into a &"parent"& that has two children
19884 &-- one that is delivered as specified by this router, and a clone that goes on
19885 to be routed further. For this reason, &%unseen%& may not be combined with the
19886 &%one_time%& option in a &(redirect)& router.
19887
19888 &*Warning*&: Header lines added to the address (or specified for removal) by
19889 this router or by previous routers affect the &"unseen"& copy of the message
19890 only. The clone that continues to be processed by further routers starts with
19891 no added headers and none specified for removal. For a &%redirect%& router, if
19892 a generated address is the same as the incoming address, this can lead to
19893 duplicate addresses with different header modifications. Exim does not do
19894 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19895 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19896 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19897 &%redirect%& router may be of help.
19898
19899 Unlike the handling of header modifications, any data that was set by the
19900 &%address_data%& option in the current or previous routers &'is'& passed on to
19901 subsequent routers.
19902
19903
19904 .option user routers string&!! "see below"
19905 .cindex "uid (user id)" "local delivery"
19906 .cindex "local transports" "uid and gid"
19907 .cindex "transport" "local"
19908 .cindex "router" "user for filter processing"
19909 .cindex "filter" "user for processing"
19910 When a router queues an address for a transport, and the transport does not
19911 specify a user, the user given here is used when running the delivery process.
19912 The user may be specified numerically or by name. If expansion fails, the
19913 error is logged and delivery is deferred.
19914 This user is also used by the &(redirect)& router when running a filter file.
19915 The default is unset, except when &%check_local_user%& is set. In this case,
19916 the default is taken from the password information. If the user is specified as
19917 a name, and &%group%& is not set, the group associated with the user is used.
19918 See also &%initgroups%& and &%group%& and the discussion in chapter
19919 &<<CHAPenvironment>>&.
19920
19921
19922
19923 .option verify routers&!? boolean true
19924 Setting this option has the effect of setting &%verify_sender%& and
19925 &%verify_recipient%& to the same value.
19926
19927
19928 .option verify_only routers&!? boolean false
19929 .cindex "EXPN" "with &%verify_only%&"
19930 .oindex "&%-bv%&"
19931 .cindex "router" "used only when verifying"
19932 If this option is set, the router is used only when verifying an address,
19933 delivering in cutthrough mode or
19934 testing with the &%-bv%& option, not when actually doing a delivery, testing
19935 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19936 restricted to verifying only senders or recipients by means of
19937 &%verify_sender%& and &%verify_recipient%&.
19938
19939 &*Warning*&: When the router is being run to verify addresses for an incoming
19940 SMTP message, Exim is not running as root, but under its own uid. If the router
19941 accesses any files, you need to make sure that they are accessible to the Exim
19942 user or group.
19943
19944
19945 .option verify_recipient routers&!? boolean true
19946 If this option is false, the router is skipped when verifying recipient
19947 addresses,
19948 delivering in cutthrough mode
19949 or testing recipient verification using &%-bv%&.
19950 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19951 are evaluated.
19952 See also the &$verify_mode$& variable.
19953
19954
19955 .option verify_sender routers&!? boolean true
19956 If this option is false, the router is skipped when verifying sender addresses
19957 or testing sender verification using &%-bvs%&.
19958 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19959 are evaluated.
19960 See also the &$verify_mode$& variable.
19961 .ecindex IIDgenoprou1
19962 .ecindex IIDgenoprou2
19963
19964
19965
19966
19967
19968
19969 . ////////////////////////////////////////////////////////////////////////////
19970 . ////////////////////////////////////////////////////////////////////////////
19971
19972 .chapter "The accept router" "CHID4"
19973 .cindex "&(accept)& router"
19974 .cindex "routers" "&(accept)&"
19975 The &(accept)& router has no private options of its own. Unless it is being
19976 used purely for verification (see &%verify_only%&) a transport is required to
19977 be defined by the generic &%transport%& option. If the preconditions that are
19978 specified by generic options are met, the router accepts the address and queues
19979 it for the given transport. The most common use of this router is for setting
19980 up deliveries to local mailboxes. For example:
19981 .code
19982 localusers:
19983   driver = accept
19984   domains = mydomain.example
19985   check_local_user
19986   transport = local_delivery
19987 .endd
19988 The &%domains%& condition in this example checks the domain of the address, and
19989 &%check_local_user%& checks that the local part is the login of a local user.
19990 When both preconditions are met, the &(accept)& router runs, and queues the
19991 address for the &(local_delivery)& transport.
19992
19993
19994
19995
19996
19997
19998 . ////////////////////////////////////////////////////////////////////////////
19999 . ////////////////////////////////////////////////////////////////////////////
20000
20001 .chapter "The dnslookup router" "CHAPdnslookup"
20002 .scindex IIDdnsrou1 "&(dnslookup)& router"
20003 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
20004 The &(dnslookup)& router looks up the hosts that handle mail for the
20005 recipient's domain in the DNS. A transport must always be set for this router,
20006 unless &%verify_only%& is set.
20007
20008 If SRV support is configured (see &%check_srv%& below), Exim first searches for
20009 SRV records. If none are found, or if SRV support is not configured,
20010 MX records are looked up. If no MX records exist, address records are sought.
20011 However, &%mx_domains%& can be set to disable the direct use of address
20012 records.
20013
20014 MX records of equal priority are sorted by Exim into a random order. Exim then
20015 looks for address records for the host names obtained from MX or SRV records.
20016 When a host has more than one IP address, they are sorted into a random order,
20017 except that IPv6 addresses are sorted before IPv4 addresses. If all the
20018 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
20019 generic option, the router declines.
20020
20021 Unless they have the highest priority (lowest MX value), MX records that point
20022 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
20023 are discarded, together with any other MX records of equal or lower priority.
20024
20025 .cindex "MX record" "pointing to local host"
20026 .cindex "local host" "MX pointing to"
20027 .oindex "&%self%&" "in &(dnslookup)& router"
20028 If the host pointed to by the highest priority MX record, or looked up as an
20029 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20030 happens is controlled by the generic &%self%& option.
20031
20032
20033 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20034 There have been problems with DNS servers when SRV records are looked up.
20035 Some misbehaving servers return a DNS error or timeout when a non-existent
20036 SRV record is sought. Similar problems have in the past been reported for
20037 MX records. The global &%dns_again_means_nonexist%& option can help with this
20038 problem, but it is heavy-handed because it is a global option.
20039
20040 For this reason, there are two options, &%srv_fail_domains%& and
20041 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20042 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20043 an attempt to look up an SRV or MX record causes one of these results, and the
20044 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20045 such record"&. In the case of an SRV lookup, this means that the router
20046 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20047 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20048 case routing fails.
20049
20050
20051 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20052 .cindex "&(dnslookup)& router" "declines"
20053 There are a few cases where a &(dnslookup)& router will decline to accept
20054 an address; if such a router is expected to handle "all remaining non-local
20055 domains", then it is important to set &%no_more%&.
20056
20057 The router will defer rather than decline if the domain
20058 is found in the &%fail_defer_domains%& router option.
20059
20060 Reasons for a &(dnslookup)& router to decline currently include:
20061 .ilist
20062 The domain does not exist in DNS
20063 .next
20064 The domain exists but the MX record's host part is just "."; this is a common
20065 convention (borrowed from SRV) used to indicate that there is no such service
20066 for this domain and to not fall back to trying A/AAAA records.
20067 .next
20068 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20069 .next
20070 MX record points to a non-existent host.
20071 .next
20072 MX record points to an IP address and the main section option
20073 &%allow_mx_to_ip%& is not set.
20074 .next
20075 MX records exist and point to valid hosts, but all hosts resolve only to
20076 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20077 .next
20078 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20079 &%dns_check_names_pattern%& for handling one variant of this)
20080 .next
20081 &%check_secondary_mx%& is set on this router but the local host can
20082 not be found in the MX records (see below)
20083 .endlist
20084
20085
20086
20087
20088 .section "Private options for dnslookup" "SECID118"
20089 .cindex "options" "&(dnslookup)& router"
20090 The private options for the &(dnslookup)& router are as follows:
20091
20092 .option check_secondary_mx dnslookup boolean false
20093 .cindex "MX record" "checking for secondary"
20094 If this option is set, the router declines unless the local host is found in
20095 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20096 process domains for which the local host is a secondary mail exchanger
20097 differently to other domains. The way in which Exim decides whether a host is
20098 the local host is described in section &<<SECTreclocipadd>>&.
20099
20100
20101 .option check_srv dnslookup string&!! unset
20102 .cindex "SRV record" "enabling use of"
20103 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20104 addition to MX and address records. The support is disabled by default. To
20105 enable SRV support, set the &%check_srv%& option to the name of the service
20106 required. For example,
20107 .code
20108 check_srv = smtp
20109 .endd
20110 looks for SRV records that refer to the normal smtp service. The option is
20111 expanded, so the service name can vary from message to message or address
20112 to address. This might be helpful if SRV records are being used for a
20113 submission service. If the expansion is forced to fail, the &%check_srv%&
20114 option is ignored, and the router proceeds to look for MX records in the
20115 normal way.
20116
20117 When the expansion succeeds, the router searches first for SRV records for
20118 the given service (it assumes TCP protocol). A single SRV record with a
20119 host name that consists of just a single dot indicates &"no such service for
20120 this domain"&; if this is encountered, the router declines. If other kinds of
20121 SRV record are found, they are used to construct a host list for delivery
20122 according to the rules of RFC 2782. MX records are not sought in this case.
20123
20124 When no SRV records are found, MX records (and address records) are sought in
20125 the traditional way. In other words, SRV records take precedence over MX
20126 records, just as MX records take precedence over address records. Note that
20127 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20128 defined it. It is apparently believed that MX records are sufficient for email
20129 and that SRV records should not be used for this purpose. However, SRV records
20130 have an additional &"weight"& feature which some people might find useful when
20131 trying to split an SMTP load between hosts of different power.
20132
20133 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20134 when there is a DNS lookup error.
20135
20136
20137
20138
20139 .option fail_defer_domains dnslookup "domain list&!!" unset
20140 .cindex "MX record" "not found"
20141 DNS lookups for domains matching &%fail_defer_domains%&
20142 which find no matching record will cause the router to defer
20143 rather than the default behaviour of decline.
20144 This maybe be useful for queueing messages for a newly created
20145 domain while the DNS configuration is not ready.
20146 However, it will result in any message with mistyped domains
20147 also being queued.
20148
20149
20150 .option ipv4_only "string&!!" unset
20151 .cindex IPv6 disabling
20152 .cindex DNS "IPv6 disabling"
20153 The string is expanded, and if the result is anything but a forced failure,
20154 or an empty string, or one of the strings “0” or “no” or “false”
20155 (checked without regard to the case of the letters),
20156 only A records are used.
20157
20158 .option ipv4_prefer "string&!!" unset
20159 .cindex IPv4 preference
20160 .cindex DNS "IPv4 preference"
20161 The string is expanded, and if the result is anything but a forced failure,
20162 or an empty string, or one of the strings “0” or “no” or “false”
20163 (checked without regard to the case of the letters),
20164 A records are sorted before AAAA records (inverting the default).
20165
20166 .option mx_domains dnslookup "domain list&!!" unset
20167 .cindex "MX record" "required to exist"
20168 .cindex "SRV record" "required to exist"
20169 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20170 record in order to be recognized. (The name of this option could be improved.)
20171 For example, if all the mail hosts in &'fict.example'& are known to have MX
20172 records, except for those in &'discworld.fict.example'&, you could use this
20173 setting:
20174 .code
20175 mx_domains = ! *.discworld.fict.example : *.fict.example
20176 .endd
20177 This specifies that messages addressed to a domain that matches the list but
20178 has no MX record should be bounced immediately instead of being routed using
20179 the address record.
20180
20181
20182 .option mx_fail_domains dnslookup "domain list&!!" unset
20183 If the DNS lookup for MX records for one of the domains in this list causes a
20184 DNS lookup error, Exim behaves as if no MX records were found. See section
20185 &<<SECTprowitdnsloo>>& for more discussion.
20186
20187
20188
20189
20190 .option qualify_single dnslookup boolean true
20191 .cindex "DNS" "resolver options"
20192 .cindex "DNS" "qualifying single-component names"
20193 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20194 lookups. Typically, but not standardly, this causes the resolver to qualify
20195 single-component names with the default domain. For example, on a machine
20196 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20197 &'thesaurus.ref.example'& inside the resolver. For details of what your
20198 resolver actually does, consult your man pages for &'resolver'& and
20199 &'resolv.conf'&.
20200
20201
20202
20203 .option rewrite_headers dnslookup boolean true
20204 .cindex "rewriting" "header lines"
20205 .cindex "header lines" "rewriting"
20206 If the domain name in the address that is being processed is not fully
20207 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20208 an address is specified as &'dormouse@teaparty'&, the domain might be
20209 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20210 occur as a result of setting the &%widen_domains%& option. If
20211 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20212 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20213 header lines of the message are rewritten with the full domain name.
20214
20215 This option should be turned off only when it is known that no message is
20216 ever going to be sent outside an environment where the abbreviation makes
20217 sense.
20218
20219 When an MX record is looked up in the DNS and matches a wildcard record, name
20220 servers normally return a record containing the name that has been looked up,
20221 making it impossible to detect whether a wildcard was present or not. However,
20222 some name servers have recently been seen to return the wildcard entry. If the
20223 name returned by a DNS lookup begins with an asterisk, it is not used for
20224 header rewriting.
20225
20226
20227 .option same_domain_copy_routing dnslookup boolean false
20228 .cindex "address" "copying routing"
20229 Addresses with the same domain are normally routed by the &(dnslookup)& router
20230 to the same list of hosts. However, this cannot be presumed, because the router
20231 options and preconditions may refer to the local part of the address. By
20232 default, therefore, Exim routes each address in a message independently. DNS
20233 servers run caches, so repeated DNS lookups are not normally expensive, and in
20234 any case, personal messages rarely have more than a few recipients.
20235
20236 If you are running mailing lists with large numbers of subscribers at the same
20237 domain, and you are using a &(dnslookup)& router which is independent of the
20238 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20239 lookups for identical domains in one message. In this case, when &(dnslookup)&
20240 routes an address to a remote transport, any other unrouted addresses in the
20241 message that have the same domain are automatically given the same routing
20242 without processing them independently,
20243 provided the following conditions are met:
20244
20245 .ilist
20246 No router that processed the address specified &%headers_add%& or
20247 &%headers_remove%&.
20248 .next
20249 The router did not change the address in any way, for example, by &"widening"&
20250 the domain.
20251 .endlist
20252
20253
20254
20255
20256 .option search_parents dnslookup boolean false
20257 .cindex "DNS" "resolver options"
20258 When this option is true, the resolver option RES_DNSRCH is set for DNS
20259 lookups. This is different from the &%qualify_single%& option in that it
20260 applies to domains containing dots. Typically, but not standardly, it causes
20261 the resolver to search for the name in the current domain and in parent
20262 domains. For example, on a machine in the &'fict.example'& domain, if looking
20263 up &'teaparty.wonderland'& failed, the resolver would try
20264 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20265 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20266
20267 Setting this option true can cause problems in domains that have a wildcard MX
20268 record, because any domain that does not have its own MX record matches the
20269 local wildcard.
20270
20271
20272
20273 .option srv_fail_domains dnslookup "domain list&!!" unset
20274 If the DNS lookup for SRV records for one of the domains in this list causes a
20275 DNS lookup error, Exim behaves as if no SRV records were found. See section
20276 &<<SECTprowitdnsloo>>& for more discussion.
20277
20278
20279
20280
20281 .option widen_domains dnslookup "string list" unset
20282 .cindex "domain" "partial; widening"
20283 If a DNS lookup fails and this option is set, each of its strings in turn is
20284 added onto the end of the domain, and the lookup is tried again. For example,
20285 if
20286 .code
20287 widen_domains = fict.example:ref.example
20288 .endd
20289 is set and a lookup of &'klingon.dictionary'& fails,
20290 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20291 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20292 and &%search_parents%& options can cause some widening to be undertaken inside
20293 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20294 when verifying, unless &%rewrite_headers%& is false (not the default).
20295
20296
20297 .section "Effect of qualify_single and search_parents" "SECID119"
20298 When a domain from an envelope recipient is changed by the resolver as a result
20299 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20300 corresponding address in the message's header lines unless &%rewrite_headers%&
20301 is set false. Exim then re-routes the address, using the full domain.
20302
20303 These two options affect only the DNS lookup that takes place inside the router
20304 for the domain of the address that is being routed. They do not affect lookups
20305 such as that implied by
20306 .code
20307 domains = @mx_any
20308 .endd
20309 that may happen while processing a router precondition before the router is
20310 entered. No widening ever takes place for these lookups.
20311 .ecindex IIDdnsrou1
20312 .ecindex IIDdnsrou2
20313
20314
20315
20316
20317
20318
20319
20320
20321
20322 . ////////////////////////////////////////////////////////////////////////////
20323 . ////////////////////////////////////////////////////////////////////////////
20324
20325 .chapter "The ipliteral router" "CHID5"
20326 .cindex "&(ipliteral)& router"
20327 .cindex "domain literal" "routing"
20328 .cindex "routers" "&(ipliteral)&"
20329 This router has no private options. Unless it is being used purely for
20330 verification (see &%verify_only%&) a transport is required to be defined by the
20331 generic &%transport%& option. The router accepts the address if its domain part
20332 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20333 router handles the address
20334 .code
20335 root@[192.168.1.1]
20336 .endd
20337 by setting up delivery to the host with that IP address. IPv4 domain literals
20338 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20339 are similar, but the address is preceded by &`ipv6:`&. For example:
20340 .code
20341 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20342 .endd
20343 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20344 grounds that sooner or later somebody will try it.
20345
20346 .oindex "&%self%&" "in &(ipliteral)& router"
20347 If the IP address matches something in &%ignore_target_hosts%&, the router
20348 declines. If an IP literal turns out to refer to the local host, the generic
20349 &%self%& option determines what happens.
20350
20351 The RFCs require support for domain literals; however, their use is
20352 controversial in today's Internet. If you want to use this router, you must
20353 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20354 Exim will not recognize the domain literal syntax in addresses.
20355
20356
20357
20358 . ////////////////////////////////////////////////////////////////////////////
20359 . ////////////////////////////////////////////////////////////////////////////
20360
20361 .chapter "The iplookup router" "CHID6"
20362 .cindex "&(iplookup)& router"
20363 .cindex "routers" "&(iplookup)&"
20364 The &(iplookup)& router was written to fulfil a specific requirement in
20365 Cambridge University (which in fact no longer exists). For this reason, it is
20366 not included in the binary of Exim by default. If you want to include it, you
20367 must set
20368 .code
20369 ROUTER_IPLOOKUP=yes
20370 .endd
20371 in your &_Local/Makefile_& configuration file.
20372
20373 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20374 connection to one or more specific hosts. The host can then return the same or
20375 a different address &-- in effect rewriting the recipient address in the
20376 message's envelope. The new address is then passed on to subsequent routers. If
20377 this process fails, the address can be passed on to other routers, or delivery
20378 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20379 must not be specified for it.
20380
20381 .cindex "options" "&(iplookup)& router"
20382 .option hosts iplookup string unset
20383 This option must be supplied. Its value is a colon-separated list of host
20384 names. The hosts are looked up using &[gethostbyname()]&
20385 (or &[getipnodebyname()]& when available)
20386 and are tried in order until one responds to the query. If none respond, what
20387 happens is controlled by &%optional%&.
20388
20389
20390 .option optional iplookup boolean false
20391 If &%optional%& is true, if no response is obtained from any host, the address
20392 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20393 delivery to the address is deferred.
20394
20395
20396 .option port iplookup integer 0
20397 .cindex "port" "&(iplookup)& router"
20398 This option must be supplied. It specifies the port number for the TCP or UDP
20399 call.
20400
20401
20402 .option protocol iplookup string udp
20403 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20404 protocols is to be used.
20405
20406
20407 .option query iplookup string&!! "see below"
20408 This defines the content of the query that is sent to the remote hosts. The
20409 default value is:
20410 .code
20411 $local_part@$domain $local_part@$domain
20412 .endd
20413 The repetition serves as a way of checking that a response is to the correct
20414 query in the default case (see &%response_pattern%& below).
20415
20416
20417 .option reroute iplookup string&!! unset
20418 If this option is not set, the rerouted address is precisely the byte string
20419 returned by the remote host, up to the first white space, if any. If set, the
20420 string is expanded to form the rerouted address. It can include parts matched
20421 in the response by &%response_pattern%& by means of numeric variables such as
20422 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20423 whether or not a pattern is in use. In all cases, the rerouted address must end
20424 up in the form &'local_part@domain'&.
20425
20426
20427 .option response_pattern iplookup string unset
20428 This option can be set to a regular expression that is applied to the string
20429 returned from the remote host. If the pattern does not match the response, the
20430 router declines. If &%response_pattern%& is not set, no checking of the
20431 response is done, unless the query was defaulted, in which case there is a
20432 check that the text returned after the first white space is the original
20433 address. This checks that the answer that has been received is in response to
20434 the correct question. For example, if the response is just a new domain, the
20435 following could be used:
20436 .code
20437 response_pattern = ^([^@]+)$
20438 reroute = $local_part@$1
20439 .endd
20440
20441 .option timeout iplookup time 5s
20442 This specifies the amount of time to wait for a response from the remote
20443 machine. The same timeout is used for the &[connect()]& function for a TCP
20444 call. It does not apply to UDP.
20445
20446
20447
20448
20449 . ////////////////////////////////////////////////////////////////////////////
20450 . ////////////////////////////////////////////////////////////////////////////
20451
20452 .chapter "The manualroute router" "CHID7"
20453 .scindex IIDmanrou1 "&(manualroute)& router"
20454 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20455 .cindex "domain" "manually routing"
20456 The &(manualroute)& router is so-called because it provides a way of manually
20457 routing an address according to its domain. It is mainly used when you want to
20458 route addresses to remote hosts according to your own rules, bypassing the
20459 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20460 route to local transports, a facility that may be useful if you want to save
20461 messages for dial-in hosts in local files.
20462
20463 The &(manualroute)& router compares a list of domain patterns with the domain
20464 it is trying to route. If there is no match, the router declines. Each pattern
20465 has associated with it a list of hosts and some other optional data, which may
20466 include a transport. The combination of a pattern and its data is called a
20467 &"routing rule"&. For patterns that do not have an associated transport, the
20468 generic &%transport%& option must specify a transport, unless the router is
20469 being used purely for verification (see &%verify_only%&).
20470
20471 .vindex "&$host$&"
20472 In the case of verification, matching the domain pattern is sufficient for the
20473 router to accept the address. When actually routing an address for delivery,
20474 an address that matches a domain pattern is queued for the associated
20475 transport. If the transport is not a local one, a host list must be associated
20476 with the pattern; IP addresses are looked up for the hosts, and these are
20477 passed to the transport along with the mail address. For local transports, a
20478 host list is optional. If it is present, it is passed in &$host$& as a single
20479 text string.
20480
20481 The list of routing rules can be provided as an inline string in
20482 &%route_list%&, or the data can be obtained by looking up the domain in a file
20483 or database by setting &%route_data%&. Only one of these settings may appear in
20484 any one instance of &(manualroute)&. The format of routing rules is described
20485 below, following the list of private options.
20486
20487
20488 .section "Private options for manualroute" "SECTprioptman"
20489
20490 .cindex "options" "&(manualroute)& router"
20491 The private options for the &(manualroute)& router are as follows:
20492
20493 .option host_all_ignored manualroute string defer
20494 See &%host_find_failed%&.
20495
20496 .option host_find_failed manualroute string freeze
20497 This option controls what happens when &(manualroute)& tries to find an IP
20498 address for a host, and the host does not exist. The option can be set to one
20499 of the following values:
20500 .code
20501 decline
20502 defer
20503 fail
20504 freeze
20505 ignore
20506 pass
20507 .endd
20508 The default (&"freeze"&) assumes that this state is a serious configuration
20509 error. The difference between &"pass"& and &"decline"& is that the former
20510 forces the address to be passed to the next router (or the router defined by
20511 &%pass_router%&),
20512 .oindex "&%more%&"
20513 overriding &%no_more%&, whereas the latter passes the address to the next
20514 router only if &%more%& is true.
20515
20516 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20517 cannot be found. If all the hosts in the list are ignored, the behaviour is
20518 controlled by the &%host_all_ignored%& option. This takes the same values
20519 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20520
20521 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20522 state; if a host lookup gets a temporary error, delivery is deferred unless the
20523 generic &%pass_on_timeout%& option is set.
20524
20525
20526 .option hosts_randomize manualroute boolean false
20527 .cindex "randomized host list"
20528 .cindex "host" "list of; randomized"
20529 If this option is set, the order of the items in a host list in a routing rule
20530 is randomized each time the list is used, unless an option in the routing rule
20531 overrides (see below). Randomizing the order of a host list can be used to do
20532 crude load sharing. However, if more than one mail address is routed by the
20533 same router to the same host list, the host lists are considered to be the same
20534 (even though they may be randomized into different orders) for the purpose of
20535 deciding whether to batch the deliveries into a single SMTP transaction.
20536
20537 When &%hosts_randomize%& is true, a host list may be split
20538 into groups whose order is separately randomized. This makes it possible to
20539 set up MX-like behaviour. The boundaries between groups are indicated by an
20540 item that is just &`+`& in the host list. For example:
20541 .code
20542 route_list = * host1:host2:host3:+:host4:host5
20543 .endd
20544 The order of the first three hosts and the order of the last two hosts is
20545 randomized for each use, but the first three always end up before the last two.
20546 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20547 randomized host list is passed to an &(smtp)& transport that also has
20548 &%hosts_randomize set%&, the list is not re-randomized.
20549
20550
20551 .option route_data manualroute string&!! unset
20552 If this option is set, it must expand to yield the data part of a routing rule.
20553 Typically, the expansion string includes a lookup based on the domain. For
20554 example:
20555 .code
20556 route_data = ${lookup{$domain}dbm{/etc/routes}}
20557 .endd
20558 If the expansion is forced to fail, or the result is an empty string, the
20559 router declines. Other kinds of expansion failure cause delivery to be
20560 deferred.
20561
20562
20563 .option route_list manualroute "string list" unset
20564 This string is a list of routing rules, in the form defined below. Note that,
20565 unlike most string lists, the items are separated by semicolons. This is so
20566 that they may contain colon-separated host lists.
20567
20568
20569 .option same_domain_copy_routing manualroute boolean false
20570 .cindex "address" "copying routing"
20571 Addresses with the same domain are normally routed by the &(manualroute)&
20572 router to the same list of hosts. However, this cannot be presumed, because the
20573 router options and preconditions may refer to the local part of the address. By
20574 default, therefore, Exim routes each address in a message independently. DNS
20575 servers run caches, so repeated DNS lookups are not normally expensive, and in
20576 any case, personal messages rarely have more than a few recipients.
20577
20578 If you are running mailing lists with large numbers of subscribers at the same
20579 domain, and you are using a &(manualroute)& router which is independent of the
20580 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20581 lookups for identical domains in one message. In this case, when
20582 &(manualroute)& routes an address to a remote transport, any other unrouted
20583 addresses in the message that have the same domain are automatically given the
20584 same routing without processing them independently. However, this is only done
20585 if &%headers_add%& and &%headers_remove%& are unset.
20586
20587
20588
20589
20590 .section "Routing rules in route_list" "SECID120"
20591 The value of &%route_list%& is a string consisting of a sequence of routing
20592 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20593 entered as two semicolons. Alternatively, the list separator can be changed as
20594 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20595 Empty rules are ignored. The format of each rule is
20596 .display
20597 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20598 .endd
20599 The following example contains two rules, each with a simple domain pattern and
20600 no options:
20601 .code
20602 route_list = \
20603   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20604   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20605 .endd
20606 The three parts of a rule are separated by white space. The pattern and the
20607 list of hosts can be enclosed in quotes if necessary, and if they are, the
20608 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20609 single domain pattern, which is the only mandatory item in the rule. The
20610 pattern is in the same format as one item in a domain list (see section
20611 &<<SECTdomainlist>>&),
20612 except that it may not be the name of an interpolated file.
20613 That is, it may be wildcarded, or a regular expression, or a file or database
20614 lookup (with semicolons doubled, because of the use of semicolon as a separator
20615 in a &%route_list%&).
20616
20617 The rules in &%route_list%& are searched in order until one of the patterns
20618 matches the domain that is being routed. The list of hosts and then options are
20619 then used as described below. If there is no match, the router declines. When
20620 &%route_list%& is set, &%route_data%& must not be set.
20621
20622
20623
20624 .section "Routing rules in route_data" "SECID121"
20625 The use of &%route_list%& is convenient when there are only a small number of
20626 routing rules. For larger numbers, it is easier to use a file or database to
20627 hold the routing information, and use the &%route_data%& option instead.
20628 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20629 Most commonly, &%route_data%& is set as a string that contains an
20630 expansion lookup. For example, suppose we place two routing rules in a file
20631 like this:
20632 .code
20633 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20634 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20635 .endd
20636 This data can be accessed by setting
20637 .code
20638 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20639 .endd
20640 Failure of the lookup results in an empty string, causing the router to
20641 decline. However, you do not have to use a lookup in &%route_data%&. The only
20642 requirement is that the result of expanding the string is a list of hosts,
20643 possibly followed by options, separated by white space. The list of hosts must
20644 be enclosed in quotes if it contains white space.
20645
20646
20647
20648
20649 .section "Format of the list of hosts" "SECID122"
20650 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20651 always separately expanded before use. If the expansion fails, the router
20652 declines. The result of the expansion must be a colon-separated list of names
20653 and/or IP addresses, optionally also including ports.
20654 If the list is written with spaces, it must be protected with quotes.
20655 The format of each item
20656 in the list is described in the next section. The list separator can be changed
20657 as described in section &<<SECTlistsepchange>>&.
20658
20659 If the list of hosts was obtained from a &%route_list%& item, the following
20660 variables are set during its expansion:
20661
20662 .ilist
20663 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20664 If the domain was matched against a regular expression, the numeric variables
20665 &$1$&, &$2$&, etc. may be set. For example:
20666 .code
20667 route_list = ^domain(\d+)   host-$1.text.example
20668 .endd
20669 .next
20670 &$0$& is always set to the entire domain.
20671 .next
20672 &$1$& is also set when partial matching is done in a file lookup.
20673
20674 .next
20675 .vindex "&$value$&"
20676 If the pattern that matched the domain was a lookup item, the data that was
20677 looked up is available in the expansion variable &$value$&. For example:
20678 .code
20679 route_list = lsearch;;/some/file.routes  $value
20680 .endd
20681 .endlist
20682
20683 Note the doubling of the semicolon in the pattern that is necessary because
20684 semicolon is the default route list separator.
20685
20686
20687
20688 .section "Format of one host item" "SECTformatonehostitem"
20689 Each item in the list of hosts can be either a host name or an IP address,
20690 optionally with an attached port number, or it can be a single "+"
20691 (see &%hosts_randomize%&).
20692 When no port is given, an IP address
20693 is not enclosed in brackets. When a port is specified, it overrides the port
20694 specification on the transport. The port is separated from the name or address
20695 by a colon. This leads to some complications:
20696
20697 .ilist
20698 Because colon is the default separator for the list of hosts, either
20699 the colon that specifies a port must be doubled, or the list separator must
20700 be changed. The following two examples have the same effect:
20701 .code
20702 route_list = * "host1.tld::1225 : host2.tld::1226"
20703 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20704 .endd
20705 .next
20706 When IPv6 addresses are involved, it gets worse, because they contain
20707 colons of their own. To make this case easier, it is permitted to
20708 enclose an IP address (either v4 or v6) in square brackets if a port
20709 number follows. For example:
20710 .code
20711 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20712 .endd
20713 .endlist
20714
20715 .section "How the list of hosts is used" "SECThostshowused"
20716 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20717 the hosts is tried, in the order specified, when carrying out the SMTP
20718 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20719 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20720 transport.
20721
20722 Hosts may be listed by name or by IP address. An unadorned name in the list of
20723 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20724 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20725 records in the DNS. For example:
20726 .code
20727 route_list = *  x.y.z:p.q.r/MX:e.f.g
20728 .endd
20729 If this feature is used with a port specifier, the port must come last. For
20730 example:
20731 .code
20732 route_list = *  dom1.tld/mx::1225
20733 .endd
20734 If the &%hosts_randomize%& option is set, the order of the items in the list is
20735 randomized before any lookups are done. Exim then scans the list; for any name
20736 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20737 be an interface on the local host and the item is not the first in the list,
20738 Exim discards it and any subsequent items. If it is the first item, what
20739 happens is controlled by the
20740 .oindex "&%self%&" "in &(manualroute)& router"
20741 &%self%& option of the router.
20742
20743 A name on the list that is followed by &`/MX`& is replaced with the list of
20744 hosts obtained by looking up MX records for the name. This is always a DNS
20745 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20746 below) are not relevant here. The order of these hosts is determined by the
20747 preference values in the MX records, according to the usual rules. Because
20748 randomizing happens before the MX lookup, it does not affect the order that is
20749 defined by MX preferences.
20750
20751 If the local host is present in the sublist obtained from MX records, but is
20752 not the most preferred host in that list, it and any equally or less
20753 preferred hosts are removed before the sublist is inserted into the main list.
20754
20755 If the local host is the most preferred host in the MX list, what happens
20756 depends on where in the original list of hosts the &`/MX`& item appears. If it
20757 is not the first item (that is, there are previous hosts in the main list),
20758 Exim discards this name and any subsequent items in the main list.
20759
20760 If the MX item is first in the list of hosts, and the local host is the
20761 most preferred host, what happens is controlled by the &%self%& option of the
20762 router.
20763
20764 DNS failures when lookup up the MX records are treated in the same way as DNS
20765 failures when looking up IP addresses: &%pass_on_timeout%& and
20766 &%host_find_failed%& are used when relevant.
20767
20768 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20769 whether obtained from an MX lookup or not.
20770
20771
20772
20773 .section "How the options are used" "SECThowoptused"
20774 The options are a sequence of words, space-separated.
20775 One of the words can be the name of a transport; this overrides the
20776 &%transport%& option on the router for this particular routing rule only. The
20777 other words (if present) control randomization of the list of hosts on a
20778 per-rule basis, and how the IP addresses of the hosts are to be found when
20779 routing to a remote transport. These options are as follows:
20780
20781 .ilist
20782 &%randomize%&: randomize the order of the hosts in this list, overriding the
20783 setting of &%hosts_randomize%& for this routing rule only.
20784 .next
20785 &%no_randomize%&: do not randomize the order of the hosts in this list,
20786 overriding the setting of &%hosts_randomize%& for this routing rule only.
20787 .next
20788 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20789 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20790 also look in &_/etc/hosts_& or other sources of information.
20791 .next
20792 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20793 no address records are found. If there is a temporary DNS error (such as a
20794 timeout), delivery is deferred.
20795 .next
20796 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20797 .next
20798 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20799 .endlist
20800
20801 For example:
20802 .code
20803 route_list = domain1  host1:host2:host3  randomize bydns;\
20804              domain2  host4:host5
20805 .endd
20806 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20807 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20808 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20809 or &[gethostbyname()]&, and the result of the lookup is the result of that
20810 call.
20811
20812 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20813 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20814 instead of TRY_AGAIN. That is why the default action is to try a DNS
20815 lookup first. Only if that gives a definite &"no such host"& is the local
20816 function called.
20817
20818 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20819 inadvertent constraint that a transport name as an option had to be the last
20820 option specified.
20821
20822
20823
20824 If no IP address for a host can be found, what happens is controlled by the
20825 &%host_find_failed%& option.
20826
20827 .vindex "&$host$&"
20828 When an address is routed to a local transport, IP addresses are not looked up.
20829 The host list is passed to the transport in the &$host$& variable.
20830
20831
20832
20833 .section "Manualroute examples" "SECID123"
20834 In some of the examples that follow, the presence of the &%remote_smtp%&
20835 transport, as defined in the default configuration file, is assumed:
20836
20837 .ilist
20838 .cindex "smart host" "example router"
20839 The &(manualroute)& router can be used to forward all external mail to a
20840 &'smart host'&. If you have set up, in the main part of the configuration, a
20841 named domain list that contains your local domains, for example:
20842 .code
20843 domainlist local_domains = my.domain.example
20844 .endd
20845 You can arrange for all other domains to be routed to a smart host by making
20846 your first router something like this:
20847 .code
20848 smart_route:
20849   driver = manualroute
20850   domains = !+local_domains
20851   transport = remote_smtp
20852   route_list = * smarthost.ref.example
20853 .endd
20854 This causes all non-local addresses to be sent to the single host
20855 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20856 they are tried in order
20857 (but you can use &%hosts_randomize%& to vary the order each time).
20858 Another way of configuring the same thing is this:
20859 .code
20860 smart_route:
20861   driver = manualroute
20862   transport = remote_smtp
20863   route_list = !+local_domains  smarthost.ref.example
20864 .endd
20865 There is no difference in behaviour between these two routers as they stand.
20866 However, they behave differently if &%no_more%& is added to them. In the first
20867 example, the router is skipped if the domain does not match the &%domains%&
20868 precondition; the following router is always tried. If the router runs, it
20869 always matches the domain and so can never decline. Therefore, &%no_more%&
20870 would have no effect. In the second case, the router is never skipped; it
20871 always runs. However, if it doesn't match the domain, it declines. In this case
20872 &%no_more%& would prevent subsequent routers from running.
20873
20874 .next
20875 .cindex "mail hub example"
20876 A &'mail hub'& is a host which receives mail for a number of domains via MX
20877 records in the DNS and delivers it via its own private routing mechanism. Often
20878 the final destinations are behind a firewall, with the mail hub being the one
20879 machine that can connect to machines both inside and outside the firewall. The
20880 &(manualroute)& router is usually used on a mail hub to route incoming messages
20881 to the correct hosts. For a small number of domains, the routing can be inline,
20882 using the &%route_list%& option, but for a larger number a file or database
20883 lookup is easier to manage.
20884
20885 If the domain names are in fact the names of the machines to which the mail is
20886 to be sent by the mail hub, the configuration can be quite simple. For
20887 example:
20888 .code
20889 hub_route:
20890   driver = manualroute
20891   transport = remote_smtp
20892   route_list = *.rhodes.tvs.example  $domain
20893 .endd
20894 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20895 whose names are the same as the mail domains. A similar approach can be taken
20896 if the host name can be obtained from the domain name by a string manipulation
20897 that the expansion facilities can handle. Otherwise, a lookup based on the
20898 domain can be used to find the host:
20899 .code
20900 through_firewall:
20901   driver = manualroute
20902   transport = remote_smtp
20903   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20904 .endd
20905 The result of the lookup must be the name or IP address of the host (or
20906 hosts) to which the address is to be routed. If the lookup fails, the route
20907 data is empty, causing the router to decline. The address then passes to the
20908 next router.
20909
20910 .next
20911 .cindex "batched SMTP output example"
20912 .cindex "SMTP" "batched outgoing; example"
20913 You can use &(manualroute)& to deliver messages to pipes or files in batched
20914 SMTP format for onward transportation by some other means. This is one way of
20915 storing mail for a dial-up host when it is not connected. The route list entry
20916 can be as simple as a single domain name in a configuration like this:
20917 .code
20918 save_in_file:
20919   driver = manualroute
20920   transport = batchsmtp_appendfile
20921   route_list = saved.domain.example
20922 .endd
20923 though often a pattern is used to pick up more than one domain. If there are
20924 several domains or groups of domains with different transport requirements,
20925 different transports can be listed in the routing information:
20926 .code
20927 save_in_file:
20928   driver = manualroute
20929   route_list = \
20930     *.saved.domain1.example  $domain  batch_appendfile; \
20931     *.saved.domain2.example  \
20932       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20933       batch_pipe
20934 .endd
20935 .vindex "&$domain$&"
20936 .vindex "&$host$&"
20937 The first of these just passes the domain in the &$host$& variable, which
20938 doesn't achieve much (since it is also in &$domain$&), but the second does a
20939 file lookup to find a value to pass, causing the router to decline to handle
20940 the address if the lookup fails.
20941
20942 .next
20943 .cindex "UUCP" "example of router for"
20944 Routing mail directly to UUCP software is a specific case of the use of
20945 &(manualroute)& in a gateway to another mail environment. This is an example of
20946 one way it can be done:
20947 .code
20948 # Transport
20949 uucp:
20950   driver = pipe
20951   user = nobody
20952   command = /usr/local/bin/uux -r - \
20953     ${substr_-5:$host}!rmail ${local_part}
20954   return_fail_output = true
20955
20956 # Router
20957 uucphost:
20958   transport = uucp
20959   driver = manualroute
20960   route_data = \
20961     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20962 .endd
20963 The file &_/usr/local/exim/uucphosts_& contains entries like
20964 .code
20965 darksite.ethereal.example:           darksite.UUCP
20966 .endd
20967 It can be set up more simply without adding and removing &".UUCP"& but this way
20968 makes clear the distinction between the domain name
20969 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20970 .endlist
20971 .ecindex IIDmanrou1
20972 .ecindex IIDmanrou2
20973
20974
20975
20976
20977
20978
20979
20980
20981 . ////////////////////////////////////////////////////////////////////////////
20982 . ////////////////////////////////////////////////////////////////////////////
20983
20984 .chapter "The queryprogram router" "CHAPdriverlast"
20985 .scindex IIDquerou1 "&(queryprogram)& router"
20986 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20987 .cindex "routing" "by external program"
20988 The &(queryprogram)& router routes an address by running an external command
20989 and acting on its output. This is an expensive way to route, and is intended
20990 mainly for use in lightly-loaded systems, or for performing experiments.
20991 However, if it is possible to use the precondition options (&%domains%&,
20992 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20993 be used in special cases, even on a busy host. There are the following private
20994 options:
20995 .cindex "options" "&(queryprogram)& router"
20996
20997 .option command queryprogram string&!! unset
20998 This option must be set. It specifies the command that is to be run. The
20999 command is split up into a command name and arguments, and then each is
21000 expanded separately (exactly as for a &(pipe)& transport, described in chapter
21001 &<<CHAPpipetransport>>&).
21002
21003
21004 .option command_group queryprogram string unset
21005 .cindex "gid (group id)" "in &(queryprogram)& router"
21006 This option specifies a gid to be set when running the command while routing an
21007 address for deliver. It must be set if &%command_user%& specifies a numerical
21008 uid. If it begins with a digit, it is interpreted as the numerical value of the
21009 gid. Otherwise it is looked up using &[getgrnam()]&.
21010
21011
21012 .option command_user queryprogram string unset
21013 .cindex "uid (user id)" "for &(queryprogram)&"
21014 This option must be set. It specifies the uid which is set when running the
21015 command while routing an address for delivery. If the value begins with a digit,
21016 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
21017 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
21018 not set, a value for the gid also.
21019
21020 &*Warning:*& Changing uid and gid is possible only when Exim is running as
21021 root, which it does during a normal delivery in a conventional configuration.
21022 However, when an address is being verified during message reception, Exim is
21023 usually running as the Exim user, not as root. If the &(queryprogram)& router
21024 is called from a non-root process, Exim cannot change uid or gid before running
21025 the command. In this circumstance the command runs under the current uid and
21026 gid.
21027
21028
21029 .option current_directory queryprogram string /
21030 This option specifies an absolute path which is made the current directory
21031 before running the command.
21032
21033
21034 .option timeout queryprogram time 1h
21035 If the command does not complete within the timeout period, its process group
21036 is killed and the message is frozen. A value of zero time specifies no
21037 timeout.
21038
21039
21040 The standard output of the command is connected to a pipe, which is read when
21041 the command terminates. It should consist of a single line of output,
21042 containing up to five fields, separated by white space. The maximum length of
21043 the line is 1023 characters. Longer lines are silently truncated. The first
21044 field is one of the following words (case-insensitive):
21045
21046 .ilist
21047 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21048 below).
21049 .next
21050 &'Decline'&: the router declines; pass the address to the next router, unless
21051 &%no_more%& is set.
21052 .next
21053 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21054 subsequent text on the line is an error message. If the router is run as part
21055 of address verification during an incoming SMTP message, the message is
21056 included in the SMTP response.
21057 .next
21058 &'Defer'&: routing could not be completed at this time; try again later. Any
21059 subsequent text on the line is an error message which is logged. It is not
21060 included in any SMTP response.
21061 .next
21062 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21063 .next
21064 &'Pass'&: pass the address to the next router (or the router specified by
21065 &%pass_router%&), overriding &%no_more%&.
21066 .next
21067 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21068 new addresses, which are routed independently, starting with the first router,
21069 or the router specified by &%redirect_router%&, if set.
21070 .endlist
21071
21072 When the first word is &'accept'&, the remainder of the line consists of a
21073 number of keyed data values, as follows (split into two lines here, to fit on
21074 the page):
21075 .code
21076 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21077 LOOKUP=byname|bydns DATA=<text>
21078 .endd
21079 The data items can be given in any order, and all are optional. If no transport
21080 is included, the transport specified by the generic &%transport%& option is
21081 used. The list of hosts and the lookup type are needed only if the transport is
21082 an &(smtp)& transport that does not itself supply a list of hosts.
21083
21084 The format of the list of hosts is the same as for the &(manualroute)& router.
21085 As well as host names and IP addresses with optional port numbers, as described
21086 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21087 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21088 (see section &<<SECThostshowused>>&).
21089
21090 If the lookup type is not specified, Exim behaves as follows when trying to
21091 find an IP address for each host: First, a DNS lookup is done. If this yields
21092 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21093 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21094 result of the lookup is the result of that call.
21095
21096 .vindex "&$address_data$&"
21097 If the DATA field is set, its value is placed in the &$address_data$&
21098 variable. For example, this return line
21099 .code
21100 accept hosts=x1.y.example:x2.y.example data="rule1"
21101 .endd
21102 routes the address to the default transport, passing a list of two hosts. When
21103 the transport runs, the string &"rule1"& is in &$address_data$&.
21104 .ecindex IIDquerou1
21105 .ecindex IIDquerou2
21106
21107
21108
21109
21110 . ////////////////////////////////////////////////////////////////////////////
21111 . ////////////////////////////////////////////////////////////////////////////
21112
21113 .chapter "The redirect router" "CHAPredirect"
21114 .scindex IIDredrou1 "&(redirect)& router"
21115 .scindex IIDredrou2 "routers" "&(redirect)&"
21116 .cindex "alias file" "in a &(redirect)& router"
21117 .cindex "address redirection" "&(redirect)& router"
21118 The &(redirect)& router handles several kinds of address redirection. Its most
21119 common uses are for resolving local part aliases from a central alias file
21120 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21121 files, but it has many other potential uses. The incoming address can be
21122 redirected in several different ways:
21123
21124 .ilist
21125 It can be replaced by one or more new addresses which are themselves routed
21126 independently.
21127 .next
21128 It can be routed to be delivered to a given file or directory.
21129 .next
21130 It can be routed to be delivered to a specified pipe command.
21131 .next
21132 It can cause an automatic reply to be generated.
21133 .next
21134 It can be forced to fail, optionally with a custom error message.
21135 .next
21136 It can be temporarily deferred, optionally with a custom message.
21137 .next
21138 It can be discarded.
21139 .endlist
21140
21141 The generic &%transport%& option must not be set for &(redirect)& routers.
21142 However, there are some private options which define transports for delivery to
21143 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21144 &%pipe_transport%& and &%reply_transport%& descriptions below.
21145
21146 If success DSNs have been requested
21147 .cindex "DSN" "success"
21148 .cindex "Delivery Status Notification" "success"
21149 redirection triggers one and the DSN options are not passed any further.
21150
21151
21152
21153 .section "Redirection data" "SECID124"
21154 The router operates by interpreting a text string which it obtains either by
21155 expanding the contents of the &%data%& option, or by reading the entire
21156 contents of a file whose name is given in the &%file%& option. These two
21157 options are mutually exclusive. The first is commonly used for handling system
21158 aliases, in a configuration like this:
21159 .code
21160 system_aliases:
21161   driver = redirect
21162   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21163 .endd
21164 If the lookup fails, the expanded string in this example is empty. When the
21165 expansion of &%data%& results in an empty string, the router declines. A forced
21166 expansion failure also causes the router to decline; other expansion failures
21167 cause delivery to be deferred.
21168
21169 A configuration using &%file%& is commonly used for handling users'
21170 &_.forward_& files, like this:
21171 .code
21172 userforward:
21173   driver = redirect
21174   check_local_user
21175   file = $home/.forward
21176   no_verify
21177 .endd
21178 If the file does not exist, or causes no action to be taken (for example, it is
21179 empty or consists only of comments), the router declines. &*Warning*&: This
21180 is not the case when the file contains syntactically valid items that happen to
21181 yield empty addresses, for example, items containing only RFC 2822 address
21182 comments.
21183
21184 .cindex "tainted data" "in filenames"
21185 .cindex redirect "tainted data"
21186 Tainted data may not be used for a filename.
21187
21188 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21189 directly for redirection,
21190 as they are provided by a potential attacker.
21191 In the examples above, &$local_part$& is used for looking up data held locally
21192 on the system, and not used directly (the second example derives &$home$& via
21193 the passsword file or database, using &$local_part$&).
21194
21195
21196
21197 .section "Forward files and address verification" "SECID125"
21198 .cindex "address redirection" "while verifying"
21199 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21200 &_.forward_& files, as in the example above. There are two reasons for this:
21201
21202 .ilist
21203 When Exim is receiving an incoming SMTP message from a remote host, it is
21204 running under the Exim uid, not as root. Exim is unable to change uid to read
21205 the file as the user, and it may not be able to read it as the Exim user. So in
21206 practice the router may not be able to operate.
21207 .next
21208 However, even when the router can operate, the existence of a &_.forward_& file
21209 is unimportant when verifying an address. What should be checked is whether the
21210 local part is a valid user name or not. Cutting out the redirection processing
21211 saves some resources.
21212 .endlist
21213
21214
21215
21216
21217
21218
21219 .section "Interpreting redirection data" "SECID126"
21220 .cindex "Sieve filter" "specifying in redirection data"
21221 .cindex "filter" "specifying in redirection data"
21222 The contents of the data string, whether obtained from &%data%& or &%file%&,
21223 can be interpreted in two different ways:
21224
21225 .ilist
21226 If the &%allow_filter%& option is set true, and the data begins with the text
21227 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21228 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21229 respectively. Details of the syntax and semantics of filter files are described
21230 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21231 document is intended for use by end users.
21232 .next
21233 Otherwise, the data must be a comma-separated list of redirection items, as
21234 described in the next section.
21235 .endlist
21236
21237 When a message is redirected to a file (a &"mail folder"&), the filename given
21238 in a non-filter redirection list must always be an absolute path. A filter may
21239 generate a relative path &-- how this is handled depends on the transport's
21240 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21241 for the &(appendfile)& transport.
21242
21243
21244
21245 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21246 .cindex "address redirection" "non-filter list items"
21247 When the redirection data is not an Exim or Sieve filter, for example, if it
21248 comes from a conventional alias or forward file, it consists of a list of
21249 addresses, filenames, pipe commands, or certain special items (see section
21250 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21251 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21252 depending on their default values. The items in the list are separated by
21253 commas or newlines.
21254 If a comma is required in an item, the entire item must be enclosed in double
21255 quotes.
21256
21257 Lines starting with a # character are comments, and are ignored, and # may
21258 also appear following a comma, in which case everything between the # and the
21259 next newline character is ignored.
21260
21261 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21262 double quotes are retained because some forms of mail address require their use
21263 (but never to enclose the entire address). In the following description,
21264 &"item"& refers to what remains after any surrounding double quotes have been
21265 removed.
21266
21267 .vindex "&$local_part$&"
21268 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21269 and the expansion contains a reference to &$local_part$&, you should make use
21270 of the &%quote_local_part%& expansion operator, in case the local part contains
21271 special characters. For example, to redirect all mail for the domain
21272 &'obsolete.example'&, retaining the existing local part, you could use this
21273 setting:
21274 .code
21275 data = ${quote_local_part:$local_part}@newdomain.example
21276 .endd
21277
21278
21279 .section "Redirecting to a local mailbox" "SECTredlocmai"
21280 .cindex "routing" "loops in"
21281 .cindex "loop" "while routing, avoidance of"
21282 .cindex "address redirection" "to local mailbox"
21283 A redirection item may safely be the same as the address currently under
21284 consideration. This does not cause a routing loop, because a router is
21285 automatically skipped if any ancestor of the address that is being processed
21286 is the same as the current address and was processed by the current router.
21287 Such an address is therefore passed to the following routers, so it is handled
21288 as if there were no redirection. When making this loop-avoidance test, the
21289 complete local part, including any prefix or suffix, is used.
21290
21291 .cindex "address redirection" "local part without domain"
21292 Specifying the same local part without a domain is a common usage in personal
21293 filter files when the user wants to have messages delivered to the local
21294 mailbox and also forwarded elsewhere. For example, the user whose login is
21295 &'cleo'& might have a &_.forward_& file containing this:
21296 .code
21297 cleo, cleopatra@egypt.example
21298 .endd
21299 .cindex "backslash in alias file"
21300 .cindex "alias file" "backslash in"
21301 For compatibility with other MTAs, such unqualified local parts may be
21302 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21303 it does make a difference if more than one domain is being handled
21304 synonymously.
21305
21306 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21307 2822 address that does not include a domain, the item is qualified using the
21308 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21309 addresses are qualified using the value in &%qualify_recipient%&, but you can
21310 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21311
21312 Care must be taken if there are alias names for local users.
21313 Consider an MTA handling a single local domain where the system alias file
21314 contains:
21315 .code
21316 Sam.Reman: spqr
21317 .endd
21318 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21319 messages in the local mailbox, and also forward copies elsewhere. He creates
21320 this forward file:
21321 .code
21322 Sam.Reman, spqr@reme.elsewhere.example
21323 .endd
21324 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21325 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21326 second time round, because it has previously routed it,
21327 and the following routers presumably cannot handle the alias. The forward file
21328 should really contain
21329 .code
21330 spqr, spqr@reme.elsewhere.example
21331 .endd
21332 but because this is such a common error, the &%check_ancestor%& option (see
21333 below) exists to provide a way to get round it. This is normally set on a
21334 &(redirect)& router that is handling users' &_.forward_& files.
21335
21336
21337
21338 .section "Special items in redirection lists" "SECTspecitredli"
21339 In addition to addresses, the following types of item may appear in redirection
21340 lists (that is, in non-filter redirection data):
21341
21342 .ilist
21343 .cindex "pipe" "in redirection list"
21344 .cindex "address redirection" "to pipe"
21345 An item is treated as a pipe command if it begins with &"|"& and does not parse
21346 as a valid RFC 2822 address that includes a domain. A transport for running the
21347 command must be specified by the &%pipe_transport%& option.
21348 Normally, either the router or the transport specifies a user and a group under
21349 which to run the delivery. The default is to use the Exim user and group.
21350
21351 Single or double quotes can be used for enclosing the individual arguments of
21352 the pipe command; no interpretation of escapes is done for single quotes. If
21353 the command contains a comma character, it is necessary to put the whole item
21354 in double quotes, for example:
21355 .code
21356 "|/some/command ready,steady,go"
21357 .endd
21358 since items in redirection lists are terminated by commas. Do not, however,
21359 quote just the command. An item such as
21360 .code
21361 |"/some/command ready,steady,go"
21362 .endd
21363 is interpreted as a pipe with a rather strange command name, and no arguments.
21364
21365 Note that the above example assumes that the text comes from a lookup source
21366 of some sort, so that the quotes are part of the data.  If composing a
21367 redirect router with a &%data%& option directly specifying this command, the
21368 quotes will be used by the configuration parser to define the extent of one
21369 string, but will not be passed down into the redirect router itself.  There
21370 are two main approaches to get around this: escape quotes to be part of the
21371 data itself, or avoid using this mechanism and instead create a custom
21372 transport with the &%command%& option set and reference that transport from
21373 an &%accept%& router.
21374
21375 .next
21376 .cindex "file" "in redirection list"
21377 .cindex "address redirection" "to file"
21378 An item is interpreted as a path name if it begins with &"/"& and does not
21379 parse as a valid RFC 2822 address that includes a domain. For example,
21380 .code
21381 /home/world/minbari
21382 .endd
21383 is treated as a filename, but
21384 .code
21385 /s=molari/o=babylon/@x400gate.way
21386 .endd
21387 is treated as an address. For a filename, a transport must be specified using
21388 the &%file_transport%& option. However, if the generated path name ends with a
21389 forward slash character, it is interpreted as a directory name rather than a
21390 filename, and &%directory_transport%& is used instead.
21391
21392 Normally, either the router or the transport specifies a user and a group under
21393 which to run the delivery. The default is to use the Exim user and group.
21394
21395 .cindex "&_/dev/null_&"
21396 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21397 bypassed at a high level, and the log entry shows &"**bypassed**"&
21398 instead of a transport name. In this case the user and group are not used.
21399
21400 .next
21401 .cindex "included address list"
21402 .cindex "address redirection" "included external list"
21403 If an item is of the form
21404 .code
21405 :include:<path name>
21406 .endd
21407 a list of further items is taken from the given file and included at that
21408 point. &*Note*&: Such a file can not be a filter file; it is just an
21409 out-of-line addition to the list. The items in the included list are separated
21410 by commas or newlines and are not subject to expansion. If this is the first
21411 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21412 the alias name. This example is incorrect:
21413 .code
21414 list1    :include:/opt/lists/list1
21415 .endd
21416 It must be given as
21417 .code
21418 list1:   :include:/opt/lists/list1
21419 .endd
21420 .cindex "tainted data" "in filenames"
21421 .cindex redirect "tainted data"
21422 Tainted data may not be used for a filename.
21423 .next
21424 .cindex "address redirection" "to black hole"
21425 .cindex "delivery" "discard"
21426 .cindex "delivery" "blackhole"
21427 .cindex "black hole"
21428 .cindex "abandoning mail"
21429 Sometimes you want to throw away mail to a particular local part.  Making the
21430 &%data%& option expand to an empty string does not work, because that causes
21431 the router to decline. Instead, the alias item
21432 .code
21433 :blackhole:
21434 .endd
21435 can be used. It does what its name implies. No delivery is
21436 done, and no error message is generated. This has the same effect as specifying
21437 &_/dev/null_& as a destination, but it can be independently disabled.
21438
21439 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21440 delivery is done for the original local part, even if other redirection items
21441 are present. If you are generating a multi-item list (for example, by reading a
21442 database) and need the ability to provide a no-op item, you must use
21443 &_/dev/null_&.
21444
21445 .next
21446 .cindex "delivery" "forcing failure"
21447 .cindex "delivery" "forcing deferral"
21448 .cindex "failing delivery" "forcing"
21449 .cindex "deferred delivery, forcing"
21450 .cindex "customizing" "failure message"
21451 An attempt to deliver a particular address can be deferred or forced to fail by
21452 redirection items of the form
21453 .code
21454 :defer:
21455 :fail:
21456 .endd
21457 respectively. When a redirection list contains such an item, it applies
21458 to the entire redirection; any other items in the list are ignored. Any
21459 text following &':fail:'& or &':defer:'& is placed in the error text
21460 associated with the failure. For example, an alias file might contain:
21461 .code
21462 X.Employee:  :fail: Gone away, no forwarding address
21463 .endd
21464 In the case of an address that is being verified from an ACL or as the subject
21465 of a
21466 .cindex "VRFY" "error text, display of"
21467 VRFY command, the text is included in the SMTP error response by
21468 default.
21469 .cindex "EXPN" "error text, display of"
21470 The text is not included in the response to an EXPN command. In non-SMTP cases
21471 the text is included in the error message that Exim generates.
21472
21473 .cindex "SMTP" "error codes"
21474 By default for verify, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21475 &':fail:'&. However, if the message starts with three digits followed by a
21476 space, optionally followed by an extended code of the form &'n.n.n'&, also
21477 followed by a space, and the very first digit is the same as the default error
21478 code, the code from the message is used instead. If the very first digit is
21479 incorrect, a panic error is logged, and the default code is used. You can
21480 suppress the use of the supplied code in a redirect router by setting the
21481 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21482 ignored.
21483
21484 .vindex "&$acl_verify_message$&"
21485 In an ACL, an explicitly provided message overrides the default, but the
21486 default message is available in the variable &$acl_verify_message$& and can
21487 therefore be included in a custom message if this is desired.
21488
21489 Normally the error text is the rest of the redirection list &-- a comma does
21490 not terminate it &-- but a newline does act as a terminator. Newlines are not
21491 normally present in alias expansions. In &(lsearch)& lookups they are removed
21492 as part of the continuation process, but they may exist in other kinds of
21493 lookup and in &':include:'& files.
21494
21495 During routing for message delivery (as opposed to verification), a redirection
21496 containing &':fail:'& causes an immediate failure of the incoming address,
21497 whereas &':defer:'& causes the message to remain in the queue so that a
21498 subsequent delivery attempt can happen at a later time. If an address is
21499 deferred for too long, it will ultimately fail, because the normal retry
21500 rules still apply.
21501
21502 .next
21503 .cindex "alias file" "exception to default"
21504 Sometimes it is useful to use a single-key search type with a default (see
21505 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21506 for exceptions to the default. These can be handled by aliasing them to
21507 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21508 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21509 results in an empty redirection list has the same effect.
21510 .endlist
21511
21512
21513 .section "Duplicate addresses" "SECTdupaddr"
21514 .cindex "duplicate addresses"
21515 .cindex "address duplicate, discarding"
21516 .cindex "pipe" "duplicated"
21517 Exim removes duplicate addresses from the list to which it is delivering, so as
21518 to deliver just one copy to each address. This does not apply to deliveries
21519 routed to pipes by different immediate parent addresses, but an indirect
21520 aliasing scheme of the type
21521 .code
21522 pipe:       |/some/command $local_part
21523 localpart1: pipe
21524 localpart2: pipe
21525 .endd
21526 does not work with a message that is addressed to both local parts, because
21527 when the second is aliased to the intermediate local part &"pipe"& it gets
21528 discarded as being the same as a previously handled address. However, a scheme
21529 such as
21530 .code
21531 localpart1: |/some/command $local_part
21532 localpart2: |/some/command $local_part
21533 .endd
21534 does result in two different pipe deliveries, because the immediate parents of
21535 the pipes are distinct.
21536
21537
21538
21539 .section "Repeated redirection expansion" "SECID128"
21540 .cindex "repeated redirection expansion"
21541 .cindex "address redirection" "repeated for each delivery attempt"
21542 When a message cannot be delivered to all of its recipients immediately,
21543 leading to two or more delivery attempts, redirection expansion is carried out
21544 afresh each time for those addresses whose children were not all previously
21545 delivered. If redirection is being used as a mailing list, this can lead to new
21546 members of the list receiving copies of old messages. The &%one_time%& option
21547 can be used to avoid this.
21548
21549
21550 .section "Errors in redirection lists" "SECID129"
21551 .cindex "address redirection" "errors"
21552 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21553 error is skipped, and an entry is written to the main log. This may be useful
21554 for mailing lists that are automatically managed. Otherwise, if an error is
21555 detected while generating the list of new addresses, the original address is
21556 deferred. See also &%syntax_errors_to%&.
21557
21558
21559
21560 .section "Private options for the redirect router" "SECID130"
21561
21562 .cindex "options" "&(redirect)& router"
21563 The private options for the &(redirect)& router are as follows:
21564
21565
21566 .option allow_defer redirect boolean false
21567 Setting this option allows the use of &':defer:'& in non-filter redirection
21568 data, or the &%defer%& command in an Exim filter file.
21569
21570
21571 .option allow_fail redirect boolean false
21572 .cindex "failing delivery" "from filter"
21573 If this option is true, the &':fail:'& item can be used in a redirection list,
21574 and the &%fail%& command may be used in an Exim filter file.
21575
21576
21577 .option allow_filter redirect boolean false
21578 .cindex "filter" "enabling use of"
21579 .cindex "Sieve filter" "enabling use of"
21580 Setting this option allows Exim to interpret redirection data that starts with
21581 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21582 are some features of Exim filter files that some administrators may wish to
21583 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21584
21585 It is also possible to lock out Exim filters or Sieve filters while allowing
21586 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21587
21588
21589 The filter is run using the uid and gid set by the generic &%user%& and
21590 &%group%& options. These take their defaults from the password data if
21591 &%check_local_user%& is set, so in the normal case of users' personal filter
21592 files, the filter is run as the relevant user. When &%allow_filter%& is set
21593 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21594
21595
21596
21597 .option allow_freeze redirect boolean false
21598 .cindex "freezing messages" "allowing in filter"
21599 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21600 This command is more normally encountered in system filters, and is disabled by
21601 default for redirection filters because it isn't something you usually want to
21602 let ordinary users do.
21603
21604
21605
21606 .option check_ancestor redirect boolean false
21607 This option is concerned with handling generated addresses that are the same
21608 as some address in the list of redirection ancestors of the current address.
21609 Although it is turned off by default in the code, it is set in the default
21610 configuration file for handling users' &_.forward_& files. It is recommended
21611 for this use of the &(redirect)& router.
21612
21613 When &%check_ancestor%& is set, if a generated address (including the domain)
21614 is the same as any ancestor of the current address, it is replaced by a copy of
21615 the current address. This helps in the case where local part A is aliased to B,
21616 and B has a &_.forward_& file pointing back to A. For example, within a single
21617 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21618 &_&~jb/.forward_& contains:
21619 .code
21620 \Joe.Bloggs, <other item(s)>
21621 .endd
21622 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21623 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21624 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21625 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21626 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21627 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21628 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21629 original address. See also the &%repeat_use%& option below.
21630
21631
21632 .option check_group redirect boolean "see below"
21633 When the &%file%& option is used, the group owner of the file is checked only
21634 when this option is set. The permitted groups are those listed in the
21635 &%owngroups%& option, together with the user's default group if
21636 &%check_local_user%& is set. If the file has the wrong group, routing is
21637 deferred. The default setting for this option is true if &%check_local_user%&
21638 is set and the &%modemask%& option permits the group write bit, or if the
21639 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21640
21641
21642
21643 .option check_owner redirect boolean "see below"
21644 When the &%file%& option is used, the owner of the file is checked only when
21645 this option is set. If &%check_local_user%& is set, the local user is
21646 permitted; otherwise the owner must be one of those listed in the &%owners%&
21647 option. The default value for this option is true if &%check_local_user%& or
21648 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21649
21650
21651 .option data redirect string&!! unset
21652 This option is mutually exclusive with &%file%&. One or other of them must be
21653 set, but not both. The contents of &%data%& are expanded, and then used as the
21654 list of forwarding items, or as a set of filtering instructions. If the
21655 expansion is forced to fail, or the result is an empty string or a string that
21656 has no effect (consists entirely of comments), the router declines.
21657
21658 When filtering instructions are used, the string must begin with &"#Exim
21659 filter"&, and all comments in the string, including this initial one, must be
21660 terminated with newline characters. For example:
21661 .code
21662 data = #Exim filter\n\
21663        if $h_to: contains Exim then save $home/mail/exim endif
21664 .endd
21665 If you are reading the data from a database where newlines cannot be included,
21666 you can use the &${sg}$& expansion item to turn the escape string of your
21667 choice into a newline.
21668
21669
21670 .option directory_transport redirect string&!! unset
21671 A &(redirect)& router sets up a direct delivery to a directory when a path name
21672 ending with a slash is specified as a new &"address"&. The transport used is
21673 specified by this option, which, after expansion, must be the name of a
21674 configured transport. This should normally be an &(appendfile)& transport.
21675
21676
21677 .option file redirect string&!! unset
21678 This option specifies the name of a file that contains the redirection data. It
21679 is mutually exclusive with the &%data%& option. The string is expanded before
21680 use; if the expansion is forced to fail, the router declines. Other expansion
21681 failures cause delivery to be deferred. The result of a successful expansion
21682 must be an absolute path. The entire file is read and used as the redirection
21683 data. If the data is an empty string or a string that has no effect (consists
21684 entirely of comments), the router declines.
21685
21686 .cindex "NFS" "checking for file existence"
21687 If the attempt to open the file fails with a &"does not exist"& error, Exim
21688 runs a check on the containing directory,
21689 unless &%ignore_enotdir%& is true (see below).
21690 If the directory does not appear to exist, delivery is deferred. This can
21691 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21692 is a mount problem. If the containing directory does exist, but the file does
21693 not, the router declines.
21694
21695
21696 .option file_transport redirect string&!! unset
21697 .vindex "&$address_file$&"
21698 A &(redirect)& router sets up a direct delivery to a file when a path name not
21699 ending in a slash is specified as a new &"address"&. The transport used is
21700 specified by this option, which, after expansion, must be the name of a
21701 configured transport. This should normally be an &(appendfile)& transport. When
21702 it is running, the filename is in &$address_file$&.
21703
21704
21705 .option filter_prepend_home redirect boolean true
21706 When this option is true, if a &(save)& command in an Exim filter specifies a
21707 relative path, and &$home$& is defined, it is automatically prepended to the
21708 relative path. If this option is set false, this action does not happen. The
21709 relative path is then passed to the transport unmodified.
21710
21711
21712 .option forbid_blackhole redirect boolean false
21713 .cindex "restricting access to features"
21714 .cindex "filter" "locking out certain features"
21715 If this option is true, the &':blackhole:'& item may not appear in a
21716 redirection list.
21717
21718
21719 .option forbid_exim_filter redirect boolean false
21720 .cindex "restricting access to features"
21721 .cindex "filter" "locking out certain features"
21722 If this option is set true, only Sieve filters are permitted when
21723 &%allow_filter%& is true.
21724
21725
21726
21727
21728 .option forbid_file redirect boolean false
21729 .cindex "restricting access to features"
21730 .cindex "delivery" "to file; forbidding"
21731 .cindex "filter" "locking out certain features"
21732 .cindex "Sieve filter" "forbidding delivery to a file"
21733 .cindex "Sieve filter" "&""keep""& facility; disabling"
21734 If this option is true, this router may not generate a new address that
21735 specifies delivery to a local file or directory, either from a filter or from a
21736 conventional forward file. This option is forced to be true if &%one_time%& is
21737 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21738 locks out the Sieve's &"keep"& facility.
21739
21740
21741 .option forbid_filter_dlfunc redirect boolean false
21742 .cindex "restricting access to features"
21743 .cindex "filter" "locking out certain features"
21744 If this option is true, string expansions in Exim filters are not allowed to
21745 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21746 functions.
21747
21748 .option forbid_filter_existstest redirect boolean false
21749 .cindex "restricting access to features"
21750 .cindex "filter" "locking out certain features"
21751 .cindex "expansion" "statting a file"
21752 If this option is true, string expansions in Exim filters are not allowed to
21753 make use of the &%exists%& condition or the &%stat%& expansion item.
21754
21755 .option forbid_filter_logwrite redirect boolean false
21756 .cindex "restricting access to features"
21757 .cindex "filter" "locking out certain features"
21758 If this option is true, use of the logging facility in Exim filters is not
21759 permitted. Logging is in any case available only if the filter is being run
21760 under some unprivileged uid (which is normally the case for ordinary users'
21761 &_.forward_& files).
21762
21763
21764 .option forbid_filter_lookup redirect boolean false
21765 .cindex "restricting access to features"
21766 .cindex "filter" "locking out certain features"
21767 If this option is true, string expansions in Exim filter files are not allowed
21768 to make use of &%lookup%& items.
21769
21770
21771 .option forbid_filter_perl redirect boolean false
21772 .cindex "restricting access to features"
21773 .cindex "filter" "locking out certain features"
21774 This option has an effect only if Exim is built with embedded Perl support. If
21775 it is true, string expansions in Exim filter files are not allowed to make use
21776 of the embedded Perl support.
21777
21778
21779 .option forbid_filter_readfile redirect boolean false
21780 .cindex "restricting access to features"
21781 .cindex "filter" "locking out certain features"
21782 If this option is true, string expansions in Exim filter files are not allowed
21783 to make use of &%readfile%& items.
21784
21785
21786 .option forbid_filter_readsocket redirect boolean false
21787 .cindex "restricting access to features"
21788 .cindex "filter" "locking out certain features"
21789 If this option is true, string expansions in Exim filter files are not allowed
21790 to make use of &%readsocket%& items.
21791
21792
21793 .option forbid_filter_reply redirect boolean false
21794 .cindex "restricting access to features"
21795 .cindex "filter" "locking out certain features"
21796 If this option is true, this router may not generate an automatic reply
21797 message. Automatic replies can be generated only from Exim or Sieve filter
21798 files, not from traditional forward files. This option is forced to be true if
21799 &%one_time%& is set.
21800
21801
21802 .option forbid_filter_run redirect boolean false
21803 .cindex "restricting access to features"
21804 .cindex "filter" "locking out certain features"
21805 If this option is true, string expansions in Exim filter files are not allowed
21806 to make use of &%run%& items.
21807
21808
21809 .option forbid_include redirect boolean false
21810 .cindex "restricting access to features"
21811 .cindex "filter" "locking out certain features"
21812 If this option is true, items of the form
21813 .code
21814 :include:<path name>
21815 .endd
21816 are not permitted in non-filter redirection lists.
21817
21818
21819 .option forbid_pipe redirect boolean false
21820 .cindex "restricting access to features"
21821 .cindex "filter" "locking out certain features"
21822 .cindex "delivery" "to pipe; forbidding"
21823 If this option is true, this router may not generate a new address which
21824 specifies delivery to a pipe, either from an Exim filter or from a conventional
21825 forward file. This option is forced to be true if &%one_time%& is set.
21826
21827
21828 .option forbid_sieve_filter redirect boolean false
21829 .cindex "restricting access to features"
21830 .cindex "filter" "locking out certain features"
21831 If this option is set true, only Exim filters are permitted when
21832 &%allow_filter%& is true.
21833
21834
21835 .cindex "SMTP" "error codes"
21836 .option forbid_smtp_code redirect boolean false
21837 If this option is set true, any SMTP error codes that are present at the start
21838 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21839 the default codes (451 and 550, respectively) are always used.
21840
21841
21842
21843
21844 .option hide_child_in_errmsg redirect boolean false
21845 .cindex "bounce message" "redirection details; suppressing"
21846 If this option is true, it prevents Exim from quoting a child address if it
21847 generates a bounce or delay message for it. Instead it says &"an address
21848 generated from <&'the top level address'&>"&. Of course, this applies only to
21849 bounces generated locally. If a message is forwarded to another host, &'its'&
21850 bounce may well quote the generated address.
21851
21852
21853 .option ignore_eacces redirect boolean false
21854 .cindex "EACCES"
21855 If this option is set and an attempt to open a redirection file yields the
21856 EACCES error (permission denied), the &(redirect)& router behaves as if the
21857 file did not exist.
21858
21859
21860 .option ignore_enotdir redirect boolean false
21861 .cindex "ENOTDIR"
21862 If this option is set and an attempt to open a redirection file yields the
21863 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21864 router behaves as if the file did not exist.
21865
21866 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21867 router that has the &%file%& option set discovers that the file does not exist
21868 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21869 against unmounted NFS directories. If the parent can not be statted, delivery
21870 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21871 is set, because that option tells Exim to ignore &"something on the path is not
21872 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21873 that some operating systems give ENOENT where others give ENOTDIR.
21874
21875
21876
21877 .option include_directory redirect string unset
21878 If this option is set, the path names of any &':include:'& items in a
21879 redirection list must start with this directory.
21880
21881
21882 .option modemask redirect "octal integer" 022
21883 This specifies mode bits which must not be set for a file specified by the
21884 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21885
21886
21887 .option one_time redirect boolean false
21888 .cindex "one-time aliasing/forwarding expansion"
21889 .cindex "alias file" "one-time expansion"
21890 .cindex "forward file" "one-time expansion"
21891 .cindex "mailing lists" "one-time expansion"
21892 .cindex "address redirection" "one-time expansion"
21893 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21894 files each time it tries to deliver a message causes a problem when one or more
21895 of the generated addresses fails be delivered at the first attempt. The problem
21896 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21897 but of what happens when the redirection list changes during the time that the
21898 message is on Exim's queue. This is particularly true in the case of mailing
21899 lists, where new subscribers might receive copies of messages that were posted
21900 before they subscribed.
21901
21902 If &%one_time%& is set and any addresses generated by the router fail to
21903 deliver at the first attempt, the failing addresses are added to the message as
21904 &"top level"& addresses, and the parent address that generated them is marked
21905 &"delivered"&. Thus, redirection does not happen again at the next delivery
21906 attempt.
21907
21908 &*Warning 1*&: Any header line addition or removal that is specified by this
21909 router would be lost if delivery did not succeed at the first attempt. For this
21910 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21911 permitted when &%one_time%& is set.
21912
21913 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21914 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21915 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21916
21917 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21918 &%one_time%&.
21919
21920 The original top-level address is remembered with each of the generated
21921 addresses, and is output in any log messages. However, any intermediate parent
21922 addresses are not recorded. This makes a difference to the log only if
21923 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21924 typically be used for mailing lists, where there is normally just one level of
21925 expansion.
21926
21927
21928 .option owners redirect "string list" unset
21929 .cindex "ownership" "alias file"
21930 .cindex "ownership" "forward file"
21931 .cindex "alias file" "ownership"
21932 .cindex "forward file" "ownership"
21933 This specifies a list of permitted owners for the file specified by &%file%&.
21934 This list is in addition to the local user when &%check_local_user%& is set.
21935 See &%check_owner%& above.
21936
21937
21938 .option owngroups redirect "string list" unset
21939 This specifies a list of permitted groups for the file specified by &%file%&.
21940 The list is in addition to the local user's primary group when
21941 &%check_local_user%& is set. See &%check_group%& above.
21942
21943
21944 .option pipe_transport redirect string&!! unset
21945 .vindex "&$address_pipe$&"
21946 A &(redirect)& router sets up a direct delivery to a pipe when a string
21947 starting with a vertical bar character is specified as a new &"address"&. The
21948 transport used is specified by this option, which, after expansion, must be the
21949 name of a configured transport. This should normally be a &(pipe)& transport.
21950 When the transport is run, the pipe command is in &$address_pipe$&.
21951
21952
21953 .option qualify_domain redirect string&!! unset
21954 .vindex "&$qualify_recipient$&"
21955 If this option is set, and an unqualified address (one without a domain) is
21956 generated, and that address would normally be qualified by the global setting
21957 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21958 expanding this string. If the expansion fails, the router declines. If you want
21959 to revert to the default, you can have the expansion generate
21960 &$qualify_recipient$&.
21961
21962 This option applies to all unqualified addresses generated by Exim filters,
21963 but for traditional &_.forward_& files, it applies only to addresses that are
21964 not preceded by a backslash. Sieve filters cannot generate unqualified
21965 addresses.
21966
21967 .option qualify_preserve_domain redirect boolean false
21968 .cindex "domain" "in redirection; preserving"
21969 .cindex "preserving domain in redirection"
21970 .cindex "address redirection" "domain; preserving"
21971 If this option is set, the router's local &%qualify_domain%& option must not be
21972 set (a configuration error occurs if it is). If an unqualified address (one
21973 without a domain) is generated, it is qualified with the domain of the parent
21974 address (the immediately preceding ancestor) instead of the global
21975 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21976 this applies whether or not the address is preceded by a backslash.
21977
21978
21979 .option repeat_use redirect boolean true
21980 If this option is set false, the router is skipped for a child address that has
21981 any ancestor that was routed by this router. This test happens before any of
21982 the other preconditions are tested. Exim's default anti-looping rules skip
21983 only when the ancestor is the same as the current address. See also
21984 &%check_ancestor%& above and the generic &%redirect_router%& option.
21985
21986
21987 .option reply_transport redirect string&!! unset
21988 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21989 &%vacation%& command is used in a filter file. The transport used is specified
21990 by this option, which, after expansion, must be the name of a configured
21991 transport. This should normally be an &(autoreply)& transport. Other transports
21992 are unlikely to do anything sensible or useful.
21993
21994
21995 .option rewrite redirect boolean true
21996 .cindex "address redirection" "disabling rewriting"
21997 If this option is set false, addresses generated by the router are not
21998 subject to address rewriting. Otherwise, they are treated like new addresses
21999 and are rewritten according to the global rewriting rules.
22000
22001
22002 .option sieve_subaddress redirect string&!! unset
22003 The value of this option is passed to a Sieve filter to specify the
22004 :subaddress part of an address.
22005
22006 .option sieve_useraddress redirect string&!! unset
22007 The value of this option is passed to a Sieve filter to specify the :user part
22008 of an address. However, if it is unset, the entire original local part
22009 (including any prefix or suffix) is used for :user.
22010
22011
22012 .option sieve_vacation_directory redirect string&!! unset
22013 .cindex "Sieve filter" "vacation directory"
22014 To enable the &"vacation"& extension for Sieve filters, you must set
22015 &%sieve_vacation_directory%& to the directory where vacation databases are held
22016 (do not put anything else in that directory), and ensure that the
22017 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
22018 needs their own directory; Exim will create it if necessary.
22019
22020
22021
22022 .option skip_syntax_errors redirect boolean false
22023 .cindex "forward file" "broken"
22024 .cindex "address redirection" "broken files"
22025 .cindex "alias file" "broken"
22026 .cindex "broken alias or forward files"
22027 .cindex "ignoring faulty addresses"
22028 .cindex "skipping faulty addresses"
22029 .cindex "error" "skipping bad syntax"
22030 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22031 non-filter redirection data are skipped, and each failing address is logged. If
22032 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22033 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22034 are expanded and placed at the head of the error message generated by
22035 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22036 be the same address as the generic &%errors_to%& option. The
22037 &%skip_syntax_errors%& option is often used when handling mailing lists.
22038
22039 If all the addresses in a redirection list are skipped because of syntax
22040 errors, the router declines to handle the original address, and it is passed to
22041 the following routers.
22042
22043 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22044 error in the filter causes filtering to be abandoned without any action being
22045 taken. The incident is logged, and the router declines to handle the address,
22046 so it is passed to the following routers.
22047
22048 .cindex "Sieve filter" "syntax errors in"
22049 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22050 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22051 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22052
22053 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22054 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22055 option, used with an address that does not get redirected, can be used to
22056 notify users of these errors, by means of a router like this:
22057 .code
22058 userforward:
22059   driver = redirect
22060   allow_filter
22061   check_local_user
22062   file = $home/.forward
22063   file_transport = address_file
22064   pipe_transport = address_pipe
22065   reply_transport = address_reply
22066   no_verify
22067   skip_syntax_errors
22068   syntax_errors_to = real-$local_part@$domain
22069   syntax_errors_text = \
22070    This is an automatically generated message. An error has\n\
22071    been found in your .forward file. Details of the error are\n\
22072    reported below. While this error persists, you will receive\n\
22073    a copy of this message for every message that is addressed\n\
22074    to you. If your .forward file is a filter file, or if it is\n\
22075    a non-filter file containing no valid forwarding addresses,\n\
22076    a copy of each incoming message will be put in your normal\n\
22077    mailbox. If a non-filter file contains at least one valid\n\
22078    forwarding address, forwarding to the valid addresses will\n\
22079    happen, and those will be the only deliveries that occur.
22080 .endd
22081 You also need a router to ensure that local addresses that are prefixed by
22082 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22083 put this immediately before the &(userforward)& router:
22084 .code
22085 real_localuser:
22086   driver = accept
22087   check_local_user
22088   local_part_prefix = real-
22089   transport = local_delivery
22090 .endd
22091 For security, it would probably be a good idea to restrict the use of this
22092 router to locally-generated messages, using a condition such as this:
22093 .code
22094   condition = ${if match {$sender_host_address}\
22095                          {\N^(|127\.0\.0\.1)$\N}}
22096 .endd
22097
22098
22099 .option syntax_errors_text redirect string&!! unset
22100 See &%skip_syntax_errors%& above.
22101
22102
22103 .option syntax_errors_to redirect string unset
22104 See &%skip_syntax_errors%& above.
22105 .ecindex IIDredrou1
22106 .ecindex IIDredrou2
22107
22108
22109
22110
22111
22112
22113 . ////////////////////////////////////////////////////////////////////////////
22114 . ////////////////////////////////////////////////////////////////////////////
22115
22116 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22117          "Environment for local transports"
22118 .scindex IIDenvlotra1 "local transports" "environment for"
22119 .scindex IIDenvlotra2 "environment" "local transports"
22120 .scindex IIDenvlotra3 "transport" "local; environment for"
22121 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22122 transport can be thought of as similar to a pipe.) Exim always runs transports
22123 in subprocesses, under specified uids and gids. Typical deliveries to local
22124 mailboxes run under the uid and gid of the local user.
22125
22126 Exim also sets a specific current directory while running the transport; for
22127 some transports a home directory setting is also relevant. The &(pipe)&
22128 transport is the only one that sets up environment variables; see section
22129 &<<SECTpipeenv>>& for details.
22130
22131 The values used for the uid, gid, and the directories may come from several
22132 different places. In many cases, the router that handles the address associates
22133 settings with that address as a result of its &%check_local_user%&, &%group%&,
22134 or &%user%& options. However, values may also be given in the transport's own
22135 configuration, and these override anything that comes from the router.
22136
22137
22138
22139 .section "Concurrent deliveries" "SECID131"
22140 .cindex "concurrent deliveries"
22141 .cindex "simultaneous deliveries"
22142 If two different messages for the same local recipient arrive more or less
22143 simultaneously, the two delivery processes are likely to run concurrently. When
22144 the &(appendfile)& transport is used to write to a file, Exim applies locking
22145 rules to stop concurrent processes from writing to the same file at the same
22146 time.
22147
22148 However, when you use a &(pipe)& transport, it is up to you to arrange any
22149 locking that is needed. Here is a silly example:
22150 .code
22151 my_transport:
22152   driver = pipe
22153   command = /bin/sh -c 'cat >>/some/file'
22154 .endd
22155 This is supposed to write the message at the end of the file. However, if two
22156 messages arrive at the same time, the file will be scrambled. You can use the
22157 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22158 file using the same algorithm that Exim itself uses.
22159
22160
22161
22162
22163 .section "Uids and gids" "SECTenvuidgid"
22164 .cindex "local transports" "uid and gid"
22165 .cindex "transport" "local; uid and gid"
22166 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22167 overrides any group that the router set in the address, even if &%user%& is not
22168 set for the transport. This makes it possible, for example, to run local mail
22169 delivery under the uid of the recipient (set by the router), but in a special
22170 group (set by the transport). For example:
22171 .code
22172 # Routers ...
22173 # User/group are set by check_local_user in this router
22174 local_users:
22175   driver = accept
22176   check_local_user
22177   transport = group_delivery
22178
22179 # Transports ...
22180 # This transport overrides the group
22181 group_delivery:
22182   driver = appendfile
22183   file = /var/spool/mail/$local_part_data
22184   group = mail
22185 .endd
22186 If &%user%& is set for a transport, its value overrides what is set in the
22187 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22188 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22189 set.
22190
22191 .oindex "&%initgroups%&"
22192 When the uid is taken from the transport's configuration, the &[initgroups()]&
22193 function is called for the groups associated with that uid if the
22194 &%initgroups%& option is set for the transport. When the uid is not specified
22195 by the transport, but is associated with the address by a router, the option
22196 for calling &[initgroups()]& is taken from the router configuration.
22197
22198 .cindex "&(pipe)& transport" "uid for"
22199 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22200 is set and &%user%& is not set, the uid of the process that called Exim to
22201 receive the message is used, and if &%group%& is not set, the corresponding
22202 original gid is also used.
22203
22204 This is the detailed preference order for obtaining a gid; the first of the
22205 following that is set is used:
22206
22207 .ilist
22208 A &%group%& setting of the transport;
22209 .next
22210 A &%group%& setting of the router;
22211 .next
22212 A gid associated with a user setting of the router, either as a result of
22213 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22214 .next
22215 The group associated with a non-numeric &%user%& setting of the transport;
22216 .next
22217 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22218 the uid is the creator's uid;
22219 .next
22220 The Exim gid if the Exim uid is being used as a default.
22221 .endlist
22222
22223 If, for example, the user is specified numerically on the router and there are
22224 no group settings, no gid is available. In this situation, an error occurs.
22225 This is different for the uid, for which there always is an ultimate default.
22226 The first of the following that is set is used:
22227
22228 .ilist
22229 A &%user%& setting of the transport;
22230 .next
22231 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22232 .next
22233 A &%user%& setting of the router;
22234 .next
22235 A &%check_local_user%& setting of the router;
22236 .next
22237 The Exim uid.
22238 .endlist
22239
22240 Of course, an error will still occur if the uid that is chosen is on the
22241 &%never_users%& list.
22242
22243
22244
22245
22246
22247 .section "Current and home directories" "SECID132"
22248 .cindex "current directory for local transport"
22249 .cindex "home directory" "for local transport"
22250 .cindex "transport" "local; home directory for"
22251 .cindex "transport" "local; current directory for"
22252 Routers may set current and home directories for local transports by means of
22253 the &%transport_current_directory%& and &%transport_home_directory%& options.
22254 However, if the transport's &%current_directory%& or &%home_directory%& options
22255 are set, they override the router's values. In detail, the home directory
22256 for a local transport is taken from the first of these values that is set:
22257
22258 .ilist
22259 The &%home_directory%& option on the transport;
22260 .next
22261 The &%transport_home_directory%& option on the router;
22262 .next
22263 The password data if &%check_local_user%& is set on the router;
22264 .next
22265 The &%router_home_directory%& option on the router.
22266 .endlist
22267
22268 The current directory is taken from the first of these values that is set:
22269
22270 .ilist
22271 The &%current_directory%& option on the transport;
22272 .next
22273 The &%transport_current_directory%& option on the router.
22274 .endlist
22275
22276
22277 If neither the router nor the transport sets a current directory, Exim uses the
22278 value of the home directory, if it is set. Otherwise it sets the current
22279 directory to &_/_& before running a local transport.
22280
22281
22282
22283 .section "Expansion variables derived from the address" "SECID133"
22284 .vindex "&$domain$&"
22285 .vindex "&$local_part$&"
22286 .vindex "&$original_domain$&"
22287 Normally a local delivery is handling a single address, and in that case the
22288 variables such as &$domain$& and &$local_part$& are set during local
22289 deliveries. However, in some circumstances more than one address may be handled
22290 at once (for example, while writing batch SMTP for onward transmission by some
22291 other means). In this case, the variables associated with the local part are
22292 never set, &$domain$& is set only if all the addresses have the same domain,
22293 and &$original_domain$& is never set.
22294 .ecindex IIDenvlotra1
22295 .ecindex IIDenvlotra2
22296 .ecindex IIDenvlotra3
22297
22298
22299
22300
22301
22302
22303
22304 . ////////////////////////////////////////////////////////////////////////////
22305 . ////////////////////////////////////////////////////////////////////////////
22306
22307 .chapter "Generic options for transports" "CHAPtransportgeneric"
22308 .scindex IIDgenoptra1 "generic options" "transport"
22309 .scindex IIDgenoptra2 "options" "generic; for transports"
22310 .scindex IIDgenoptra3 "transport" "generic options for"
22311 The name of a transport is limited to be &drivernamemax; ASCII characters long;
22312 prior to Exim 4.95 names would be silently truncated at this length, but now
22313 it is enforced.
22314
22315 The following generic options apply to all transports:
22316
22317
22318 .option body_only transports boolean false
22319 .cindex "transport" "body only"
22320 .cindex "message" "transporting body only"
22321 .cindex "body of message" "transporting"
22322 If this option is set, the message's headers are not transported. It is
22323 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22324 or &(pipe)& transports, the settings of &%message_prefix%& and
22325 &%message_suffix%& should be checked, because this option does not
22326 automatically suppress them.
22327
22328
22329 .option current_directory transports string&!! unset
22330 .cindex "transport" "current directory for"
22331 This specifies the current directory that is to be set while running the
22332 transport, overriding any value that may have been set by the router.
22333 If the expansion fails for any reason, including forced failure, an error is
22334 logged, and delivery is deferred.
22335
22336
22337 .option disable_logging transports boolean false
22338 If this option is set true, nothing is logged for any
22339 deliveries by the transport or for any
22340 transport errors. You should not set this option unless you really, really know
22341 what you are doing.
22342
22343
22344 .option debug_print transports string&!! unset
22345 .cindex "testing" "variables in drivers"
22346 If this option is set and debugging is enabled (see the &%-d%& command line
22347 option), the string is expanded and included in the debugging output when the
22348 transport is run.
22349 If expansion of the string fails, the error message is written to the debugging
22350 output, and Exim carries on processing.
22351 This facility is provided to help with checking out the values of variables and
22352 so on when debugging driver configurations. For example, if a &%headers_add%&
22353 option is not working properly, &%debug_print%& could be used to output the
22354 variables it references. A newline is added to the text if it does not end with
22355 one.
22356 The variables &$transport_name$& and &$router_name$& contain the name of the
22357 transport and the router that called it.
22358
22359 .option delivery_date_add transports boolean false
22360 .cindex "&'Delivery-date:'& header line"
22361 If this option is true, a &'Delivery-date:'& header is added to the message.
22362 This gives the actual time the delivery was made. As this is not a standard
22363 header, Exim has a configuration option (&%delivery_date_remove%&) which
22364 requests its removal from incoming messages, so that delivered messages can
22365 safely be resent to other recipients.
22366
22367
22368 .option driver transports string unset
22369 This specifies which of the available transport drivers is to be used.
22370 There is no default, and this option must be set for every transport.
22371
22372
22373 .option envelope_to_add transports boolean false
22374 .cindex "&'Envelope-to:'& header line"
22375 If this option is true, an &'Envelope-to:'& header is added to the message.
22376 This gives the original address(es) in the incoming envelope that caused this
22377 delivery to happen. More than one address may be present if the transport is
22378 configured to handle several addresses at once, or if more than one original
22379 address was redirected to the same final address. As this is not a standard
22380 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22381 its removal from incoming messages, so that delivered messages can safely be
22382 resent to other recipients.
22383
22384 &*Note:*& If used on a transport handling multiple recipients
22385 (the smtp transport unless &%rcpt_max%& is 1, the appendfile, pipe or lmtp
22386 transport if &%batch_max%& is greater than 1)
22387 then information about Bcc recipients will be leaked.
22388 Doing so is generally not advised.
22389
22390
22391 .option event_action transports string&!! unset
22392 .cindex events
22393 This option declares a string to be expanded for Exim's events mechanism.
22394 For details see chapter &<<CHAPevents>>&.
22395
22396
22397 .option group transports string&!! "Exim group"
22398 .cindex "transport" "group; specifying"
22399 This option specifies a gid for running the transport process, overriding any
22400 value that the router supplies, and also overriding any value associated with
22401 &%user%& (see below).
22402
22403
22404 .option headers_add transports list&!! unset
22405 .cindex "header lines" "adding in transport"
22406 .cindex "transport" "header lines; adding"
22407 This option specifies a list of text headers,
22408 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22409 which are (separately) expanded and added to the header
22410 portion of a message as it is transported, as described in section
22411 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22412 routers. If the result of the expansion is an empty string, or if the expansion
22413 is forced to fail, no action is taken. Other expansion failures are treated as
22414 errors and cause the delivery to be deferred.
22415
22416 Unlike most options, &%headers_add%& can be specified multiple times
22417 for a transport; all listed headers are added.
22418
22419
22420 .option headers_only transports boolean false
22421 .cindex "transport" "header lines only"
22422 .cindex "message" "transporting headers only"
22423 .cindex "header lines" "transporting"
22424 If this option is set, the message's body is not transported. It is mutually
22425 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22426 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22427 checked, since this option does not automatically suppress them.
22428
22429
22430 .option headers_remove transports list&!! unset
22431 .cindex "header lines" "removing"
22432 .cindex "transport" "header lines; removing"
22433 This option specifies a list of text headers,
22434 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22435 to be removed from the message.
22436 However, the option has no effect when an address is just being verified.
22437 Each list item is separately expanded.
22438 If the result of the expansion is an empty string, or if the expansion
22439 is forced to fail, no action is taken. Other expansion failures are treated as
22440 errors and cause the delivery to be deferred.
22441 If an item ends in *, it will match any header with the given prefix.
22442
22443 Matching headers are omitted from the message as it is transported, as described
22444 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22445 routers.
22446
22447 Unlike most options, &%headers_remove%& can be specified multiple times
22448 for a transport; all listed headers are removed.
22449
22450 &*Warning*&: Because of the separate expansion of the list items,
22451 items that contain a list separator must have it doubled.
22452 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22453
22454
22455
22456 .option headers_rewrite transports string unset
22457 .cindex "transport" "header lines; rewriting"
22458 .cindex "rewriting" "at transport time"
22459 This option allows addresses in header lines to be rewritten at transport time,
22460 that is, as the message is being copied to its destination. The contents of the
22461 option are a colon-separated list of rewriting rules. Each rule is in exactly
22462 the same form as one of the general rewriting rules that are applied when a
22463 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22464 example,
22465 .code
22466 headers_rewrite = a@b c@d f : \
22467                   x@y w@z
22468 .endd
22469 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22470 &'w@z'& in all address-bearing header lines. The rules are applied to the
22471 header lines just before they are written out at transport time, so they affect
22472 only those copies of the message that pass through the transport. However, only
22473 the message's original header lines, and any that were added by a system
22474 filter, are rewritten. If a router or transport adds header lines, they are not
22475 affected by this option. These rewriting rules are &'not'& applied to the
22476 envelope. You can change the return path using &%return_path%&, but you cannot
22477 change envelope recipients at this time.
22478
22479
22480 .option home_directory transports string&!! unset
22481 .cindex "transport" "home directory for"
22482 .vindex "&$home$&"
22483 This option specifies a home directory setting for a local transport,
22484 overriding any value that may be set by the router. The home directory is
22485 placed in &$home$& while expanding the transport's private options. It is also
22486 used as the current directory if no current directory is set by the
22487 &%current_directory%& option on the transport or the
22488 &%transport_current_directory%& option on the router. If the expansion fails
22489 for any reason, including forced failure, an error is logged, and delivery is
22490 deferred.
22491
22492
22493 .option initgroups transports boolean false
22494 .cindex "additional groups"
22495 .cindex "groups" "additional"
22496 .cindex "transport" "group; additional"
22497 If this option is true and the uid for the delivery process is provided by the
22498 transport, the &[initgroups()]& function is called when running the transport
22499 to ensure that any additional groups associated with the uid are set up.
22500
22501
22502 .option max_parallel transports integer&!! unset
22503 .cindex limit "transport parallelism"
22504 .cindex transport "parallel processes"
22505 .cindex transport "concurrency limit"
22506 .cindex "delivery" "parallelism for transport"
22507 If this option is set and expands to an integer greater than zero
22508 it limits the number of concurrent runs of the transport.
22509 The control does not apply to shadow transports.
22510
22511 .cindex "hints database" "transport concurrency control"
22512 Exim implements this control by means of a hints database in which a record is
22513 incremented whenever a transport process is being created. The record
22514 is decremented and possibly removed when the process terminates.
22515 Obviously there is scope for
22516 records to get left lying around if there is a system or program crash. To
22517 guard against this, Exim ignores any records that are more than six hours old.
22518
22519 If you use this option, you should also arrange to delete the
22520 relevant hints database whenever your system reboots. The names of the files
22521 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22522 may be one or two files, depending on the type of DBM in use. The same files
22523 are used for ETRN and smtp transport serialization.
22524
22525
22526 .option message_size_limit transports string&!! 0
22527 .cindex "limit" "message size per transport"
22528 .cindex "size" "of message, limit"
22529 .cindex "transport" "message size; limiting"
22530 This option controls the size of messages passed through the transport. It is
22531 expanded before use; the result of the expansion must be a sequence of decimal
22532 digits, optionally followed by K or M. If the expansion fails for any reason,
22533 including forced failure, or if the result is not of the required form,
22534 delivery is deferred. If the value is greater than zero and the size of a
22535 message exceeds this limit, the address is failed. If there is any chance that
22536 the resulting bounce message could be routed to the same transport, you should
22537 ensure that &%return_size_limit%& is less than the transport's
22538 &%message_size_limit%&, as otherwise the bounce message will fail to get
22539 delivered.
22540
22541
22542
22543 .option rcpt_include_affixes transports boolean false
22544 .cindex "prefix" "for local part, including in envelope"
22545 .cindex "suffix for local part" "including in envelope"
22546 .cindex "local part" "prefix"
22547 .cindex "local part" "suffix"
22548 When this option is false (the default), and an address that has had any
22549 affixes (prefixes or suffixes) removed from the local part is delivered by any
22550 form of SMTP or LMTP, the affixes are not included. For example, if a router
22551 that contains
22552 .code
22553 local_part_prefix = *-
22554 .endd
22555 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22556 is delivered with
22557 .code
22558 RCPT TO:<xyz@some.domain>
22559 .endd
22560 This is also the case when an ACL-time callout is being used to verify a
22561 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22562 whole local part is included in the RCPT command. This option applies to BSMTP
22563 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22564 &(lmtp)& and &(smtp)& transports.
22565
22566
22567 .option retry_use_local_part transports boolean "see below"
22568 .cindex "hints database" "retry keys"
22569 When a delivery suffers a temporary failure, a retry record is created
22570 in Exim's hints database. For remote deliveries, the key for the retry record
22571 is based on the name and/or IP address of the failing remote host. For local
22572 deliveries, the key is normally the entire address, including both the local
22573 part and the domain. This is suitable for most common cases of local delivery
22574 temporary failure &-- for example, exceeding a mailbox quota should delay only
22575 deliveries to that mailbox, not to the whole domain.
22576
22577 However, in some special cases you may want to treat a temporary local delivery
22578 as a failure associated with the domain, and not with a particular local part.
22579 (For example, if you are storing all mail for some domain in files.) You can do
22580 this by setting &%retry_use_local_part%& false.
22581
22582 For all the local transports, its default value is true. For remote transports,
22583 the default value is false for tidiness, but changing the value has no effect
22584 on a remote transport in the current implementation.
22585
22586
22587 .option return_path transports string&!! unset
22588 .cindex "envelope sender"
22589 .cindex "envelope from"
22590 .cindex "transport" "return path; changing"
22591 .cindex "return path" "changing in transport"
22592 If this option is set, the string is expanded at transport time and replaces
22593 the existing return path (envelope sender) value in the copy of the message
22594 that is being delivered. An empty return path is permitted. This feature is
22595 designed for remote deliveries, where the value of this option is used in the
22596 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22597 only effect is to change the address that is placed in the &'Return-path:'&
22598 header line, if one is added to the message (see the next option).
22599
22600 &*Note:*& A changed return path is not logged unless you add
22601 &%return_path_on_delivery%& to the log selector.
22602
22603 .vindex "&$return_path$&"
22604 The expansion can refer to the existing value via &$return_path$&. This is
22605 either the message's envelope sender, or an address set by the
22606 &%errors_to%& option on a router. If the expansion is forced to fail, no
22607 replacement occurs; if it fails for another reason, delivery is deferred. This
22608 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22609 section &<<SECTverp>>&.
22610
22611 &*Note*&: If a delivery error is detected locally, including the case when a
22612 remote server rejects a message at SMTP time, the bounce message is not sent to
22613 the value of this option. It is sent to the previously set errors address.
22614 This defaults to the incoming sender address, but can be changed by setting
22615 &%errors_to%& in a router.
22616
22617
22618
22619 .option return_path_add transports boolean false
22620 .chindex Return-path:
22621 If this option is true, a &'Return-path:'& header is added to the message.
22622 Although the return path is normally available in the prefix line of BSD
22623 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22624 have easy access to it.
22625
22626 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22627 the delivery SMTP server makes the final delivery"&. This implies that this
22628 header should not be present in incoming messages. Exim has a configuration
22629 option, &%return_path_remove%&, which requests removal of this header from
22630 incoming messages, so that delivered messages can safely be resent to other
22631 recipients.
22632
22633
22634 .option shadow_condition transports string&!! unset
22635 See &%shadow_transport%& below.
22636
22637
22638 .option shadow_transport transports string unset
22639 .cindex "shadow transport"
22640 .cindex "transport" "shadow"
22641 A local transport may set the &%shadow_transport%& option to the name of
22642 another local transport. Shadow remote transports are not supported.
22643
22644 Whenever a delivery to the main transport succeeds, and either
22645 &%shadow_condition%& is unset, or its expansion does not result in the empty
22646 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22647 passed to the shadow transport, with the same delivery address or addresses. If
22648 expansion fails, no action is taken except that non-forced expansion failures
22649 cause a log line to be written.
22650
22651 The result of the shadow transport is discarded and does not affect the
22652 subsequent processing of the message. Only a single level of shadowing is
22653 provided; the &%shadow_transport%& option is ignored on any transport when it
22654 is running as a shadow. Options concerned with output from pipes are also
22655 ignored. The log line for the successful delivery has an item added on the end,
22656 of the form
22657 .code
22658 ST=<shadow transport name>
22659 .endd
22660 If the shadow transport did not succeed, the error message is put in
22661 parentheses afterwards. Shadow transports can be used for a number of different
22662 purposes, including keeping more detailed log information than Exim normally
22663 provides, and implementing automatic acknowledgment policies based on message
22664 headers that some sites insist on.
22665
22666
22667 .option transport_filter transports string&!! unset
22668 .cindex "transport" "filter"
22669 .cindex "filter" "transport filter"
22670 This option sets up a filtering (in the Unix shell sense) process for messages
22671 at transport time. It should not be confused with mail filtering as set up by
22672 individual users or via a system filter.
22673 If unset, or expanding to an empty string, no filtering is done.
22674
22675 When the message is about to be written out, the command specified by
22676 &%transport_filter%& is started up in a separate, parallel process, and
22677 the entire message, including the header lines, is passed to it on its standard
22678 input (this in fact is done from a third process, to avoid deadlock). The
22679 command must be specified as an absolute path.
22680
22681 The lines of the message that are written to the transport filter are
22682 terminated by newline (&"\n"&). The message is passed to the filter before any
22683 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22684 lines beginning with a dot, and also before any processing implied by the
22685 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22686 &(pipe)& transports.
22687
22688 The standard error for the filter process is set to the same destination as its
22689 standard output; this is read and written to the message's ultimate
22690 destination. The process that writes the message to the filter, the
22691 filter itself, and the original process that reads the result and delivers it
22692 are all run in parallel, like a shell pipeline.
22693
22694 The filter can perform any transformations it likes, but of course should take
22695 care not to break RFC 2822 syntax. Exim does not check the result, except to
22696 test for a final newline when SMTP is in use. All messages transmitted over
22697 SMTP must end with a newline, so Exim supplies one if it is missing.
22698
22699 .cindex "content scanning" "per user"
22700 A transport filter can be used to provide content-scanning on a per-user basis
22701 at delivery time if the only required effect of the scan is to modify the
22702 message. For example, a content scan could insert a new header line containing
22703 a spam score. This could be interpreted by a filter in the user's MUA. It is
22704 not possible to discard a message at this stage.
22705
22706 .cindex "SIZE" "ESMTP extension"
22707 A problem might arise if the filter increases the size of a message that is
22708 being sent down an SMTP connection. If the receiving SMTP server has indicated
22709 support for the SIZE parameter, Exim will have sent the size of the message
22710 at the start of the SMTP session. If what is actually sent is substantially
22711 more, the server might reject the message. This can be worked round by setting
22712 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22713 additions to the message, or to disable the use of SIZE altogether.
22714
22715 .vindex "&$pipe_addresses$&"
22716 The value of the &%transport_filter%& option is the command string for starting
22717 the filter, which is run directly from Exim, not under a shell. The string is
22718 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22719 Exim breaks it up into arguments and then expands each argument separately (see
22720 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22721 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22722 of arguments, one for each address that applies to this delivery. (This isn't
22723 an ideal name for this feature here, but as it was already implemented for the
22724 &(pipe)& transport, it seemed sensible not to change it.)
22725
22726 .vindex "&$host$&"
22727 .vindex "&$host_address$&"
22728 The expansion variables &$host$& and &$host_address$& are available when the
22729 transport is a remote one. They contain the name and IP address of the host to
22730 which the message is being sent. For example:
22731 . used to have $sender_address in this cmdline, but it's tainted
22732 .code
22733 transport_filter = /some/directory/transport-filter.pl \
22734   $host $host_address $pipe_addresses
22735 .endd
22736
22737 Two problems arise if you want to use more complicated expansion items to
22738 generate transport filter commands, both of which due to the fact that the
22739 command is split up &'before'& expansion.
22740 .ilist
22741 If an expansion item contains white space, you must quote it, so that it is all
22742 part of the same command item. If the entire option setting is one such
22743 expansion item, you have to take care what kind of quoting you use. For
22744 example:
22745 .code
22746 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22747 .endd
22748 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22749 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22750 stripped by Exim when it read the option's value. When the value is used, if
22751 the single quotes were missing, the line would be split into two items,
22752 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22753 Exim tried to expand the first one.
22754 .next
22755 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22756 expansion cannot generate multiple arguments, or a command name followed by
22757 arguments. Consider this example:
22758 .code
22759 transport_filter = ${lookup{$host}lsearch{/a/file}\
22760                     {$value}{/bin/cat}}
22761 .endd
22762 The result of the lookup is interpreted as the name of the command, even
22763 if it contains white space. The simplest way round this is to use a shell:
22764 .code
22765 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22766                                {$value}{/bin/cat}}
22767 .endd
22768 .endlist
22769
22770 The filter process is run under the same uid and gid as the normal delivery.
22771 For remote deliveries this is the Exim uid/gid by default. The command should
22772 normally yield a zero return code. Transport filters are not supposed to fail.
22773 A non-zero code is taken to mean that the transport filter encountered some
22774 serious problem. Delivery of the message is deferred; the message remains on
22775 the queue and is tried again later. It is not possible to cause a message to be
22776 bounced from a transport filter.
22777
22778 If a transport filter is set on an autoreply transport, the original message is
22779 passed through the filter as it is being copied into the newly generated
22780 message, which happens if the &%return_message%& option is set.
22781
22782
22783 .option transport_filter_timeout transports time 5m
22784 .cindex "transport" "filter, timeout"
22785 When Exim is reading the output of a transport filter, it applies a timeout
22786 that can be set by this option. Exceeding the timeout is normally treated as a
22787 temporary delivery failure. However, if a transport filter is used with a
22788 &(pipe)& transport, a timeout in the transport filter is treated in the same
22789 way as a timeout in the pipe command itself. By default, a timeout is a hard
22790 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22791 becomes a temporary error.
22792
22793
22794 .option user transports string&!! "Exim user"
22795 .cindex "uid (user id)" "local delivery"
22796 .cindex "transport" "user, specifying"
22797 This option specifies the user under whose uid the delivery process is to be
22798 run, overriding any uid that may have been set by the router. If the user is
22799 given as a name, the uid is looked up from the password data, and the
22800 associated group is taken as the value of the gid to be used if the &%group%&
22801 option is not set.
22802
22803 For deliveries that use local transports, a user and group are normally
22804 specified explicitly or implicitly (for example, as a result of
22805 &%check_local_user%&) by the router or transport.
22806
22807 .cindex "hints database" "access by remote transport"
22808 For remote transports, you should leave this option unset unless you really are
22809 sure you know what you are doing. When a remote transport is running, it needs
22810 to be able to access Exim's hints databases, because each host may have its own
22811 retry data.
22812 .ecindex IIDgenoptra1
22813 .ecindex IIDgenoptra2
22814 .ecindex IIDgenoptra3
22815
22816
22817
22818
22819
22820
22821 . ////////////////////////////////////////////////////////////////////////////
22822 . ////////////////////////////////////////////////////////////////////////////
22823
22824 .chapter "Address batching in local transports" "CHAPbatching" &&&
22825          "Address batching"
22826 .cindex "transport" "local; address batching in"
22827 The only remote transport (&(smtp)&) is normally configured to handle more than
22828 one address at a time, so that when several addresses are routed to the same
22829 remote host, just one copy of the message is sent. Local transports, however,
22830 normally handle one address at a time. That is, a separate instance of the
22831 transport is run for each address that is routed to the transport. A separate
22832 copy of the message is delivered each time.
22833
22834 .cindex "batched local delivery"
22835 .oindex "&%batch_max%&"
22836 .oindex "&%batch_id%&"
22837 In special cases, it may be desirable to handle several addresses at once in a
22838 local transport, for example:
22839
22840 .ilist
22841 In an &(appendfile)& transport, when storing messages in files for later
22842 delivery by some other means, a single copy of the message with multiple
22843 recipients saves space.
22844 .next
22845 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22846 a single copy saves time, and is the normal way LMTP is expected to work.
22847 .next
22848 In a &(pipe)& transport, when passing the message
22849 to a scanner program or
22850 to some other delivery mechanism such as UUCP, multiple recipients may be
22851 acceptable.
22852 .endlist
22853
22854 These three local transports all have the same options for controlling multiple
22855 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22856 repeating the information for each transport, these options are described here.
22857
22858 The &%batch_max%& option specifies the maximum number of addresses that can be
22859 delivered together in a single run of the transport. Its default value is one
22860 (no batching). When more than one address is routed to a transport that has a
22861 &%batch_max%& value greater than one, the addresses are delivered in a batch
22862 (that is, in a single run of the transport with multiple recipients), subject
22863 to certain conditions:
22864
22865 .ilist
22866 .vindex "&$local_part$&"
22867 If any of the transport's options contain a reference to &$local_part$&, no
22868 batching is possible.
22869 .next
22870 .vindex "&$domain$&"
22871 If any of the transport's options contain a reference to &$domain$&, only
22872 addresses with the same domain are batched.
22873 .next
22874 .cindex "customizing" "batching condition"
22875 If &%batch_id%& is set, it is expanded for each address, and only those
22876 addresses with the same expanded value are batched. This allows you to specify
22877 customized batching conditions. Failure of the expansion for any reason,
22878 including forced failure, disables batching, but it does not stop the delivery
22879 from taking place.
22880 .next
22881 Batched addresses must also have the same errors address (where to send
22882 delivery errors), the same header additions and removals, the same user and
22883 group for the transport, and if a host list is present, the first host must
22884 be the same.
22885 .endlist
22886
22887 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22888 both when the file or pipe command is specified in the transport, and when it
22889 is specified by a &(redirect)& router, but all the batched addresses must of
22890 course be routed to the same file or pipe command. These two transports have an
22891 option called &%use_bsmtp%&, which causes them to deliver the message in
22892 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22893 &%check_string%& and &%escape_string%& options are forced to the values
22894 .code
22895 check_string = "."
22896 escape_string = ".."
22897 .endd
22898 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22899 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22900 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22901
22902 .cindex "&'Envelope-to:'& header line"
22903 If the generic &%envelope_to_add%& option is set for a batching transport, the
22904 &'Envelope-to:'& header that is added to the message contains all the addresses
22905 that are being processed together. If you are using a batching &(appendfile)&
22906 transport without &%use_bsmtp%&, the only way to preserve the recipient
22907 addresses is to set the &%envelope_to_add%& option.
22908
22909 .cindex "&(pipe)& transport" "with multiple addresses"
22910 .vindex "&$pipe_addresses$&"
22911 If you are using a &(pipe)& transport without BSMTP, and setting the
22912 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22913 the command. This is not a true variable; it is a bit of magic that causes each
22914 of the recipient addresses to be inserted into the command as a separate
22915 argument. This provides a way of accessing all the addresses that are being
22916 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22917 are specified by a &(redirect)& router.
22918
22919
22920
22921
22922 . ////////////////////////////////////////////////////////////////////////////
22923 . ////////////////////////////////////////////////////////////////////////////
22924
22925 .chapter "The appendfile transport" "CHAPappendfile"
22926 .scindex IIDapptra1 "&(appendfile)& transport"
22927 .scindex IIDapptra2 "transports" "&(appendfile)&"
22928 .cindex "directory creation"
22929 .cindex "creating directories"
22930 The &(appendfile)& transport delivers a message by appending it to an existing
22931 file, or by creating an entirely new file in a specified directory. Single
22932 files to which messages are appended can be in the traditional Unix mailbox
22933 format, or optionally in the MBX format supported by the Pine MUA and
22934 University of Washington IMAP daemon, &'inter alia'&. When each message is
22935 being delivered as a separate file, &"maildir"& format can optionally be used
22936 to give added protection against failures that happen part-way through the
22937 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22938 supported. For all file formats, Exim attempts to create as many levels of
22939 directory as necessary, provided that &%create_directory%& is set.
22940
22941 The code for the optional formats is not included in the Exim binary by
22942 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22943 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22944 included.
22945
22946 .cindex "quota" "system"
22947 Exim recognizes system quota errors, and generates an appropriate message. Exim
22948 also supports its own quota control within the transport, for use when the
22949 system facility is unavailable or cannot be used for some reason.
22950
22951 If there is an error while appending to a file (for example, quota exceeded or
22952 partition filled), Exim attempts to reset the file's length and last
22953 modification time back to what they were before. If there is an error while
22954 creating an entirely new file, the new file is removed.
22955
22956 Before appending to a file, a number of security checks are made, and the
22957 file is locked. A detailed description is given below, after the list of
22958 private options.
22959
22960 The &(appendfile)& transport is most commonly used for local deliveries to
22961 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22962 putting messages into files for remote delivery by some means other than Exim.
22963 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22964 option).
22965
22966
22967
22968 .section "The file and directory options" "SECTfildiropt"
22969 The &%file%& option specifies a single file, to which the message is appended;
22970 the &%directory%& option specifies a directory, in which a new file containing
22971 the message is created. Only one of these two options can be set, and for
22972 normal deliveries to mailboxes, one of them &'must'& be set.
22973
22974 .vindex "&$address_file$&"
22975 .vindex "&$local_part$&"
22976 However, &(appendfile)& is also used for delivering messages to files or
22977 directories whose names (or parts of names) are obtained from alias,
22978 forwarding, or filtering operations (for example, a &%save%& command in a
22979 user's Exim filter). When such a transport is running, &$local_part$& contains
22980 the local part that was aliased or forwarded, and &$address_file$& contains the
22981 name (or partial name) of the file or directory generated by the redirection
22982 operation. There are two cases:
22983
22984 .ilist
22985 If neither &%file%& nor &%directory%& is set, the redirection operation
22986 must specify an absolute path (one that begins with &`/`&). This is the most
22987 common case when users with local accounts use filtering to sort mail into
22988 different folders. See for example, the &(address_file)& transport in the
22989 default configuration. If the path ends with a slash, it is assumed to be the
22990 name of a directory. A delivery to a directory can also be forced by setting
22991 &%maildir_format%& or &%mailstore_format%&.
22992 .next
22993 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22994 used to determine the file or directory name for the delivery. Normally, the
22995 contents of &$address_file$& are used in some way in the string expansion.
22996 .endlist
22997 If the &%create_file%& option is set to a path which
22998 matches (see the option definition below for details)
22999 a file or directory name
23000 for the delivery, that name becomes de-tainted.
23001
23002 .cindex "tainted data" "in filenames"
23003 .cindex appendfile "tainted data"
23004 Tainted data may not be used for a file or directory name.
23005 This means that, for instance, &$local_part$& cannot be used directly
23006 as a component of a path.  It can however be used as the key for a lookup
23007 which returns a path (or component).
23008
23009
23010 .cindex "Sieve filter" "configuring &(appendfile)&"
23011 .cindex "Sieve filter" "relative mailbox path handling"
23012 As an example of the second case, consider an environment where users do not
23013 have home directories. They may be permitted to use Exim filter commands of the
23014 form:
23015 .code
23016 save folder23
23017 .endd
23018 or Sieve filter commands of the form:
23019 .code
23020 require "fileinto";
23021 fileinto "folder23";
23022 .endd
23023 In this situation, the expansion of &%file%& or &%directory%& in the transport
23024 must transform the relative path into an appropriate absolute filename. In the
23025 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
23026 is used as a result of a &"keep"& action in the filter. This example shows one
23027 way of handling this requirement:
23028 .code
23029 file = ${if eq{$address_file}{inbox} \
23030             {/var/mail/$local_part_data} \
23031             {${if eq{${substr_0_1:$address_file}}{/} \
23032                   {$address_file} \
23033                   {$home/mail/$address_file} \
23034             }} \
23035        }
23036 .endd
23037 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
23038 location, absolute paths are used without change, and other folders are in the
23039 &_mail_& directory within the home directory.
23040
23041 &*Note 1*&: While processing an Exim filter, a relative path such as
23042 &_folder23_& is turned into an absolute path if a home directory is known to
23043 the router. In particular, this is the case if &%check_local_user%& is set. If
23044 you want to prevent this happening at routing time, you can set
23045 &%router_home_directory%& empty. This forces the router to pass the relative
23046 path to the transport.
23047
23048 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23049 the &%file%& or &%directory%& option is still used if it is set.
23050
23051
23052
23053
23054 .section "Private options for appendfile" "SECID134"
23055 .cindex "options" "&(appendfile)& transport"
23056
23057
23058
23059 .option allow_fifo appendfile boolean false
23060 .cindex "fifo (named pipe)"
23061 .cindex "named pipe (fifo)"
23062 .cindex "pipe" "named (fifo)"
23063 Setting this option permits delivery to named pipes (FIFOs) as well as to
23064 regular files. If no process is reading the named pipe at delivery time, the
23065 delivery is deferred.
23066
23067
23068 .option allow_symlink appendfile boolean false
23069 .cindex "symbolic link" "to mailbox"
23070 .cindex "mailbox" "symbolic link"
23071 By default, &(appendfile)& will not deliver if the path name for the file is
23072 that of a symbolic link. Setting this option relaxes that constraint, but there
23073 are security issues involved in the use of symbolic links. Be sure you know
23074 what you are doing if you set this. Details of exactly what this option affects
23075 are included in the discussion which follows this list of options.
23076
23077
23078 .option batch_id appendfile string&!! unset
23079 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23080 However, batching is automatically disabled for &(appendfile)& deliveries that
23081 happen as a result of forwarding or aliasing or other redirection directly to a
23082 file.
23083
23084
23085 .option batch_max appendfile integer 1
23086 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23087
23088
23089 .option check_group appendfile boolean false
23090 When this option is set, the group owner of the file defined by the &%file%&
23091 option is checked to see that it is the same as the group under which the
23092 delivery process is running. The default setting is false because the default
23093 file mode is 0600, which means that the group is irrelevant.
23094
23095
23096 .option check_owner appendfile boolean true
23097 When this option is set, the owner of the file defined by the &%file%& option
23098 is checked to ensure that it is the same as the user under which the delivery
23099 process is running.
23100
23101
23102 .option check_string appendfile string "see below"
23103 .cindex "&""From""& line"
23104 As &(appendfile)& writes the message, the start of each line is tested for
23105 matching &%check_string%&, and if it does, the initial matching characters are
23106 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23107 a literal string, not a regular expression, and the case of any letters it
23108 contains is significant.
23109
23110 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23111 are forced to &"."& and &".."& respectively, and any settings in the
23112 configuration are ignored. Otherwise, they default to &"From&~"& and
23113 &">From&~"& when the &%file%& option is set, and unset when any of the
23114 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23115
23116 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23117 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23118 &"From&~"& indicates the start of a new message. All four options need changing
23119 if another format is used. For example, to deliver to mailboxes in MMDF format:
23120 .cindex "MMDF format mailbox"
23121 .cindex "mailbox" "MMDF format"
23122 .code
23123 check_string = "\1\1\1\1\n"
23124 escape_string = "\1\1\1\1 \n"
23125 message_prefix = "\1\1\1\1\n"
23126 message_suffix = "\1\1\1\1\n"
23127 .endd
23128 .option create_directory appendfile boolean true
23129 .cindex "directory creation"
23130 When this option is true, Exim attempts to create any missing superior
23131 directories for the file that it is about to write. A created directory's mode
23132 is given by the &%directory_mode%& option.
23133
23134 The group ownership of a newly created directory is highly dependent on the
23135 operating system (and possibly the file system) that is being used. For
23136 example, in Solaris, if the parent directory has the setgid bit set, its group
23137 is propagated to the child; if not, the currently set group is used. However,
23138 in FreeBSD, the parent's group is always used.
23139
23140
23141
23142 .option create_file appendfile string anywhere
23143 This option constrains the location of files and directories that are created
23144 by this transport. It applies to files defined by the &%file%& option and
23145 directories defined by the &%directory%& option. In the case of maildir
23146 delivery, it applies to the top level directory, not the maildir directories
23147 beneath.
23148
23149 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23150 &"belowhome"&, or to an absolute path.
23151
23152 In the second and third cases, a home directory must have been
23153 set for the transport, and the file or directory being created must
23154 reside within it.
23155 The "belowhome" checking additionally checks for attempts to use "../"
23156 to evade the testing.
23157 This option is not useful when an explicit filename is
23158 given for normal mailbox deliveries. It is intended for the case when filenames
23159 are generated from users' &_.forward_& files. These are usually handled
23160 by an &(appendfile)& transport called &%address_file%&. See also
23161 &%file_must_exist%&.
23162
23163 In the fourth case,
23164 the value given for this option must be an absolute path for an
23165 existing directory.
23166 The value is used for checking instead of a home directory;
23167 checking is done in "belowhome" mode.
23168
23169 .cindex "tainted data" "de-tainting"
23170 .cindex "de-tainting" "using appendfile create_file option"
23171 If "belowhome" checking is used, the file or directory path
23172 becomes de-tainted.
23173
23174
23175 .option directory appendfile string&!! unset
23176 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23177 or &%directory%& must be set, unless the delivery is the direct result of a
23178 redirection (see section &<<SECTfildiropt>>&).
23179
23180 When &%directory%& is set, the string is expanded, and the message is delivered
23181 into a new file or files in or below the given directory, instead of being
23182 appended to a single mailbox file. A number of different formats are provided
23183 (see &%maildir_format%& and &%mailstore_format%&), and see section
23184 &<<SECTopdir>>& for further details of this form of delivery.
23185
23186 The result of expansion must not be tainted, unless the &%create_file%& option
23187 specifies a path.
23188
23189
23190 .option directory_file appendfile string&!! "see below"
23191 .cindex "base62"
23192 .vindex "&$inode$&"
23193 When &%directory%& is set, but neither &%maildir_format%& nor
23194 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23195 whose name is obtained by expanding this string. The default value is:
23196 .code
23197 q${base62:$tod_epoch}-$inode
23198 .endd
23199 This generates a unique name from the current time, in base 62 form, and the
23200 inode of the file. The variable &$inode$& is available only when expanding this
23201 option.
23202
23203
23204 .option directory_mode appendfile "octal integer" 0700
23205 If &(appendfile)& creates any directories as a result of the
23206 &%create_directory%& option, their mode is specified by this option.
23207
23208
23209 .option escape_string appendfile string "see description"
23210 See &%check_string%& above.
23211
23212
23213 .option file appendfile string&!! unset
23214 This option is mutually exclusive with the &%directory%& option, but one of
23215 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23216 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23217 specifies a single file, to which the message is appended. One or more of
23218 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23219 &%file%&.
23220
23221 The result of expansion must not be tainted, unless the &%create_file%& option
23222 specifies a path.
23223
23224 .cindex "NFS" "lock file"
23225 .cindex "locking files"
23226 .cindex "lock files"
23227 If you are using more than one host to deliver over NFS into the same
23228 mailboxes, you should always use lock files.
23229
23230 The string value is expanded for each delivery, and must yield an absolute
23231 path. The most common settings of this option are variations on one of these
23232 examples:
23233 .code
23234 file = /var/spool/mail/$local_part_data
23235 file = /home/$local_part_data/inbox
23236 file = $home/inbox
23237 .endd
23238 .cindex "&""sticky""& bit"
23239 In the first example, all deliveries are done into the same directory. If Exim
23240 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23241 create a file in the directory, so the &"sticky"& bit must be turned on for
23242 deliveries to be possible, or alternatively the &%group%& option can be used to
23243 run the delivery under a group id which has write access to the directory.
23244
23245
23246
23247 .option file_format appendfile string unset
23248 .cindex "file" "mailbox; checking existing format"
23249 This option requests the transport to check the format of an existing file
23250 before adding to it. The check consists of matching a specific string at the
23251 start of the file. The value of the option consists of an even number of
23252 colon-separated strings. The first of each pair is the test string, and the
23253 second is the name of a transport. If the transport associated with a matched
23254 string is not the current transport, control is passed over to the other
23255 transport. For example, suppose the standard &(local_delivery)& transport has
23256 this added to it:
23257 .code
23258 file_format = "From       : local_delivery :\
23259                \1\1\1\1\n : local_mmdf_delivery"
23260 .endd
23261 Mailboxes that begin with &"From"& are still handled by this transport, but if
23262 a mailbox begins with four binary ones followed by a newline, control is passed
23263 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23264 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23265 is assumed to match the current transport. If the start of a mailbox doesn't
23266 match any string, or if the transport named for a given string is not defined,
23267 delivery is deferred.
23268
23269
23270 .option file_must_exist appendfile boolean false
23271 If this option is true, the file specified by the &%file%& option must exist.
23272 A temporary error occurs if it does not, causing delivery to be deferred.
23273 If this option is false, the file is created if it does not exist.
23274
23275
23276 .option lock_fcntl_timeout appendfile time 0s
23277 .cindex "timeout" "mailbox locking"
23278 .cindex "mailbox" "locking, blocking and non-blocking"
23279 .cindex "locking files"
23280 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23281 when locking an open mailbox file. If the call fails, the delivery process
23282 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23283 Non-blocking calls are used so that the file is not kept open during the wait
23284 for the lock; the reason for this is to make it as safe as possible for
23285 deliveries over NFS in the case when processes might be accessing an NFS
23286 mailbox without using a lock file. This should not be done, but
23287 misunderstandings and hence misconfigurations are not unknown.
23288
23289 On a busy system, however, the performance of a non-blocking lock approach is
23290 not as good as using a blocking lock with a timeout. In this case, the waiting
23291 is done inside the system call, and Exim's delivery process acquires the lock
23292 and can proceed as soon as the previous lock holder releases it.
23293
23294 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23295 timeout, are used. There may still be some retrying: the maximum number of
23296 retries is
23297 .code
23298 (lock_retries * lock_interval) / lock_fcntl_timeout
23299 .endd
23300 rounded up to the next whole number. In other words, the total time during
23301 which &(appendfile)& is trying to get a lock is roughly the same, unless
23302 &%lock_fcntl_timeout%& is set very large.
23303
23304 You should consider setting this option if you are getting a lot of delayed
23305 local deliveries because of errors of the form
23306 .code
23307 failed to lock mailbox /some/file (fcntl)
23308 .endd
23309
23310 .option lock_flock_timeout appendfile time 0s
23311 This timeout applies to file locking when using &[flock()]& (see
23312 &%use_flock%&); the timeout operates in a similar manner to
23313 &%lock_fcntl_timeout%&.
23314
23315
23316 .option lock_interval appendfile time 3s
23317 This specifies the time to wait between attempts to lock the file. See below
23318 for details of locking.
23319
23320
23321 .option lock_retries appendfile integer 10
23322 This specifies the maximum number of attempts to lock the file. A value of zero
23323 is treated as 1. See below for details of locking.
23324
23325
23326 .option lockfile_mode appendfile "octal integer" 0600
23327 This specifies the mode of the created lock file, when a lock file is being
23328 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23329
23330
23331 .option lockfile_timeout appendfile time 30m
23332 .cindex "timeout" "mailbox locking"
23333 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23334 exists and is older than this value, it is assumed to have been left behind by
23335 accident, and Exim attempts to remove it.
23336
23337
23338 .option mailbox_filecount appendfile string&!! unset
23339 .cindex "mailbox" "specifying size of"
23340 .cindex "size" "of mailbox"
23341 If this option is set, it is expanded, and the result is taken as the current
23342 number of files in the mailbox. It must be a decimal number, optionally
23343 followed by K or M. This provides a way of obtaining this information from an
23344 external source that maintains the data.
23345
23346
23347 .option mailbox_size appendfile string&!! unset
23348 .cindex "mailbox" "specifying size of"
23349 .cindex "size" "of mailbox"
23350 If this option is set, it is expanded, and the result is taken as the current
23351 size the mailbox. It must be a decimal number, optionally followed by K or M.
23352 This provides a way of obtaining this information from an external source that
23353 maintains the data. This is likely to be helpful for maildir deliveries where
23354 it is computationally expensive to compute the size of a mailbox.
23355
23356
23357
23358 .option maildir_format appendfile boolean false
23359 .cindex "maildir format" "specifying"
23360 If this option is set with the &%directory%& option, the delivery is into a new
23361 file, in the &"maildir"& format that is used by other mail software. When the
23362 transport is activated directly from a &(redirect)& router (for example, the
23363 &(address_file)& transport in the default configuration), setting
23364 &%maildir_format%& causes the path received from the router to be treated as a
23365 directory, whether or not it ends with &`/`&. This option is available only if
23366 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23367 &<<SECTmaildirdelivery>>& below for further details.
23368
23369
23370 .option maildir_quota_directory_regex appendfile string "See below"
23371 .cindex "maildir format" "quota; directories included in"
23372 .cindex "quota" "maildir; directories included in"
23373 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23374 a regular expression for specifying directories, relative to the quota
23375 directory (see &%quota_directory%&), that should be included in the quota
23376 calculation. The default value is:
23377 .code
23378 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23379 .endd
23380 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23381 (directories whose names begin with a dot). If you want to exclude the
23382 &_Trash_&
23383 folder from the count (as some sites do), you need to change this setting to
23384 .code
23385 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23386 .endd
23387 This uses a negative lookahead in the regular expression to exclude the
23388 directory whose name is &_.Trash_&. When a directory is excluded from quota
23389 calculations, quota processing is bypassed for any messages that are delivered
23390 directly into that directory.
23391
23392
23393 .option maildir_retries appendfile integer 10
23394 This option specifies the number of times to retry when writing a file in
23395 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23396
23397
23398 .option maildir_tag appendfile string&!! unset
23399 This option applies only to deliveries in maildir format, and is described in
23400 section &<<SECTmaildirdelivery>>& below.
23401
23402
23403 .option maildir_use_size_file appendfile&!! boolean false
23404 .cindex "maildir format" "&_maildirsize_& file"
23405 The result of string expansion for this option must be a valid boolean value.
23406 If it is true, it enables support for &_maildirsize_& files. Exim
23407 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23408 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23409 value is zero. See &%maildir_quota_directory_regex%& above and section
23410 &<<SECTmaildirdelivery>>& below for further details.
23411
23412 .option maildirfolder_create_regex appendfile string unset
23413 .cindex "maildir format" "&_maildirfolder_& file"
23414 .cindex "&_maildirfolder_&, creating"
23415 The value of this option is a regular expression. If it is unset, it has no
23416 effect. Otherwise, before a maildir delivery takes place, the pattern is
23417 matched against the name of the maildir directory, that is, the directory
23418 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23419 delivery. If there is a match, Exim checks for the existence of a file called
23420 &_maildirfolder_& in the directory, and creates it if it does not exist.
23421 See section &<<SECTmaildirdelivery>>& for more details.
23422
23423
23424 .option mailstore_format appendfile boolean false
23425 .cindex "mailstore format" "specifying"
23426 If this option is set with the &%directory%& option, the delivery is into two
23427 new files in  &"mailstore"& format. The option is available only if
23428 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23429 below for further details.
23430
23431
23432 .option mailstore_prefix appendfile string&!! unset
23433 This option applies only to deliveries in mailstore format, and is described in
23434 section &<<SECTopdir>>& below.
23435
23436
23437 .option mailstore_suffix appendfile string&!! unset
23438 This option applies only to deliveries in mailstore format, and is described in
23439 section &<<SECTopdir>>& below.
23440
23441
23442 .option mbx_format appendfile boolean false
23443 .cindex "locking files"
23444 .cindex "file" "locking"
23445 .cindex "file" "MBX format"
23446 .cindex "MBX format, specifying"
23447 This option is available only if Exim has been compiled with SUPPORT_MBX
23448 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23449 the message is appended to the mailbox file in MBX format instead of
23450 traditional Unix format. This format is supported by Pine4 and its associated
23451 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23452
23453 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23454 automatically changed by the use of &%mbx_format%&. They should normally be set
23455 empty when using MBX format, so this option almost always appears in this
23456 combination:
23457 .code
23458 mbx_format = true
23459 message_prefix =
23460 message_suffix =
23461 .endd
23462 If none of the locking options are mentioned in the configuration,
23463 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23464 is possible to specify the other kinds of locking with &%mbx_format%&, but
23465 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23466 interworks with &'c-client'&, providing for shared access to the mailbox. It
23467 should not be used if any program that does not use this form of locking is
23468 going to access the mailbox, nor should it be used if the mailbox file is NFS
23469 mounted, because it works only when the mailbox is accessed from a single host.
23470
23471 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23472 the standard version of &'c-client'&, because as long as it has a mailbox open
23473 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23474 append messages to it.
23475
23476
23477 .option message_prefix appendfile string&!! "see below"
23478 .cindex "&""From""& line"
23479 The string specified here is expanded and output at the start of every message.
23480 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23481 in which case it is:
23482 .code
23483 message_prefix = "From ${if def:return_path{$return_path}\
23484   {MAILER-DAEMON}} $tod_bsdinbox\n"
23485 .endd
23486 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23487 &`\n`& to &`\r\n`& in &%message_prefix%&.
23488
23489 .option message_suffix appendfile string&!! "see below"
23490 The string specified here is expanded and output at the end of every message.
23491 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23492 in which case it is a single newline character. The suffix can be suppressed by
23493 setting
23494 .code
23495 message_suffix =
23496 .endd
23497 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23498 &`\n`& to &`\r\n`& in &%message_suffix%&.
23499
23500 .option mode appendfile "octal integer" 0600
23501 If the output file is created, it is given this mode. If it already exists and
23502 has wider permissions, they are reduced to this mode. If it has narrower
23503 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23504 if the delivery is the result of a &%save%& command in a filter file specifying
23505 a particular mode, the mode of the output file is always forced to take that
23506 value, and this option is ignored.
23507
23508
23509 .option mode_fail_narrower appendfile boolean true
23510 This option applies in the case when an existing mailbox file has a narrower
23511 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23512 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23513 continues with the delivery attempt, using the existing mode of the file.
23514
23515
23516 .option notify_comsat appendfile boolean false
23517 If this option is true, the &'comsat'& daemon is notified after every
23518 successful delivery to a user mailbox. This is the daemon that notifies logged
23519 on users about incoming mail.
23520
23521
23522 .option quota appendfile string&!! unset
23523 .cindex "quota" "imposed by Exim"
23524 This option imposes a limit on the size of the file to which Exim is appending,
23525 or to the total space used in the directory tree when the &%directory%& option
23526 is set. In the latter case, computation of the space used is expensive, because
23527 all the files in the directory (and any sub-directories) have to be
23528 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23529 &%maildir_use_size_file%& for ways to avoid this in environments where users
23530 have no shell access to their mailboxes).
23531
23532 As there is no interlock against two simultaneous deliveries into a
23533 multi-file mailbox, it is possible for the quota to be overrun in this case.
23534 For single-file mailboxes, of course, an interlock is a necessity.
23535
23536 A file's size is taken as its &'used'& value. Because of blocking effects, this
23537 may be a lot less than the actual amount of disk space allocated to the file.
23538 If the sizes of a number of files are being added up, the rounding effect can
23539 become quite noticeable, especially on systems that have large block sizes.
23540 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23541 the obvious value which users understand most easily.
23542
23543 The value of the option is expanded, and must then be a numerical value
23544 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23545 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23546 and further option modifiers. If Exim is running on a system with
23547 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23548 be handled.
23549
23550 The option modifier &%no_check%& can be used to force delivery even if the over
23551 quota condition is met. The quota gets updated as usual.
23552
23553 &*Note*&: A value of zero is interpreted as &"no quota"&.
23554
23555 The expansion happens while Exim is running as root, before it changes uid for
23556 the delivery. This means that files that are inaccessible to the end user can
23557 be used to hold quota values that are looked up in the expansion. When delivery
23558 fails because this quota is exceeded, the handling of the error is as for
23559 system quota failures.
23560
23561 By default, Exim's quota checking mimics system quotas, and restricts the
23562 mailbox to the specified maximum size, though the value is not accurate to the
23563 last byte, owing to separator lines and additional headers that may get added
23564 during message delivery. When a mailbox is nearly full, large messages may get
23565 refused even though small ones are accepted, because the size of the current
23566 message is added to the quota when the check is made. This behaviour can be
23567 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23568 for exceeding the quota does not include the current message. Thus, deliveries
23569 continue until the quota has been exceeded; thereafter, no further messages are
23570 delivered. See also &%quota_warn_threshold%&.
23571
23572
23573 .option quota_directory appendfile string&!! unset
23574 This option defines the directory to check for quota purposes when delivering
23575 into individual files. The default is the delivery directory, or, if a file
23576 called &_maildirfolder_& exists in a maildir directory, the parent of the
23577 delivery directory.
23578
23579
23580 .option quota_filecount appendfile string&!! 0
23581 This option applies when the &%directory%& option is set. It limits the total
23582 number of files in the directory (compare the inode limit in system quotas). It
23583 can only be used if &%quota%& is also set. The value is expanded; an expansion
23584 failure causes delivery to be deferred. A value of zero is interpreted as
23585 &"no quota"&.
23586
23587 The option modifier &%no_check%& can be used to force delivery even if the over
23588 quota condition is met. The quota gets updated as usual.
23589
23590 .option quota_is_inclusive appendfile boolean true
23591 See &%quota%& above.
23592
23593
23594 .option quota_size_regex appendfile string unset
23595 This option applies when one of the delivery modes that writes a separate file
23596 for each message is being used. When Exim wants to find the size of one of
23597 these files in order to test the quota, it first checks &%quota_size_regex%&.
23598 If this is set to a regular expression that matches the filename, and it
23599 captures one string, that string is interpreted as a representation of the
23600 file's size. The value of &%quota_size_regex%& is not expanded.
23601
23602 This feature is useful only when users have no shell access to their mailboxes
23603 &-- otherwise they could defeat the quota simply by renaming the files. This
23604 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23605 the file length to the filename. For example:
23606 .code
23607 maildir_tag = ,S=$message_size
23608 quota_size_regex = ,S=(\d+)
23609 .endd
23610 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23611 number of lines in the message.
23612
23613 The regular expression should not assume that the length is at the end of the
23614 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23615 sometimes add other information onto the ends of message filenames.
23616
23617 Section &<<SECID136>>& contains further information.
23618
23619 This option should not be used when other message-handling software
23620 may duplicate messages by making hardlinks to the files.  When that is done Exim
23621 will count the message size once for each filename, in contrast with the actual
23622 disk usage.  When the option is not set, calculating total usage requires
23623 a system-call per file to get the size; the number of links is then available also
23624 as is used to adjust the effective size.
23625
23626
23627 .option quota_warn_message appendfile string&!! "see below"
23628 See below for the use of this option. If it is not set when
23629 &%quota_warn_threshold%& is set, it defaults to
23630 .code
23631 quota_warn_message = "\
23632   To: $local_part@$domain\n\
23633   Subject: Your mailbox\n\n\
23634   This message is automatically created \
23635   by mail delivery software.\n\n\
23636   The size of your mailbox has exceeded \
23637   a warning threshold that is\n\
23638   set by the system administrator.\n"
23639 .endd
23640
23641
23642 .option quota_warn_threshold appendfile string&!! 0
23643 .cindex "quota" "warning threshold"
23644 .cindex "mailbox" "size warning"
23645 .cindex "size" "of mailbox"
23646 This option is expanded in the same way as &%quota%& (see above). If the
23647 resulting value is greater than zero, and delivery of the message causes the
23648 size of the file or total space in the directory tree to cross the given
23649 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23650 may be specified as a percentage of it by following the value with a percent
23651 sign. For example:
23652 .code
23653 quota = 10M
23654 quota_warn_threshold = 75%
23655 .endd
23656 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23657 percent sign is ignored.
23658
23659 The warning message itself is specified by the &%quota_warn_message%& option,
23660 and it must start with a &'To:'& header line containing the recipient(s) of the
23661 warning message. These do not necessarily have to include the recipient(s) of
23662 the original message. A &'Subject:'& line should also normally be supplied. You
23663 can include any other header lines that you want. If you do not include a
23664 &'From:'& line, the default is:
23665 .code
23666 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23667 .endd
23668 .oindex &%errors_reply_to%&
23669 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23670 option.
23671
23672 The &%quota%& option does not have to be set in order to use this option; they
23673 are independent of one another except when the threshold is specified as a
23674 percentage.
23675
23676
23677 .option use_bsmtp appendfile boolean false
23678 .cindex "envelope from"
23679 .cindex "envelope sender"
23680 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23681 format, with the envelope sender and recipient(s) included as SMTP commands. If
23682 you want to include a leading HELO command with such messages, you can do
23683 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23684 for details of batch SMTP.
23685
23686
23687 .option use_crlf appendfile boolean false
23688 .cindex "carriage return"
23689 .cindex "linefeed"
23690 This option causes lines to be terminated with the two-character CRLF sequence
23691 (carriage return, linefeed) instead of just a linefeed character. In the case
23692 of batched SMTP, the byte sequence written to the file is then an exact image
23693 of what would be sent down a real SMTP connection.
23694
23695 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23696 (which are used to supply the traditional &"From&~"& and blank line separators
23697 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23698 carriage return characters if these are needed. In cases where these options
23699 have non-empty defaults, the values end with a single linefeed, so they must be
23700 changed to end with &`\r\n`& if &%use_crlf%& is set.
23701
23702
23703 .option use_fcntl_lock appendfile boolean "see below"
23704 This option controls the use of the &[fcntl()]& function to lock a file for
23705 exclusive use when a message is being appended. It is set by default unless
23706 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23707 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23708 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23709
23710
23711 .option use_flock_lock appendfile boolean false
23712 This option is provided to support the use of &[flock()]& for file locking, for
23713 the few situations where it is needed. Most modern operating systems support
23714 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23715 each other. Exim uses &[fcntl()]& locking by default.
23716
23717 This option is required only if you are using an operating system where
23718 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23719 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23720 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23721
23722 .cindex "Solaris" "&[flock()]& support"
23723 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23724 have it (and some, I think, provide a not quite right version built on top of
23725 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23726 the ability to use it, and any attempt to do so will cause a configuration
23727 error.
23728
23729 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23730 is just being mapped onto &[fcntl()]& by the OS).
23731
23732
23733 .option use_lockfile appendfile boolean "see below"
23734 If this option is turned off, Exim does not attempt to create a lock file when
23735 appending to a mailbox file. In this situation, the only locking is by
23736 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23737 sure that every MUA that is ever going to look at your users' mailboxes uses
23738 &[fcntl()]& rather than a lock file, and even then only when you are not
23739 delivering over NFS from more than one host.
23740
23741 .cindex "NFS" "lock file"
23742 In order to append to an NFS file safely from more than one host, it is
23743 necessary to take out a lock &'before'& opening the file, and the lock file
23744 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23745 file corruption.
23746
23747 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23748 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23749 except when &%mbx_format%& is set.
23750
23751
23752 .option use_mbx_lock appendfile boolean "see below"
23753 This option is available only if Exim has been compiled with SUPPORT_MBX
23754 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23755 locking rules be used. It is set by default if &%mbx_format%& is set and none
23756 of the locking options are mentioned in the configuration. The locking rules
23757 are the same as are used by the &'c-client'& library that underlies Pine and
23758 the IMAP4 and POP daemons that come with it (see the discussion below). The
23759 rules allow for shared access to the mailbox. However, this kind of locking
23760 does not work when the mailbox is NFS mounted.
23761
23762 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23763 &%use_flock_lock%& to control what kind of locking is used in implementing the
23764 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23765 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23766
23767
23768
23769
23770 .section "Operational details for appending" "SECTopappend"
23771 .cindex "appending to a file"
23772 .cindex "file" "appending"
23773 Before appending to a file, the following preparations are made:
23774
23775 .ilist
23776 If the name of the file is &_/dev/null_&, no action is taken, and a success
23777 return is given.
23778
23779 .next
23780 .cindex "directory creation"
23781 If any directories on the file's path are missing, Exim creates them if the
23782 &%create_directory%& option is set. A created directory's mode is given by the
23783 &%directory_mode%& option.
23784
23785 .next
23786 If &%file_format%& is set, the format of an existing file is checked. If this
23787 indicates that a different transport should be used, control is passed to that
23788 transport.
23789
23790 .next
23791 .cindex "file" "locking"
23792 .cindex "locking files"
23793 .cindex "NFS" "lock file"
23794 If &%use_lockfile%& is set, a lock file is built in a way that will work
23795 reliably over NFS, as follows:
23796
23797 .olist
23798 Create a &"hitching post"& file whose name is that of the lock file with the
23799 current time, primary host name, and process id added, by opening for writing
23800 as a new file. If this fails with an access error, delivery is deferred.
23801 .next
23802 Close the hitching post file, and hard link it to the lock filename.
23803 .next
23804 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23805 Unlink the hitching post name.
23806 .next
23807 Otherwise, use &[stat()]& to get information about the hitching post file, and
23808 then unlink hitching post name. If the number of links is exactly two, creation
23809 of the lock file succeeded but something (for example, an NFS server crash and
23810 restart) caused this fact not to be communicated to the &[link()]& call.
23811 .next
23812 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23813 up to &%lock_retries%& times. However, since any program that writes to a
23814 mailbox should complete its task very quickly, it is reasonable to time out old
23815 lock files that are normally the result of user agent and system crashes. If an
23816 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23817 it before trying again.
23818 .endlist olist
23819
23820 .next
23821 A call is made to &[lstat()]& to discover whether the main file exists, and if
23822 so, what its characteristics are. If &[lstat()]& fails for any reason other
23823 than non-existence, delivery is deferred.
23824
23825 .next
23826 .cindex "symbolic link" "to mailbox"
23827 .cindex "mailbox" "symbolic link"
23828 If the file does exist and is a symbolic link, delivery is deferred, unless the
23829 &%allow_symlink%& option is set, in which case the ownership of the link is
23830 checked, and then &[stat()]& is called to find out about the real file, which
23831 is then subjected to the checks below. The check on the top-level link
23832 ownership prevents one user creating a link for another's mailbox in a sticky
23833 directory, though allowing symbolic links in this case is definitely not a good
23834 idea. If there is a chain of symbolic links, the intermediate ones are not
23835 checked.
23836
23837 .next
23838 If the file already exists but is not a regular file, or if the file's owner
23839 and group (if the group is being checked &-- see &%check_group%& above) are
23840 different from the user and group under which the delivery is running,
23841 delivery is deferred.
23842
23843 .next
23844 If the file's permissions are more generous than specified, they are reduced.
23845 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23846 is set false, in which case the delivery is tried using the existing
23847 permissions.
23848
23849 .next
23850 The file's inode number is saved, and the file is then opened for appending.
23851 If this fails because the file has vanished, &(appendfile)& behaves as if it
23852 hadn't existed (see below). For any other failures, delivery is deferred.
23853
23854 .next
23855 If the file is opened successfully, check that the inode number hasn't
23856 changed, that it is still a regular file, and that the owner and permissions
23857 have not changed. If anything is wrong, defer delivery and freeze the message.
23858
23859 .next
23860 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23861 option is set. Otherwise, check that the file is being created in a permitted
23862 directory if the &%create_file%& option is set (deferring on failure), and then
23863 open for writing as a new file, with the O_EXCL and O_CREAT options,
23864 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23865 set). In this case, which can happen if the link points to a non-existent file,
23866 the file is opened for writing using O_CREAT but not O_EXCL, because
23867 that prevents link following.
23868
23869 .next
23870 .cindex "loop" "while file testing"
23871 If opening fails because the file exists, obey the tests given above for
23872 existing files. However, to avoid looping in a situation where the file is
23873 being continuously created and destroyed, the exists/not-exists loop is broken
23874 after 10 repetitions, and the message is then frozen.
23875
23876 .next
23877 If opening fails with any other error, defer delivery.
23878
23879 .next
23880 .cindex "file" "locking"
23881 .cindex "locking files"
23882 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23883 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23884 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23885 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23886 file, and an exclusive lock on the file whose name is
23887 .code
23888 /tmp/.<device-number>.<inode-number>
23889 .endd
23890 using the device and inode numbers of the open mailbox file, in accordance with
23891 the MBX locking rules. This file is created with a mode that is specified by
23892 the &%lockfile_mode%& option.
23893
23894 If Exim fails to lock the file, there are two possible courses of action,
23895 depending on the value of the locking timeout. This is obtained from
23896 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23897
23898 If the timeout value is zero, the file is closed, Exim waits for
23899 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23900 to lock it again. This happens up to &%lock_retries%& times, after which the
23901 delivery is deferred.
23902
23903 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23904 &[flock()]& are used (with the given timeout), so there has already been some
23905 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23906 immediately. It retries up to
23907 .code
23908 (lock_retries * lock_interval) / <timeout>
23909 .endd
23910 times (rounded up).
23911 .endlist
23912
23913 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23914 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23915
23916
23917 .section "Operational details for delivery to a new file" "SECTopdir"
23918 .cindex "delivery" "to single file"
23919 .cindex "&""From""& line"
23920 When the &%directory%& option is set instead of &%file%&, each message is
23921 delivered into a newly-created file or set of files. When &(appendfile)& is
23922 activated directly from a &(redirect)& router, neither &%file%& nor
23923 &%directory%& is normally set, because the path for delivery is supplied by the
23924 router. (See for example, the &(address_file)& transport in the default
23925 configuration.) In this case, delivery is to a new file if either the path name
23926 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23927
23928 No locking is required while writing the message to a new file, so the various
23929 locking options of the transport are ignored. The &"From"& line that by default
23930 separates messages in a single file is not normally needed, nor is the escaping
23931 of message lines that start with &"From"&, and there is no need to ensure a
23932 newline at the end of each message. Consequently, the default values for
23933 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23934 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23935
23936 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23937 the files in the delivery directory by default. However, you can specify a
23938 different directory by setting &%quota_directory%&. Also, for maildir
23939 deliveries (see below) the &_maildirfolder_& convention is honoured.
23940
23941
23942 .cindex "maildir format"
23943 .cindex "mailstore format"
23944 There are three different ways in which delivery to individual files can be
23945 done, controlled by the settings of the &%maildir_format%& and
23946 &%mailstore_format%& options. Note that code to support maildir or mailstore
23947 formats is not included in the binary unless SUPPORT_MAILDIR or
23948 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23949
23950 .cindex "directory creation"
23951 In all three cases an attempt is made to create the directory and any necessary
23952 sub-directories if they do not exist, provided that the &%create_directory%&
23953 option is set (the default). The location of a created directory can be
23954 constrained by setting &%create_file%&. A created directory's mode is given by
23955 the &%directory_mode%& option. If creation fails, or if the
23956 &%create_directory%& option is not set when creation is required, delivery is
23957 deferred.
23958
23959
23960
23961 .section "Maildir delivery" "SECTmaildirdelivery"
23962 .cindex "maildir format" "description of"
23963 If the &%maildir_format%& option is true, Exim delivers each message by writing
23964 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23965 directory that is defined by the &%directory%& option (the &"delivery
23966 directory"&). If the delivery is successful, the file is renamed into the
23967 &_new_& subdirectory.
23968
23969 In the filename, <&'stime'&> is the current time of day in seconds, and
23970 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23971 Exim checks that the time-of-day clock has moved on by at least one microsecond
23972 before terminating the delivery process. This guarantees uniqueness for the
23973 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23974 opening it. If any response other than ENOENT (does not exist) is given,
23975 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23976
23977 Before Exim carries out a maildir delivery, it ensures that subdirectories
23978 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23979 do not exist, Exim tries to create them and any superior directories in their
23980 path, subject to the &%create_directory%& and &%create_file%& options. If the
23981 &%maildirfolder_create_regex%& option is set, and the regular expression it
23982 contains matches the delivery directory, Exim also ensures that a file called
23983 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23984 &_maildirfolder_& file cannot be created, delivery is deferred.
23985
23986 These features make it possible to use Exim to create all the necessary files
23987 and directories in a maildir mailbox, including subdirectories for maildir++
23988 folders. Consider this example:
23989 .code
23990 maildir_format = true
23991 directory = /var/mail/$local_part_data\
23992            ${if eq{$local_part_suffix}{}{}\
23993            {/.${substr_1:$local_part_suffix}}}
23994 maildirfolder_create_regex = /\.[^/]+$
23995 .endd
23996 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23997 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23998 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23999 not match this name, so Exim will not look for or create the file
24000 &_/var/mail/pimbo/maildirfolder_&, though it will create
24001 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
24002
24003 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
24004 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
24005 does match &%maildirfolder_create_regex%&. In this case, Exim will create
24006 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
24007 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
24008
24009 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
24010 not inadvertently match the toplevel maildir directory, because a
24011 &_maildirfolder_& file at top level would completely break quota calculations.
24012
24013 .cindex "quota" "in maildir delivery"
24014 .cindex "maildir++"
24015 If Exim is required to check a &%quota%& setting before a maildir delivery, and
24016 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
24017 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
24018 Exim assumes the directory is a maildir++ folder directory, which is one level
24019 down from the user's top level mailbox directory. This causes it to start at
24020 the parent directory instead of the current directory when calculating the
24021 amount of space used.
24022
24023 One problem with delivering into a multi-file mailbox is that it is
24024 computationally expensive to compute the size of the mailbox for quota
24025 checking. Various approaches have been taken to reduce the amount of work
24026 needed. The next two sections describe two of them. A third alternative is to
24027 use some external process for maintaining the size data, and use the expansion
24028 of the &%mailbox_size%& option as a way of importing it into Exim.
24029
24030
24031
24032
24033 .section "Using tags to record message sizes" "SECID135"
24034 If &%maildir_tag%& is set, the string is expanded for each delivery.
24035 When the maildir file is renamed into the &_new_& sub-directory, the
24036 tag is added to its name. However, if adding the tag takes the length of the
24037 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
24038 the tag is dropped and the maildir file is created with no tag.
24039
24040
24041 .vindex "&$message_size$&"
24042 Tags can be used to encode the size of files in their names; see
24043 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
24044 happens after the message has been written. The value of the &$message_size$&
24045 variable is set to the number of bytes actually written. If the expansion is
24046 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
24047 be deferred. The expanded tag may contain any printing characters except &"/"&.
24048 Non-printing characters in the string are ignored; if the resulting string is
24049 empty, it is ignored. If it starts with an alphanumeric character, a leading
24050 colon is inserted; this default has not proven to be the path that popular
24051 maildir implementations have chosen (but changing it in Exim would break
24052 backwards compatibility).
24053
24054 For one common implementation, you might set:
24055 .code
24056 maildir_tag = ,S=${message_size}
24057 .endd
24058 but you should check the documentation of the other software to be sure.
24059
24060 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
24061 as this allows Exim to extract the size from your tag, instead of having to
24062 &[stat()]& each message file.
24063
24064
24065 .section "Using a maildirsize file" "SECID136"
24066 .cindex "quota" "in maildir delivery"
24067 .cindex "maildir format" "&_maildirsize_& file"
24068 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24069 storing quota and message size information in a file called &_maildirsize_&
24070 within the toplevel maildir directory. If this file does not exist, Exim
24071 creates it, setting the quota from the &%quota%& option of the transport. If
24072 the maildir directory itself does not exist, it is created before any attempt
24073 to write a &_maildirsize_& file.
24074
24075 The &_maildirsize_& file is used to hold information about the sizes of
24076 messages in the maildir, thus speeding up quota calculations. The quota value
24077 in the file is just a cache; if the quota is changed in the transport, the new
24078 value overrides the cached value when the next message is delivered. The cache
24079 is maintained for the benefit of other programs that access the maildir and
24080 need to know the quota.
24081
24082 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24083 file is maintained (with a zero quota setting), but no quota is imposed.
24084
24085 A regular expression is available for controlling which directories in the
24086 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24087 See the description of the &%maildir_quota_directory_regex%& option above for
24088 details.
24089
24090
24091 .section "Mailstore delivery" "SECID137"
24092 .cindex "mailstore format" "description of"
24093 If the &%mailstore_format%& option is true, each message is written as two
24094 files in the given directory. A unique base name is constructed from the
24095 message id and the current delivery process, and the files that are written use
24096 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24097 contains the message's envelope, and the &_.msg_& file contains the message
24098 itself. The base name is placed in the variable &$mailstore_basename$&.
24099
24100 During delivery, the envelope is first written to a file with the suffix
24101 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24102 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24103 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24104 file before accessing either of them. An alternative approach is to wait for
24105 the absence of a &_.tmp_& file.
24106
24107 The envelope file starts with any text defined by the &%mailstore_prefix%&
24108 option, expanded and terminated by a newline if there isn't one. Then follows
24109 the sender address on one line, then all the recipient addresses, one per line.
24110 There can be more than one recipient only if the &%batch_max%& option is set
24111 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24112 appended to the file, followed by a newline if it does not end with one.
24113
24114 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24115 failure, it is ignored. Other expansion errors are treated as serious
24116 configuration errors, and delivery is deferred. The variable
24117 &$mailstore_basename$& is available for use during these expansions.
24118
24119
24120 .section "Non-special new file delivery" "SECID138"
24121 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24122 file is created directly in the named directory. For example, when delivering
24123 messages into files in batched SMTP format for later delivery to some host (see
24124 section &<<SECTbatchSMTP>>&), a setting such as
24125 .code
24126 directory = /var/bsmtp/$host
24127 .endd
24128 might be used. A message is written to a file with a temporary name, which is
24129 then renamed when the delivery is complete. The final name is obtained by
24130 expanding the contents of the &%directory_file%& option.
24131 .ecindex IIDapptra1
24132 .ecindex IIDapptra2
24133
24134
24135
24136
24137
24138
24139 . ////////////////////////////////////////////////////////////////////////////
24140 . ////////////////////////////////////////////////////////////////////////////
24141
24142 .chapter "The autoreply transport" "CHID8"
24143 .scindex IIDauttra1 "transports" "&(autoreply)&"
24144 .scindex IIDauttra2 "&(autoreply)& transport"
24145 The &(autoreply)& transport is not a true transport in that it does not cause
24146 the message to be transmitted. Instead, it generates a new mail message as an
24147 automatic reply to the incoming message. &'References:'& and
24148 &'Auto-Submitted:'& header lines are included. These are constructed according
24149 to the rules in RFCs 2822 and 3834, respectively.
24150
24151 If the router that passes the message to this transport does not have the
24152 &%unseen%& option set, the original message (for the current recipient) is not
24153 delivered anywhere. However, when the &%unseen%& option is set on the router
24154 that passes the message to this transport, routing of the address continues, so
24155 another router can set up a normal message delivery.
24156
24157
24158 The &(autoreply)& transport is usually run as the result of mail filtering, a
24159 &"vacation"& message being the standard example. However, it can also be run
24160 directly from a router like any other transport. To reduce the possibility of
24161 message cascades, messages created by the &(autoreply)& transport always have
24162 empty envelope sender addresses, like bounce messages.
24163
24164 The parameters of the message to be sent can be specified in the configuration
24165 by options described below. However, these are used only when the address
24166 passed to the transport does not contain its own reply information. When the
24167 transport is run as a consequence of a
24168 &%mail%&
24169 or &%vacation%& command in a filter file, the parameters of the message are
24170 supplied by the filter, and passed with the address. The transport's options
24171 that define the message are then ignored (so they are not usually set in this
24172 case). The message is specified entirely by the filter or by the transport; it
24173 is never built from a mixture of options. However, the &%file_optional%&,
24174 &%mode%&, and &%return_message%& options apply in all cases.
24175
24176 &(Autoreply)& is implemented as a local transport. When used as a result of a
24177 command in a user's filter file, &(autoreply)& normally runs under the uid and
24178 gid of the user, and with appropriate current and home directories (see chapter
24179 &<<CHAPenvironment>>&).
24180
24181 There is a subtle difference between routing a message to a &(pipe)& transport
24182 that generates some text to be returned to the sender, and routing it to an
24183 &(autoreply)& transport. This difference is noticeable only if more than one
24184 address from the same message is so handled. In the case of a pipe, the
24185 separate outputs from the different addresses are gathered up and returned to
24186 the sender in a single message, whereas if &(autoreply)& is used, a separate
24187 message is generated for each address that is passed to it.
24188
24189 Non-printing characters are not permitted in the header lines generated for the
24190 message that &(autoreply)& creates, with the exception of newlines that are
24191 immediately followed by white space. If any non-printing characters are found,
24192 the transport defers.
24193 Whether characters with the top bit set count as printing characters or not is
24194 controlled by the &%print_topbitchars%& global option.
24195
24196 If any of the generic options for manipulating headers (for example,
24197 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24198 of the original message that is included in the generated message when
24199 &%return_message%& is set. They do not apply to the generated message itself.
24200
24201 .vindex "&$sender_address$&"
24202 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24203 the message, indicating that there were no recipients, it does not treat this
24204 as an error. This means that autoreplies sent to &$sender_address$& when this
24205 is empty (because the incoming message is a bounce message) do not cause
24206 problems. They are just discarded.
24207
24208
24209
24210 .section "Private options for autoreply" "SECID139"
24211 .cindex "options" "&(autoreply)& transport"
24212
24213 .option bcc autoreply string&!! unset
24214 This specifies the addresses that are to receive &"blind carbon copies"& of the
24215 message when the message is specified by the transport.
24216
24217
24218 .option cc autoreply string&!! unset
24219 This specifies recipients of the message and the contents of the &'Cc:'& header
24220 when the message is specified by the transport.
24221
24222
24223 .option file autoreply string&!! unset
24224 The contents of the file are sent as the body of the message when the message
24225 is specified by the transport. If both &%file%& and &%text%& are set, the text
24226 string comes first.
24227
24228
24229 .option file_expand autoreply boolean false
24230 If this is set, the contents of the file named by the &%file%& option are
24231 subjected to string expansion as they are added to the message.
24232
24233
24234 .option file_optional autoreply boolean false
24235 If this option is true, no error is generated if the file named by the &%file%&
24236 option or passed with the address does not exist or cannot be read.
24237
24238
24239 .option from autoreply string&!! unset
24240 This specifies the contents of the &'From:'& header when the message is
24241 specified by the transport.
24242
24243
24244 .option headers autoreply string&!! unset
24245 This specifies additional RFC 2822 headers that are to be added to the message
24246 when the message is specified by the transport. Several can be given by using
24247 &"\n"& to separate them. There is no check on the format.
24248
24249
24250 .option log autoreply string&!! unset
24251 This option names a file in which a record of every message sent is logged when
24252 the message is specified by the transport.
24253
24254
24255 .option mode autoreply "octal integer" 0600
24256 If either the log file or the &"once"& file has to be created, this mode is
24257 used.
24258
24259
24260 .option never_mail autoreply "address list&!!" unset
24261 If any run of the transport creates a message with a recipient that matches any
24262 item in the list, that recipient is quietly discarded. If all recipients are
24263 discarded, no message is created. This applies both when the recipients are
24264 generated by a filter and when they are specified in the transport.
24265
24266
24267
24268 .option once autoreply string&!! unset
24269 This option names a file or DBM database in which a record of each &'To:'&
24270 recipient is kept when the message is specified by the transport. &*Note*&:
24271 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24272
24273 If &%once%& is unset, or is set to an empty string, the message is always sent.
24274 By default, if &%once%& is set to a non-empty filename, the message
24275 is not sent if a potential recipient is already listed in the database.
24276 However, if the &%once_repeat%& option specifies a time greater than zero, the
24277 message is sent if that much time has elapsed since a message was last sent to
24278 this recipient. A setting of zero time for &%once_repeat%& (the default)
24279 prevents a message from being sent a second time &-- in this case, zero means
24280 infinity.
24281
24282 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24283 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24284 greater than zero, it changes the way Exim implements the &%once%& option.
24285 Instead of using a DBM file to record every recipient it sends to, it uses a
24286 regular file, whose size will never get larger than the given value.
24287
24288 In the file, Exim keeps a linear list of recipient addresses and the times at
24289 which they were sent messages. If the file is full when a new address needs to
24290 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24291 means that a given recipient may receive multiple messages, but at
24292 unpredictable intervals that depend on the rate of turnover of addresses in the
24293 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24294
24295
24296 .option once_file_size autoreply integer 0
24297 See &%once%& above.
24298
24299
24300 .option once_repeat autoreply time&!! 0s
24301 See &%once%& above.
24302 After expansion, the value of this option must be a valid time value.
24303
24304
24305 .option reply_to autoreply string&!! unset
24306 This specifies the contents of the &'Reply-To:'& header when the message is
24307 specified by the transport.
24308
24309
24310 .option return_message autoreply boolean false
24311 If this is set, a copy of the original message is returned with the new
24312 message, subject to the maximum size set in the &%return_size_limit%& global
24313 configuration option.
24314
24315
24316 .option subject autoreply string&!! unset
24317 This specifies the contents of the &'Subject:'& header when the message is
24318 specified by the transport. It is tempting to quote the original subject in
24319 automatic responses. For example:
24320 .code
24321 subject = Re: $h_subject:
24322 .endd
24323 There is a danger in doing this, however. It may allow a third party to
24324 subscribe your users to an opt-in mailing list, provided that the list accepts
24325 bounce messages as subscription confirmations. Well-managed lists require a
24326 non-bounce message to confirm a subscription, so the danger is relatively
24327 small.
24328
24329
24330
24331 .option text autoreply string&!! unset
24332 This specifies a single string to be used as the body of the message when the
24333 message is specified by the transport. If both &%text%& and &%file%& are set,
24334 the text comes first.
24335
24336
24337 .option to autoreply string&!! unset
24338 This specifies recipients of the message and the contents of the &'To:'& header
24339 when the message is specified by the transport.
24340 .ecindex IIDauttra1
24341 .ecindex IIDauttra2
24342
24343
24344
24345
24346 . ////////////////////////////////////////////////////////////////////////////
24347 . ////////////////////////////////////////////////////////////////////////////
24348
24349 .chapter "The lmtp transport" "CHAPLMTP"
24350 .cindex "transports" "&(lmtp)&"
24351 .cindex "&(lmtp)& transport"
24352 .cindex "LMTP" "over a pipe"
24353 .cindex "LMTP" "over a socket"
24354 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24355 specified command
24356 or by interacting with a Unix domain socket.
24357 This transport is something of a cross between the &(pipe)& and &(smtp)&
24358 transports. Exim also has support for using LMTP over TCP/IP; this is
24359 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24360 to be of minority interest, the default build-time configure in &_src/EDITME_&
24361 has it commented out. You need to ensure that
24362 .code
24363 TRANSPORT_LMTP=yes
24364 .endd
24365 .cindex "options" "&(lmtp)& transport"
24366 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24367 included in the Exim binary. The private options of the &(lmtp)& transport are
24368 as follows:
24369
24370 .option batch_id lmtp string&!! unset
24371 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24372
24373
24374 .option batch_max lmtp integer 1
24375 This limits the number of addresses that can be handled in a single delivery.
24376 Most LMTP servers can handle several addresses at once, so it is normally a
24377 good idea to increase this value. See the description of local delivery
24378 batching in chapter &<<CHAPbatching>>&.
24379
24380
24381 .option command lmtp string&!! unset
24382 This option must be set if &%socket%& is not set. The string is a command which
24383 is run in a separate process. It is split up into a command name and list of
24384 arguments, each of which is separately expanded (so expansion cannot change the
24385 number of arguments). The command is run directly, not via a shell. The message
24386 is passed to the new process using the standard input and output to operate the
24387 LMTP protocol.
24388
24389 .option ignore_quota lmtp boolean false
24390 .cindex "LMTP" "ignoring quota errors"
24391 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24392 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24393 in its response to the LHLO command.
24394
24395 .option socket lmtp string&!! unset
24396 This option must be set if &%command%& is not set. The result of expansion must
24397 be the name of a Unix domain socket. The transport connects to the socket and
24398 delivers the message to it using the LMTP protocol.
24399
24400
24401 .option timeout lmtp time 5m
24402 The transport is aborted if the created process or Unix domain socket does not
24403 respond to LMTP commands or message input within this timeout. Delivery
24404 is deferred, and will be tried again later. Here is an example of a typical
24405 LMTP transport:
24406 .code
24407 lmtp:
24408   driver = lmtp
24409   command = /some/local/lmtp/delivery/program
24410   batch_max = 20
24411   user = exim
24412 .endd
24413 This delivers up to 20 addresses at a time, in a mixture of domains if
24414 necessary, running as the user &'exim'&.
24415
24416
24417
24418 . ////////////////////////////////////////////////////////////////////////////
24419 . ////////////////////////////////////////////////////////////////////////////
24420
24421 .chapter "The pipe transport" "CHAPpipetransport"
24422 .scindex IIDpiptra1 "transports" "&(pipe)&"
24423 .scindex IIDpiptra2 "&(pipe)& transport"
24424 The &(pipe)& transport is used to deliver messages via a pipe to a command
24425 running in another process. One example is the use of &(pipe)& as a
24426 pseudo-remote transport for passing messages to some other delivery mechanism
24427 (such as UUCP). Another is the use by individual users to automatically process
24428 their incoming messages. The &(pipe)& transport can be used in one of the
24429 following ways:
24430
24431 .ilist
24432 .vindex "&$local_part$&"
24433 A router routes one address to a transport in the normal way, and the
24434 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24435 contains the local part of the address (as usual), and the command that is run
24436 is specified by the &%command%& option on the transport.
24437 .next
24438 .vindex "&$pipe_addresses$&"
24439 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24440 transport can handle more than one address in a single run. In this case, when
24441 more than one address is routed to the transport, &$local_part$& is not set
24442 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24443 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24444 that are routed to the transport.
24445 .next
24446 .vindex "&$address_pipe$&"
24447 A router redirects an address directly to a pipe command (for example, from an
24448 alias or forward file). In this case, &$address_pipe$& contains the text of the
24449 pipe command, and the &%command%& option on the transport is ignored unless
24450 &%force_command%& is set. If only one address is being transported
24451 (&%batch_max%& is not greater than one, or only one address was redirected to
24452 this pipe command), &$local_part$& contains the local part that was redirected.
24453 .endlist
24454
24455
24456 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24457 deliver messages over pipes using the LMTP interactive protocol. This is
24458 implemented by the &(lmtp)& transport.
24459
24460 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24461 &_.forward_& file, the command runs under the uid and gid of that user. In
24462 other cases, the uid and gid have to be specified explicitly, either on the
24463 transport or on the router that handles the address. Current and &"home"&
24464 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24465 details of the local delivery environment and chapter &<<CHAPbatching>>&
24466 for a discussion of local delivery batching.
24467
24468 .cindex "tainted data" "in pipe command"
24469 .cindex pipe "tainted data"
24470 Tainted data may not be used for the command name.
24471
24472
24473 .section "Concurrent delivery" "SECID140"
24474 If two messages arrive at almost the same time, and both are routed to a pipe
24475 delivery, the two pipe transports may be run concurrently. You must ensure that
24476 any pipe commands you set up are robust against this happening. If the commands
24477 write to a file, the &%exim_lock%& utility might be of use.
24478 Alternatively the &%max_parallel%& option could be used with a value
24479 of "1" to enforce serialization.
24480
24481
24482
24483
24484 .section "Returned status and data" "SECID141"
24485 .cindex "&(pipe)& transport" "returned data"
24486 If the command exits with a non-zero return code, the delivery is deemed to
24487 have failed, unless either the &%ignore_status%& option is set (in which case
24488 the return code is treated as zero), or the return code is one of those listed
24489 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24490 later"&. In this case, delivery is deferred. Details of a permanent failure are
24491 logged, but are not included in the bounce message, which merely contains
24492 &"local delivery failed"&.
24493
24494 If the command exits on a signal and the &%freeze_signal%& option is set then
24495 the message will be frozen in the queue. If that option is not set, a bounce
24496 will be sent as normal.
24497
24498 If the return code is greater than 128 and the command being run is a shell
24499 script, it normally means that the script was terminated by a signal whose
24500 value is the return code minus 128. The &%freeze_signal%& option does not
24501 apply in this case.
24502
24503 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24504 return code is set to 127. This is the value that a shell returns if it is
24505 asked to run a non-existent command. The wording for the log line suggests that
24506 a non-existent command may be the problem.
24507
24508 The &%return_output%& option can affect the result of a pipe delivery. If it is
24509 set and the command produces any output on its standard output or standard
24510 error streams, the command is considered to have failed, even if it gave a zero
24511 return code or if &%ignore_status%& is set. The output from the command is
24512 included as part of the bounce message. The &%return_fail_output%& option is
24513 similar, except that output is returned only when the command exits with a
24514 failure return code, that is, a value other than zero or a code that matches
24515 &%temp_errors%&.
24516
24517
24518
24519 .section "How the command is run" "SECThowcommandrun"
24520 .cindex "&(pipe)& transport" "path for command"
24521 The command line is (by default) broken down into a command name and arguments
24522 by the &(pipe)& transport itself. The &%allow_commands%& and
24523 &%restrict_to_path%& options can be used to restrict the commands that may be
24524 run.
24525
24526 .cindex "quoting" "in pipe command"
24527 Unquoted arguments are delimited by white space. If an argument appears in
24528 double quotes, backslash is interpreted as an escape character in the usual
24529 way. If an argument appears in single quotes, no escaping is done.
24530
24531 String expansion is applied to the command line except when it comes from a
24532 traditional &_.forward_& file (commands from a filter file are expanded). The
24533 expansion is applied to each argument in turn rather than to the whole line.
24534 For this reason, any string expansion item that contains white space must be
24535 quoted so as to be contained within a single argument. A setting such as
24536 .code
24537 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24538 .endd
24539 will not work, because the expansion item gets split between several
24540 arguments. You have to write
24541 .code
24542 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24543 .endd
24544 to ensure that it is all in one argument. The expansion is done in this way,
24545 argument by argument, so that the number of arguments cannot be changed as a
24546 result of expansion, and quotes or backslashes in inserted variables do not
24547 interact with external quoting. However, this leads to problems if you want to
24548 generate multiple arguments (or the command name plus arguments) from a single
24549 expansion. In this situation, the simplest solution is to use a shell. For
24550 example:
24551 .code
24552 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24553 .endd
24554
24555 .cindex "transport" "filter"
24556 .cindex "filter" "transport filter"
24557 .vindex "&$pipe_addresses$&"
24558 Special handling takes place when an argument consists of precisely the text
24559 &`$pipe_addresses`& (no quotes).
24560 This is not a general expansion variable; the only
24561 place this string is recognized is when it appears as an argument for a pipe or
24562 transport filter command. It causes each address that is being handled to be
24563 inserted in the argument list at that point &'as a separate argument'&. This
24564 avoids any problems with spaces or shell metacharacters, and is of use when a
24565 &(pipe)& transport is handling groups of addresses in a batch.
24566
24567 If &%force_command%& is enabled on the transport, special handling takes place
24568 for an argument that consists of precisely the text &`$address_pipe`&.  It
24569 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24570 argument is inserted in the argument list at that point
24571 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24572 the only item in the argument; in fact, if it were then &%force_command%&
24573 should behave as a no-op.  Rather, it should be used to adjust the command
24574 run while preserving the argument vector separation.
24575
24576 After splitting up into arguments and expansion, the resulting command is run
24577 in a subprocess directly from the transport, &'not'& under a shell. The
24578 message that is being delivered is supplied on the standard input, and the
24579 standard output and standard error are both connected to a single pipe that is
24580 read by Exim. The &%max_output%& option controls how much output the command
24581 may produce, and the &%return_output%& and &%return_fail_output%& options
24582 control what is done with it.
24583
24584 Not running the command under a shell (by default) lessens the security risks
24585 in cases when a command from a user's filter file is built out of data that was
24586 taken from an incoming message. If a shell is required, it can of course be
24587 explicitly specified as the command to be run. However, there are circumstances
24588 where existing commands (for example, in &_.forward_& files) expect to be run
24589 under a shell and cannot easily be modified. To allow for these cases, there is
24590 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24591 works. Instead of breaking up the command line as just described, it expands it
24592 as a single string and passes the result to &_/bin/sh_&. The
24593 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24594 with &%use_shell%&, and the whole mechanism is inherently less secure.
24595
24596
24597
24598 .section "Environment variables" "SECTpipeenv"
24599 .cindex "&(pipe)& transport" "environment for command"
24600 .cindex "environment" "&(pipe)& transport"
24601 The environment variables listed below are set up when the command is invoked.
24602 This list is a compromise for maximum compatibility with other MTAs. Note that
24603 the &%environment%& option can be used to add additional variables to this
24604 environment. The environment for the &(pipe)& transport is not subject
24605 to the &%add_environment%& and &%keep_environment%& main config options.
24606 &*Note*&: Using enviroment variables loses track of tainted data.
24607 Writers of &(pipe)& transport commands should be wary of data supplied
24608 by potential attackers.
24609 .display
24610 &`DOMAIN            `&   the domain of the address
24611 &`HOME              `&   the home directory, if set
24612 &`HOST              `&   the host name when called from a router (see below)
24613 &`LOCAL_PART        `&   see below
24614 &`LOCAL_PART_PREFIX `&   see below
24615 &`LOCAL_PART_SUFFIX `&   see below
24616 &`LOGNAME           `&   see below
24617 &`MESSAGE_ID        `&   Exim's local ID for the message
24618 &`PATH              `&   as specified by the &%path%& option below
24619 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24620 &`RECIPIENT         `&   the complete recipient address
24621 &`SENDER            `&   the sender of the message (empty if a bounce)
24622 &`SHELL             `&   &`/bin/sh`&
24623 &`TZ                `&   the value of the &%timezone%& option, if set
24624 &`USER              `&   see below
24625 .endd
24626 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24627 router, LOCAL_PART is set to the local part of the address. When it is
24628 called as a result of a forward or alias expansion, LOCAL_PART is set to
24629 the local part of the address that was expanded. In both cases, any affixes are
24630 removed from the local part, and made available in LOCAL_PART_PREFIX and
24631 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24632 same value as LOCAL_PART for compatibility with other MTAs.
24633
24634 .cindex "HOST"
24635 HOST is set only when a &(pipe)& transport is called from a router that
24636 associates hosts with an address, typically when using &(pipe)& as a
24637 pseudo-remote transport. HOST is set to the first host name specified by
24638 the router.
24639
24640 .cindex "HOME"
24641 If the transport's generic &%home_directory%& option is set, its value is used
24642 for the HOME environment variable. Otherwise, a home directory may be set
24643 by the router's &%transport_home_directory%& option, which defaults to the
24644 user's home directory if &%check_local_user%& is set.
24645
24646
24647 .section "Private options for pipe" "SECID142"
24648 .cindex "options" "&(pipe)& transport"
24649
24650
24651
24652 .option allow_commands pipe "string list&!!" unset
24653 .cindex "&(pipe)& transport" "permitted commands"
24654 The string is expanded, and is then interpreted as a colon-separated list of
24655 permitted commands. If &%restrict_to_path%& is not set, the only commands
24656 permitted are those in the &%allow_commands%& list. They need not be absolute
24657 paths; the &%path%& option is still used for relative paths. If
24658 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24659 in the &%allow_commands%& list, or a name without any slashes that is found on
24660 the path. In other words, if neither &%allow_commands%& nor
24661 &%restrict_to_path%& is set, there is no restriction on the command, but
24662 otherwise only commands that are permitted by one or the other are allowed. For
24663 example, if
24664 .code
24665 allow_commands = /usr/bin/vacation
24666 .endd
24667 and &%restrict_to_path%& is not set, the only permitted command is
24668 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24669 &%use_shell%& is set.
24670
24671
24672 .option batch_id pipe string&!! unset
24673 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24674
24675
24676 .option batch_max pipe integer 1
24677 This limits the number of addresses that can be handled in a single delivery.
24678 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24679
24680
24681 .option check_string pipe string unset
24682 As &(pipe)& writes the message, the start of each line is tested for matching
24683 &%check_string%&, and if it does, the initial matching characters are replaced
24684 by the contents of &%escape_string%&, provided both are set. The value of
24685 &%check_string%& is a literal string, not a regular expression, and the case of
24686 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24687 of &%check_string%& and &%escape_string%& are forced to values that implement
24688 the SMTP escaping protocol. Any settings made in the configuration file are
24689 ignored.
24690
24691
24692 .option command pipe string&!! unset
24693 This option need not be set when &(pipe)& is being used to deliver to pipes
24694 obtained directly from address redirections. In other cases, the option must be
24695 set, to provide a command to be run. It need not yield an absolute path (see
24696 the &%path%& option below). The command is split up into separate arguments by
24697 Exim, and each argument is separately expanded, as described in section
24698 &<<SECThowcommandrun>>& above.
24699
24700 .cindex "tainted data"
24701 No part of the resulting command may be tainted.
24702
24703
24704 .option environment pipe string&!! unset
24705 .cindex "&(pipe)& transport" "environment for command"
24706 .cindex "environment" "&(pipe)& transport"
24707 This option is used to add additional variables to the environment in which the
24708 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24709 a string which is expanded, and then interpreted as a colon-separated list of
24710 environment settings of the form <&'name'&>=<&'value'&>.
24711
24712
24713 .option escape_string pipe string unset
24714 See &%check_string%& above.
24715
24716
24717 .option freeze_exec_fail pipe boolean false
24718 .cindex "exec failure"
24719 .cindex "failure of exec"
24720 .cindex "&(pipe)& transport" "failure of exec"
24721 Failure to exec the command in a pipe transport is by default treated like
24722 any other failure while running the command. However, if &%freeze_exec_fail%&
24723 is set, failure to exec is treated specially, and causes the message to be
24724 frozen, whatever the setting of &%ignore_status%&.
24725
24726
24727 .option freeze_signal pipe boolean false
24728 .cindex "signal exit"
24729 .cindex "&(pipe)& transport", "signal exit"
24730 Normally if the process run by a command in a pipe transport exits on a signal,
24731 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24732 frozen in Exim's queue instead.
24733
24734
24735 .option force_command pipe boolean false
24736 .cindex "force command"
24737 .cindex "&(pipe)& transport", "force command"
24738 Normally when a router redirects an address directly to a pipe command
24739 the &%command%& option on the transport is ignored.  If &%force_command%&
24740 is set, the &%command%& option will used. This is especially
24741 useful for forcing a wrapper or additional argument to be added to the
24742 command. For example:
24743 .code
24744 command = /usr/bin/remote_exec myhost -- $address_pipe
24745 force_command
24746 .endd
24747
24748 Note that &$address_pipe$& is handled specially in &%command%& when
24749 &%force_command%& is set, expanding out to the original argument vector as
24750 separate items, similarly to a Unix shell &`"$@"`& construct.
24751
24752
24753 .option ignore_status pipe boolean false
24754 If this option is true, the status returned by the subprocess that is set up to
24755 run the command is ignored, and Exim behaves as if zero had been returned.
24756 Otherwise, a non-zero status or termination by signal causes an error return
24757 from the transport unless the status value is one of those listed in
24758 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24759
24760 &*Note*&: This option does not apply to timeouts, which do not return a status.
24761 See the &%timeout_defer%& option for how timeouts are handled.
24762
24763
24764 .option log_defer_output pipe boolean false
24765 .cindex "&(pipe)& transport" "logging output"
24766 If this option is set, and the status returned by the command is
24767 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24768 and any output was produced on stdout or stderr, the first line of it is
24769 written to the main log.
24770
24771
24772 .option log_fail_output pipe boolean false
24773 If this option is set, and the command returns any output on stdout or
24774 stderr, and also ends with a return code that is neither zero nor one of
24775 the return codes listed in &%temp_errors%& (that is, the delivery
24776 failed), the first line of output is written to the main log. This
24777 option and &%log_output%& are mutually exclusive.  Only one of them may
24778 be set.
24779
24780
24781 .option log_output pipe boolean false
24782 If this option is set and the command returns any output on stdout or
24783 stderr, the first line of output is written to the main log, whatever
24784 the return code. This option and &%log_fail_output%& are mutually
24785 exclusive. Only one of them may be set.
24786
24787
24788 .option max_output pipe integer 20K
24789 This specifies the maximum amount of output that the command may produce on its
24790 standard output and standard error file combined. If the limit is exceeded, the
24791 process running the command is killed. This is intended as a safety measure to
24792 catch runaway processes. The limit is applied independently of the settings of
24793 the options that control what is done with such output (for example,
24794 &%return_output%&). Because of buffering effects, the amount of output may
24795 exceed the limit by a small amount before Exim notices.
24796
24797
24798 .option message_prefix pipe string&!! "see below"
24799 The string specified here is expanded and output at the start of every message.
24800 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24801 .code
24802 message_prefix = \
24803   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24804   ${tod_bsdinbox}\n
24805 .endd
24806 .cindex "Cyrus"
24807 .cindex "&%tmail%&"
24808 .cindex "&""From""& line"
24809 This is required by the commonly used &_/usr/bin/vacation_& program.
24810 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24811 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24812 setting
24813 .code
24814 message_prefix =
24815 .endd
24816 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24817 &`\n`& to &`\r\n`& in &%message_prefix%&.
24818
24819
24820 .option message_suffix pipe string&!! "see below"
24821 The string specified here is expanded and output at the end of every message.
24822 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24823 The suffix can be suppressed by setting
24824 .code
24825 message_suffix =
24826 .endd
24827 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24828 &`\n`& to &`\r\n`& in &%message_suffix%&.
24829
24830
24831 .option path pipe string&!! "/bin:/usr/bin"
24832 This option is expanded and
24833 specifies the string that is set up in the PATH environment
24834 variable of the subprocess.
24835 If the &%command%& option does not yield an absolute path name, the command is
24836 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24837 apply to a command specified as a transport filter.
24838
24839
24840 .option permit_coredump pipe boolean false
24841 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24842 a core-dump of a pipe command, enable this command.  This enables core-dumps
24843 during delivery and affects both the Exim binary and the pipe command run.
24844 It is recommended that this option remain off unless and until you have a need
24845 for it and that this only be enabled when needed, as the risk of excessive
24846 resource consumption can be quite high.  Note also that Exim is typically
24847 installed as a setuid binary and most operating systems will inhibit coredumps
24848 of these by default, so further OS-specific action may be required.
24849
24850
24851 .option pipe_as_creator pipe boolean false
24852 .cindex "uid (user id)" "local delivery"
24853 If the generic &%user%& option is not set and this option is true, the delivery
24854 process is run under the uid that was in force when Exim was originally called
24855 to accept the message. If the group id is not otherwise set (via the generic
24856 &%group%& option), the gid that was in force when Exim was originally called to
24857 accept the message is used.
24858
24859
24860 .option restrict_to_path pipe boolean false
24861 When this option is set, any command name not listed in &%allow_commands%& must
24862 contain no slashes. The command is searched for only in the directories listed
24863 in the &%path%& option. This option is intended for use in the case when a pipe
24864 command has been generated from a user's &_.forward_& file. This is usually
24865 handled by a &(pipe)& transport called &%address_pipe%&.
24866
24867
24868 .option return_fail_output pipe boolean false
24869 If this option is true, and the command produced any output and ended with a
24870 return code other than zero or one of the codes listed in &%temp_errors%& (that
24871 is, the delivery failed), the output is returned in the bounce message.
24872 However, if the message has a null sender (that is, it is itself a bounce
24873 message), output from the command is discarded. This option and
24874 &%return_output%& are mutually exclusive. Only one of them may be set.
24875
24876
24877
24878 .option return_output pipe boolean false
24879 If this option is true, and the command produced any output, the delivery is
24880 deemed to have failed whatever the return code from the command, and the output
24881 is returned in the bounce message. Otherwise, the output is just discarded.
24882 However, if the message has a null sender (that is, it is a bounce message),
24883 output from the command is always discarded, whatever the setting of this
24884 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24885 of them may be set.
24886
24887
24888
24889 .option temp_errors pipe "string list" "see below"
24890 .cindex "&(pipe)& transport" "temporary failure"
24891 This option contains either a colon-separated list of numbers, or a single
24892 asterisk. If &%ignore_status%& is false
24893 and &%return_output%& is not set,
24894 and the command exits with a non-zero return code, the failure is treated as
24895 temporary and the delivery is deferred if the return code matches one of the
24896 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24897 codes are treated as permanent errors. The default setting contains the codes
24898 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24899 compiled on a system that does not define these macros, it assumes values of 75
24900 and 73, respectively.
24901
24902
24903 .option timeout pipe time 1h
24904 If the command fails to complete within this time, it is killed. This normally
24905 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24906 specifies no timeout. In order to ensure that any subprocesses created by the
24907 command are also killed, Exim makes the initial process a process group leader,
24908 and kills the whole process group on a timeout. However, this can be defeated
24909 if one of the processes starts a new process group.
24910
24911 .option timeout_defer pipe boolean false
24912 A timeout in a &(pipe)& transport, either in the command that the transport
24913 runs, or in a transport filter that is associated with it, is by default
24914 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24915 is set true, both kinds of timeout become temporary errors, causing the
24916 delivery to be deferred.
24917
24918 .option umask pipe "octal integer" 022
24919 This specifies the umask setting for the subprocess that runs the command.
24920
24921
24922 .option use_bsmtp pipe boolean false
24923 .cindex "envelope sender"
24924 If this option is set true, the &(pipe)& transport writes messages in &"batch
24925 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24926 commands. If you want to include a leading HELO command with such messages,
24927 you can do so by setting the &%message_prefix%& option. See section
24928 &<<SECTbatchSMTP>>& for details of batch SMTP.
24929
24930 .option use_classresources pipe boolean false
24931 .cindex "class resources (BSD)"
24932 This option is available only when Exim is running on FreeBSD, NetBSD, or
24933 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24934 resource limits when a &(pipe)& transport is run to perform a delivery. The
24935 limits for the uid under which the pipe is to run are obtained from the login
24936 class database.
24937
24938
24939 .option use_crlf pipe boolean false
24940 .cindex "carriage return"
24941 .cindex "linefeed"
24942 This option causes lines to be terminated with the two-character CRLF sequence
24943 (carriage return, linefeed) instead of just a linefeed character. In the case
24944 of batched SMTP, the byte sequence written to the pipe is then an exact image
24945 of what would be sent down a real SMTP connection.
24946
24947 The contents of the &%message_prefix%& and &%message_suffix%& options are
24948 written verbatim, so must contain their own carriage return characters if these
24949 are needed. When &%use_bsmtp%& is not set, the default values for both
24950 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24951 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24952
24953
24954 .option use_shell pipe boolean false
24955 .vindex "&$pipe_addresses$&"
24956 If this option is set, it causes the command to be passed to &_/bin/sh_&
24957 instead of being run directly from the transport, as described in section
24958 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24959 where the command is expected to be run under a shell and cannot easily be
24960 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24961 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24962 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24963 its &%-c%& option.
24964
24965
24966
24967 .section "Using an external local delivery agent" "SECID143"
24968 .cindex "local delivery" "using an external agent"
24969 .cindex "&'procmail'&"
24970 .cindex "external local delivery"
24971 .cindex "delivery" "&'procmail'&"
24972 .cindex "delivery" "by external agent"
24973 The &(pipe)& transport can be used to pass all messages that require local
24974 delivery to a separate local delivery agent such as &%procmail%&. When doing
24975 this, care must be taken to ensure that the pipe is run under an appropriate
24976 uid and gid. In some configurations one wants this to be a uid that is trusted
24977 by the delivery agent to supply the correct sender of the message. It may be
24978 necessary to recompile or reconfigure the delivery agent so that it trusts an
24979 appropriate user. The following is an example transport and router
24980 configuration for &%procmail%&:
24981 .code
24982 # transport
24983 procmail_pipe:
24984   driver = pipe
24985   command = /usr/local/bin/procmail -d $local_part_data
24986   return_path_add
24987   delivery_date_add
24988   envelope_to_add
24989   check_string = "From "
24990   escape_string = ">From "
24991   umask = 077
24992   user = $local_part_data
24993   group = mail
24994
24995 # router
24996 procmail:
24997   driver = accept
24998   check_local_user
24999   transport = procmail_pipe
25000 .endd
25001 In this example, the pipe is run as the local user, but with the group set to
25002 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
25003 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
25004 user to supply a correct sender address. If you do not specify either a
25005 &%group%& or a &%user%& option, the pipe command is run as the local user. The
25006 home directory is the user's home directory by default.
25007
25008 &*Note*&: The command that the pipe transport runs does &'not'& begin with
25009 .code
25010 IFS=" "
25011 .endd
25012 as shown in some &%procmail%& documentation, because Exim does not by default
25013 use a shell to run pipe commands.
25014
25015 .cindex "Cyrus"
25016 The next example shows a transport and a router for a system where local
25017 deliveries are handled by the Cyrus IMAP server.
25018 . Used to have R: local_part_suffix = .* +  T:   -m $local_part_suffix_v
25019 . but that suffix is tainted so cannot be used in a command arg
25020 . Really, you'd want to use a lookup for acceptable suffixes to do real detainting
25021 .code
25022 # transport
25023 local_delivery_cyrus:
25024   driver = pipe
25025   command = /usr/cyrus/bin/deliver \
25026             -- $local_part_data
25027   user = cyrus
25028   group = mail
25029   return_output
25030   log_output
25031   message_prefix =
25032   message_suffix =
25033
25034 # router
25035 local_user_cyrus:
25036   driver = accept
25037   check_local_user
25038   transport = local_delivery_cyrus
25039 .endd
25040 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
25041 &%return_output%& to cause any text written by Cyrus to be returned to the
25042 sender.
25043 .ecindex IIDpiptra1
25044 .ecindex IIDpiptra2
25045
25046
25047 . ////////////////////////////////////////////////////////////////////////////
25048 . ////////////////////////////////////////////////////////////////////////////
25049
25050 .chapter "The smtp transport" "CHAPsmtptrans"
25051 .scindex IIDsmttra1 "transports" "&(smtp)&"
25052 .scindex IIDsmttra2 "&(smtp)& transport"
25053 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
25054 or LMTP protocol. The list of hosts to try can either be taken from the address
25055 that is being processed (having been set up by the router), or specified
25056 explicitly for the transport. Timeout and retry processing (see chapter
25057 &<<CHAPretry>>&) is applied to each IP address independently.
25058
25059
25060 .section "Multiple messages on a single connection" "SECID144"
25061 The sending of multiple messages over a single TCP/IP connection can arise in
25062 two ways:
25063
25064 .ilist
25065 If a message contains more than &%max_rcpt%& (see below) addresses that are
25066 routed to the same host, more than one copy of the message has to be sent to
25067 that host. In this situation, multiple copies may be sent in a single run of
25068 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
25069 does when it has too many addresses to send in one message also depends on the
25070 value of the global &%remote_max_parallel%& option. Details are given in
25071 section &<<SECToutSMTPTCP>>&.)
25072 .next
25073 .cindex "hints database" "remembering routing"
25074 When a message has been successfully delivered over a TCP/IP connection, Exim
25075 looks in its hints database to see if there are any other messages awaiting a
25076 connection to the same host. If there are, a new delivery process is started
25077 for one of them, and the current TCP/IP connection is passed on to it. The new
25078 process may in turn send multiple copies and possibly create yet another
25079 process.
25080 .endlist
25081
25082
25083 For each copy sent over the same TCP/IP connection, a sequence counter is
25084 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25085 no further messages are sent over that connection.
25086
25087
25088
25089 .section "Use of the $host and $host_address variables" "SECID145"
25090 .vindex "&$host$&"
25091 .vindex "&$host_address$&"
25092 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25093 &$host_address$& are the name and IP address of the first host on the host list
25094 passed by the router. However, when the transport is about to connect to a
25095 specific host, and while it is connected to that host, &$host$& and
25096 &$host_address$& are set to the values for that host. These are the values
25097 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25098 &%serialize_hosts%&, and the various TLS options are expanded.
25099
25100
25101 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25102 .vindex &$tls_bits$&
25103 .vindex &$tls_cipher$&
25104 .vindex &$tls_peerdn$&
25105 .vindex &$tls_sni$&
25106 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25107 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25108 are the values that were set when the message was received.
25109 These are the values that are used for options that are expanded before any
25110 SMTP connections are made. Just before each connection is made, these four
25111 variables are emptied. If TLS is subsequently started, they are set to the
25112 appropriate values for the outgoing connection, and these are the values that
25113 are in force when any authenticators are run and when the
25114 &%authenticated_sender%& option is expanded.
25115
25116 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25117 and will be removed in a future release.
25118
25119
25120 .section "Private options for smtp" "SECID146"
25121 .cindex "options" "&(smtp)& transport"
25122 The private options of the &(smtp)& transport are as follows:
25123
25124
25125 .option address_retry_include_sender smtp boolean true
25126 .cindex "4&'xx'& responses" "retrying after"
25127 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25128 is the combination of sender and recipient that is delayed in subsequent queue
25129 runs until the retry time is reached. You can delay the recipient without
25130 reference to the sender (which is what earlier versions of Exim did), by
25131 setting &%address_retry_include_sender%& false. However, this can lead to
25132 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25133
25134 .option allow_localhost smtp boolean false
25135 .cindex "local host" "sending to"
25136 .cindex "fallback" "hosts specified on transport"
25137 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25138 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25139 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25140 the delivery anyway. This should be used only in special cases when the
25141 configuration ensures that no looping will result (for example, a differently
25142 configured Exim is listening on the port to which the message is sent).
25143
25144
25145 .option authenticated_sender smtp string&!! unset
25146 .cindex "Cyrus"
25147 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25148 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25149 overriding any existing authenticated sender value. If the string expansion is
25150 forced to fail, the option is ignored. Other expansion failures cause delivery
25151 to be deferred. If the result of expansion is an empty string, that is also
25152 ignored.
25153
25154 The expansion happens after the outgoing connection has been made and TLS
25155 started, if required. This means that the &$host$&, &$host_address$&,
25156 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25157 particular connection.
25158
25159 If the SMTP session is not authenticated, the expansion of
25160 &%authenticated_sender%& still happens (and can cause the delivery to be
25161 deferred if it fails), but no AUTH= item is added to MAIL commands
25162 unless &%authenticated_sender_force%& is true.
25163
25164 This option allows you to use the &(smtp)& transport in LMTP mode to
25165 deliver mail to Cyrus IMAP and provide the proper local part as the
25166 &"authenticated sender"&, via a setting such as:
25167 .code
25168 authenticated_sender = $local_part
25169 .endd
25170 This removes the need for IMAP subfolders to be assigned special ACLs to
25171 allow direct delivery to those subfolders.
25172
25173 Because of expected uses such as that just described for Cyrus (when no
25174 domain is involved), there is no checking on the syntax of the provided
25175 value.
25176
25177
25178 .option authenticated_sender_force smtp boolean false
25179 If this option is set true, the &%authenticated_sender%& option's value
25180 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25181 authenticated as a client.
25182
25183
25184 .option command_timeout smtp time 5m
25185 .cindex timeout "smtp transport command"
25186 This sets a timeout for receiving a response to an SMTP command that has been
25187 sent out. It is also used when waiting for the initial banner line from the
25188 remote host. Its value must not be zero.
25189
25190
25191 .option connect_timeout smtp time 5m
25192 .cindex timeout "smtp transport connect"
25193 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25194 to a remote host. A setting of zero allows the system timeout (typically
25195 several minutes) to act. To have any effect, the value of this option must be
25196 less than the system timeout. However, it has been observed that on some
25197 systems there is no system timeout, which is why the default value for this
25198 option is 5 minutes, a value recommended by RFC 1123.
25199
25200
25201 .option connection_max_messages smtp integer 500
25202 .cindex "SMTP" "passed connection"
25203 .cindex "SMTP" "multiple deliveries"
25204 .cindex "multiple SMTP deliveries"
25205 This controls the maximum number of separate message deliveries that are sent
25206 over a single TCP/IP connection. If the value is zero, there is no limit.
25207 For testing purposes, this value can be overridden by the &%-oB%& command line
25208 option.
25209
25210
25211 .option dane_require_tls_ciphers smtp string&!! unset
25212 .cindex "TLS" "requiring specific ciphers for DANE"
25213 .cindex "cipher" "requiring specific"
25214 .cindex DANE "TLS ciphers"
25215 This option may be used to override &%tls_require_ciphers%& for connections
25216 where DANE has been determined to be in effect.
25217 If not set, then &%tls_require_ciphers%& will be used.
25218 Normal SMTP delivery is not able to make strong demands of TLS cipher
25219 configuration, because delivery will fall back to plaintext.  Once DANE has
25220 been determined to be in effect, there is no plaintext fallback and making the
25221 TLS cipherlist configuration stronger will increase security, rather than
25222 counter-intuitively decreasing it.
25223 If the option expands to be empty or is forced to fail, then it will
25224 be treated as unset and &%tls_require_ciphers%& will be used instead.
25225
25226
25227 .option data_timeout smtp time 5m
25228 .cindex timeout "for transmitted SMTP data blocks"
25229 This sets a timeout for the transmission of each block in the data portion of
25230 the message. As a result, the overall timeout for a message depends on the size
25231 of the message. Its value must not be zero. See also &%final_timeout%&.
25232
25233
25234 .option dkim_canon smtp string&!! unset
25235 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25236 .option dkim_domain smtp "string list&!!" unset
25237 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25238 .option dkim_hash smtp string&!! sha256
25239 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25240 .option dkim_identity smtp string&!! unset
25241 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25242 .option dkim_private_key smtp string&!! unset
25243 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25244 .option dkim_selector smtp string&!! unset
25245 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25246 .option dkim_strict smtp string&!! unset
25247 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25248 .option dkim_sign_headers smtp string&!! "per RFC"
25249 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25250 .option dkim_timestamps smtp string&!! unset
25251 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25252
25253
25254 .option delay_after_cutoff smtp boolean true
25255 .cindex "final cutoff" "retries, controlling"
25256 .cindex retry "final cutoff"
25257 This option controls what happens when all remote IP addresses for a given
25258 domain have been inaccessible for so long that they have passed their retry
25259 cutoff times.
25260
25261 In the default state, if the next retry time has not been reached for any of
25262 them, the address is bounced without trying any deliveries. In other words,
25263 Exim delays retrying an IP address after the final cutoff time until a new
25264 retry time is reached, and can therefore bounce an address without ever trying
25265 a delivery, when machines have been down for a long time. Some people are
25266 unhappy at this prospect, so...
25267
25268 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25269 addresses are past their final cutoff time, Exim tries to deliver to those
25270 IP addresses that have not been tried since the message arrived. If there are
25271 none, of if they all fail, the address is bounced. In other words, it does not
25272 delay when a new message arrives, but immediately tries those expired IP
25273 addresses that haven't been tried since the message arrived. If there is a
25274 continuous stream of messages for the dead hosts, unsetting
25275 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25276 to them.
25277
25278
25279 .option dns_qualify_single smtp boolean true
25280 If the &%hosts%& or &%fallback_hosts%& option is being used,
25281 and the &%gethostbyname%& option is false,
25282 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25283 in chapter &<<CHAPdnslookup>>& for more details.
25284
25285
25286 .option dns_search_parents smtp boolean false
25287 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25288 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25289 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25290 details.
25291
25292
25293 .option dnssec_request_domains smtp "domain list&!!" *
25294 .cindex "MX record" "security"
25295 .cindex "DNSSEC" "MX lookup"
25296 .cindex "security" "MX lookup"
25297 .cindex "DNS" "DNSSEC"
25298 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25299 the DNSSEC request bit set. Setting this transport option is only useful if the
25300 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25301 router option.
25302
25303
25304
25305 .option dnssec_require_domains smtp "domain list&!!" unset
25306 .cindex "MX record" "security"
25307 .cindex "DNSSEC" "MX lookup"
25308 .cindex "security" "MX lookup"
25309 .cindex "DNS" "DNSSEC"
25310 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25311 the DNSSEC request bit set.  Setting this transport option is only
25312 useful if the transport overrides or sets the host names. See the
25313 &%dnssec_require_domains%& router option.
25314
25315
25316
25317 .option dscp smtp string&!! unset
25318 .cindex "DCSP" "outbound"
25319 This option causes the DSCP value associated with a socket to be set to one
25320 of a number of fixed strings or to numeric value.
25321 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25322 Common values include &`throughput`&, &`mincost`&, and on newer systems
25323 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25324
25325 The outbound packets from Exim will be marked with this value in the header
25326 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25327 that these values will have any effect, not be stripped by networking
25328 equipment, or do much of anything without cooperation with your Network
25329 Engineer and those of all network operators between the source and destination.
25330
25331
25332 .option fallback_hosts smtp "string list" unset
25333 .cindex "fallback" "hosts specified on transport"
25334 String expansion is not applied to this option. The argument must be a
25335 colon-separated list of host names or IP addresses, optionally also including
25336 port numbers, though the separator can be changed, as described in section
25337 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25338 item in a &%route_list%& setting for the &(manualroute)& router, as described
25339 in section &<<SECTformatonehostitem>>&.
25340
25341 Fallback hosts can also be specified on routers, which associate them with the
25342 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25343 &%fallback_hosts%& specified on the transport is used only if the address does
25344 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25345 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25346 However, &%hosts_randomize%& does apply to fallback host lists.
25347
25348 If Exim is unable to deliver to any of the hosts for a particular address, and
25349 the errors are not permanent rejections, the address is put on a separate
25350 transport queue with its host list replaced by the fallback hosts, unless the
25351 address was routed via MX records and the current host was in the original MX
25352 list. In that situation, the fallback host list is not used.
25353
25354 Once normal deliveries are complete, the fallback queue is delivered by
25355 re-running the same transports with the new host lists. If several failing
25356 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25357 copy of the message is sent.
25358
25359 The resolution of the host names on the fallback list is controlled by the
25360 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25361 both to cases when the host list comes with the address and when it is taken
25362 from &%hosts%&. This option provides a &"use a smart host only if delivery
25363 fails"& facility.
25364
25365
25366 .option final_timeout smtp time 10m
25367 .cindex timeout "for transmitted SMTP data accept"
25368 This is the timeout that applies while waiting for the response to the final
25369 line containing just &"."& that terminates a message. Its value must not be
25370 zero.
25371
25372 .option gethostbyname smtp boolean false
25373 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25374 being used, names are looked up using &[gethostbyname()]&
25375 (or &[getipnodebyname()]& when available)
25376 instead of using the DNS. Of course, that function may in fact use the DNS, but
25377 it may also consult other sources of information such as &_/etc/hosts_&.
25378
25379 .option gnutls_compat_mode smtp boolean unset
25380 This option controls whether GnuTLS is used in compatibility mode in an Exim
25381 server. This reduces security slightly, but improves interworking with older
25382 implementations of TLS.
25383
25384 .option helo_data smtp string&!! "see below"
25385 .cindex "HELO" "argument, setting"
25386 .cindex "EHLO" "argument, setting"
25387 .cindex "LHLO argument setting"
25388 The value of this option is expanded after a connection to a another host has
25389 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25390 command that starts the outgoing SMTP or LMTP session. The default value of the
25391 option is:
25392 .code
25393 $primary_hostname
25394 .endd
25395 During the expansion, the variables &$host$& and &$host_address$& are set to
25396 the identity of the remote host, and the variables &$sending_ip_address$& and
25397 &$sending_port$& are set to the local IP address and port number that are being
25398 used. These variables can be used to generate different values for different
25399 servers or different local IP addresses. For example, if you want the string
25400 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25401 interface address, you could use this:
25402 .code
25403 helo_data = ${lookup dnsdb{ptr=$sending_ip_address} \
25404   {${listextract{1}{<\n $value}}} \
25405   {$primary_hostname}}
25406 .endd
25407 The use of &%helo_data%& applies both to sending messages and when doing
25408 callouts.
25409
25410 .option host_name_extract smtp "string list&!!" "see below"
25411 .cindex "load balancer" "hosts behind"
25412 .cindex TLS resumption
25413 Some mail-accepting sites
25414 (notably Microsoft)
25415 operate many servers behind a network load-balancer.  When this is done,
25416 with separated TLS session caches, TLS session resuption becomes problematic.
25417 It will only succeed when the same server happens to be selected by the
25418 load-balancer, matching the session stored in the client's cache.
25419
25420 Exim can pull out a server name, if there is one, from the response to the
25421 client's SMTP EHLO command.
25422 The default value of this option:
25423 .code
25424     ${if and { {match {$host} {.outlook.com\$}} \
25425                {match {$item} {\N^250-([\w.]+)\s\N}} \
25426              } {$1}}
25427 .endd
25428 suffices for one known case.
25429 During the expansion of this option the &$item$& variable will have the
25430 server's EHLO response.
25431 The result of the option expansion is included in the key used to store and
25432 retrieve the TLS session, for session resumption.
25433
25434 Operators of high-load sites may wish to evaluate their logs for indications
25435 of other destination sites operating load-balancers, and develop a suitable
25436 expression for this option.
25437 The smtp:ehlo event and the &$tls_out_resumption$& variable
25438 will be useful for such work.
25439
25440 .option hosts smtp "string list&!!" unset
25441 Hosts are associated with an address by a router such as &(dnslookup)&, which
25442 finds the hosts by looking up the address domain in the DNS, or by
25443 &(manualroute)&, which has lists of hosts in its configuration. However,
25444 email addresses can be passed to the &(smtp)& transport by any router, and not
25445 all of them can provide an associated list of hosts.
25446
25447 The &%hosts%& option specifies a list of hosts to be used if the address being
25448 processed does not have any hosts associated with it. The hosts specified by
25449 &%hosts%& are also used, whether or not the address has its own hosts, if
25450 &%hosts_override%& is set.
25451
25452 The string is first expanded, before being interpreted as a colon-separated
25453 list of host names or IP addresses, possibly including port numbers. The
25454 separator may be changed to something other than colon, as described in section
25455 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25456 item in a &%route_list%& setting for the &(manualroute)& router, as described
25457 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25458 of the &(manualroute)& router is not available here.
25459
25460 If the expansion fails, delivery is deferred. Unless the failure was caused by
25461 the inability to complete a lookup, the error is logged to the panic log as
25462 well as the main log. Host names are looked up either by searching directly for
25463 address records in the DNS or by calling &[gethostbyname()]& (or
25464 &[getipnodebyname()]& when available), depending on the setting of the
25465 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25466 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25467 address are used.
25468
25469 During delivery, the hosts are tried in order, subject to their retry status,
25470 unless &%hosts_randomize%& is set.
25471
25472
25473 .option hosts_avoid_esmtp smtp "host list&!!" unset
25474 .cindex "ESMTP, avoiding use of"
25475 .cindex "HELO" "forcing use of"
25476 .cindex "EHLO" "avoiding use of"
25477 .cindex "PIPELINING" "avoiding the use of"
25478 This option is for use with broken hosts that announce ESMTP facilities (for
25479 example, PIPELINING) and then fail to implement them properly. When a host
25480 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25481 start of the SMTP session. This means that it cannot use any of the ESMTP
25482 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25483
25484
25485 .option hosts_avoid_pipelining smtp "host list&!!" unset
25486 .cindex "PIPELINING" "avoiding the use of"
25487 .cindex "ESMTP extensions" PIPELINING
25488 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25489 that matches this list, even if the server host advertises PIPELINING support.
25490
25491 .option hosts_pipe_connect smtp "host list&!!" unset
25492 .cindex "pipelining" "early connection"
25493 .cindex "pipelining" PIPECONNECT
25494 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25495 this option controls which to hosts the facility watched for
25496 and recorded, and used for subsequent connections.
25497
25498 The retry hints database is used for the record,
25499 and records are subject to the &%retry_data_expire%& option.
25500 When used, the pipelining saves on roundtrip times.
25501 It also turns SMTP into a client-first protocol
25502 so combines well with TCP Fast Open.
25503
25504 See also the &%pipelining_connect_advertise_hosts%& main option.
25505
25506 Note:
25507 When the facility is used, if the transport &%interface%& option is unset
25508 the &%helo_data%& option
25509 will be expanded before the &$sending_ip_address$& variable
25510 is filled in.
25511 A check is made for the use of that variable, without the
25512 presence of a &"def:"& test on it, but suitably complex coding
25513 can avoid the check and produce unexpected results.
25514 You have been warned.
25515
25516
25517 .option hosts_avoid_tls smtp "host list&!!" unset
25518 .cindex "TLS" "avoiding for certain hosts"
25519 Exim will not try to start a TLS session when delivering to any host that
25520 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25521
25522 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25523 .cindex "TLS" "avoiding for certain hosts"
25524 Exim will not try to start a TLS session for a verify callout,
25525 or when delivering in cutthrough mode,
25526 to any host that matches this list.
25527
25528
25529 .option hosts_max_try smtp integer 5
25530 .cindex "host" "maximum number to try"
25531 .cindex "limit" "number of hosts tried"
25532 .cindex "limit" "number of MX tried"
25533 .cindex "MX record" "maximum tried"
25534 This option limits the number of IP addresses that are tried for any one
25535 delivery in cases where there are temporary delivery errors. Section
25536 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25537
25538
25539 .option hosts_max_try_hardlimit smtp integer 50
25540 This is an additional check on the maximum number of IP addresses that Exim
25541 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25542 why it exists.
25543
25544
25545
25546 .option hosts_nopass_tls smtp "host list&!!" unset
25547 .cindex "TLS" "passing connection"
25548 .cindex "multiple SMTP deliveries"
25549 .cindex "TLS" "multiple message deliveries"
25550 For any host that matches this list, a connection on which a TLS session has
25551 been started will not be passed to a new delivery process for sending another
25552 message on the same connection. See section &<<SECTmulmessam>>& for an
25553 explanation of when this might be needed.
25554
25555 .option hosts_noproxy_tls smtp "host list&!!" unset
25556 .cindex "TLS" "passing connection"
25557 .cindex "multiple SMTP deliveries"
25558 .cindex "TLS" "multiple message deliveries"
25559 For any host that matches this list, a TLS session which has
25560 been started will not be passed to a new delivery process for sending another
25561 message on the same session.
25562
25563 The traditional implementation closes down TLS and re-starts it in the new
25564 process, on the same open TCP connection, for each successive message
25565 sent.  If permitted by this option a pipe to to the new process is set up
25566 instead, and the original process maintains the TLS connection and proxies
25567 the SMTP connection from and to the new process and any subsequents.
25568 The new process has no access to TLS information, so cannot include it in
25569 logging.
25570
25571
25572
25573 .option hosts_override smtp boolean false
25574 If this option is set and the &%hosts%& option is also set, any hosts that are
25575 attached to the address are ignored, and instead the hosts specified by the
25576 &%hosts%& option are always used. This option does not apply to
25577 &%fallback_hosts%&.
25578
25579
25580 .option hosts_randomize smtp boolean false
25581 .cindex "randomized host list"
25582 .cindex "host" "list of; randomized"
25583 .cindex "fallback" "randomized hosts"
25584 If this option is set, and either the list of hosts is taken from the
25585 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25586 were not obtained from MX records (this includes fallback hosts from the
25587 router), and were not randomized by the router, the order of trying the hosts
25588 is randomized each time the transport runs. Randomizing the order of a host
25589 list can be used to do crude load sharing.
25590
25591 When &%hosts_randomize%& is true, a host list may be split into groups whose
25592 order is separately randomized. This makes it possible to set up MX-like
25593 behaviour. The boundaries between groups are indicated by an item that is just
25594 &`+`& in the host list. For example:
25595 .code
25596 hosts = host1:host2:host3:+:host4:host5
25597 .endd
25598 The order of the first three hosts and the order of the last two hosts is
25599 randomized for each use, but the first three always end up before the last two.
25600 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25601
25602 .option hosts_require_auth smtp "host list&!!" unset
25603 .cindex "authentication" "required by client"
25604 This option provides a list of servers for which authentication must succeed
25605 before Exim will try to transfer a message. If authentication fails for
25606 servers which are not in this list, Exim tries to send unauthenticated. If
25607 authentication fails for one of these servers, delivery is deferred. This
25608 temporary error is detectable in the retry rules, so it can be turned into a
25609 hard failure if required. See also &%hosts_try_auth%&, and chapter
25610 &<<CHAPSMTPAUTH>>& for details of authentication.
25611
25612
25613 .option hosts_request_ocsp smtp "host list&!!" "see below"
25614 .cindex "TLS" "requiring for certain servers"
25615 Exim will request a Certificate Status on a
25616 TLS session for any host that matches this list.
25617 &%tls_verify_certificates%& should also be set for the transport.
25618
25619 .new
25620 The default is &"**"& if DANE is not in use for the connection,
25621 or if DANE-TA us used.
25622 It is empty if DANE-EE is used.
25623 .wen
25624
25625 .option hosts_require_alpn smtp "host list&!!" unset
25626 .cindex ALPN "require negotiation in client"
25627 .cindex TLS ALPN
25628 .cindex TLS "Application Layer Protocol Names"
25629 If the TLS library supports ALPN
25630 then a successful negotiation of ALPN will be required for any host
25631 matching the list, for TLS to be used.
25632 See also the &%tls_alpn%& option.
25633
25634 &*Note*&: prevention of fallback to in-clear connection is not
25635 managed by this option; see &%hosts_require_tls%&.
25636
25637 .option hosts_require_dane smtp "host list&!!" unset
25638 .cindex DANE "transport options"
25639 .cindex DANE "requiring for certain servers"
25640 If built with DANE support, Exim  will require that a DNSSEC-validated
25641 TLSA record is present for any host matching the list,
25642 and that a DANE-verified TLS connection is made.
25643 There will be no fallback to in-clear communication.
25644 See the &%dnssec_request_domains%& router and transport options.
25645 See section &<<SECDANE>>&.
25646
25647 .option hosts_require_ocsp smtp "host list&!!" unset
25648 .cindex "TLS" "requiring for certain servers"
25649 Exim will request, and check for a valid Certificate Status being given, on a
25650 TLS session for any host that matches this list.
25651 &%tls_verify_certificates%& should also be set for the transport.
25652
25653 .option hosts_require_tls smtp "host list&!!" unset
25654 .cindex "TLS" "requiring for certain servers"
25655 Exim will insist on using a TLS session when delivering to any host that
25656 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25657 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25658 incoming messages, use an appropriate ACL.
25659
25660 .option hosts_try_auth smtp "host list&!!" unset
25661 .cindex "authentication" "optional in client"
25662 This option provides a list of servers to which, provided they announce
25663 authentication support, Exim will attempt to authenticate as a client when it
25664 connects. If authentication fails
25665 and &%hosts_require_auth%& permits,
25666 Exim will try to transfer the message unauthenticated.
25667 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25668
25669 .option hosts_try_chunking smtp "host list&!!" *
25670 .cindex CHUNKING "enabling, in client"
25671 .cindex BDAT "SMTP command"
25672 .cindex "RFC 3030" "CHUNKING"
25673 This option provides a list of servers to which, provided they announce
25674 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25675 Unless DKIM signing is being done,
25676 BDAT will not be used in conjunction with a transport filter.
25677
25678 .option hosts_try_dane smtp "host list&!!" *
25679 .cindex DANE "transport options"
25680 .cindex DANE "attempting for certain servers"
25681 If built with DANE support, Exim  will look up a
25682 TLSA record for any host matching the list,
25683 If one is found and that lookup was DNSSEC-validated,
25684 then Exim requires that a DANE-verified TLS connection is made for that host;
25685 there will be no fallback to in-clear communication.
25686 See the &%dnssec_request_domains%& router and transport options.
25687 See section &<<SECDANE>>&.
25688
25689 .option hosts_try_fastopen smtp "host list&!!" *
25690 .cindex "fast open, TCP" "enabling, in client"
25691 .cindex "TCP Fast Open" "enabling, in client"
25692 .cindex "RFC 7413" "TCP Fast Open"
25693 This option provides a list of servers to which, provided
25694 the facility is supported by this system, Exim will attempt to
25695 perform a TCP Fast Open.
25696 No data is sent on the SYN segment but, if the remote server also
25697 supports the facility, it can send its SMTP banner immediately after
25698 the SYN,ACK segment.  This can save up to one round-trip time.
25699
25700 The facility is only active for previously-contacted servers,
25701 as the initiator must present a cookie in the SYN segment.
25702
25703 On (at least some) current Linux distributions the facility must be enabled
25704 in the kernel by the sysadmin before the support is usable.
25705 There is no option for control of the server side; if the system supports
25706 it it is always enabled.  Note that lengthy operations in the connect ACL,
25707 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25708
25709 .option hosts_try_prdr smtp "host list&!!" *
25710 .cindex "PRDR" "enabling, optional in client"
25711 .cindex "ESMTP extensions" PRDR
25712 This option provides a list of servers to which, provided they announce
25713 PRDR support, Exim will attempt to negotiate PRDR
25714 for multi-recipient messages.
25715 The option can usually be left as default.
25716
25717 .option interface smtp "string list&!!" unset
25718 .cindex "bind IP address"
25719 .cindex "IP address" "binding"
25720 .vindex "&$host$&"
25721 .vindex "&$host_address$&"
25722 This option specifies which interface to bind to when making an outgoing SMTP
25723 call. The value is an IP address, not an interface name such as
25724 &`eth0`&. Do not confuse this with the interface address that was used when a
25725 message was received, which is in &$received_ip_address$&, formerly known as
25726 &$interface_address$&. The name was changed to minimize confusion with the
25727 outgoing interface address. There is no variable that contains an outgoing
25728 interface address because, unless it is set by this option, its value is
25729 unknown.
25730
25731 During the expansion of the &%interface%& option the variables &$host$& and
25732 &$host_address$& refer to the host to which a connection is about to be made
25733 during the expansion of the string. Forced expansion failure, or an empty
25734 string result causes the option to be ignored. Otherwise, after expansion, the
25735 string must be a list of IP addresses, colon-separated by default, but the
25736 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25737 For example:
25738 .code
25739 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25740 .endd
25741 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25742 connection. If none of them are the correct type, the option is ignored. If
25743 &%interface%& is not set, or is ignored, the system's IP functions choose which
25744 interface to use if the host has more than one.
25745
25746
25747 .option keepalive smtp boolean true
25748 .cindex "keepalive" "on outgoing connection"
25749 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25750 connections. When set, it causes the kernel to probe idle connections
25751 periodically, by sending packets with &"old"& sequence numbers. The other end
25752 of the connection should send a acknowledgment if the connection is still okay
25753 or a reset if the connection has been aborted. The reason for doing this is
25754 that it has the beneficial effect of freeing up certain types of connection
25755 that can get stuck when the remote host is disconnected without tidying up the
25756 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25757 unreachable hosts.
25758
25759
25760 .option lmtp_ignore_quota smtp boolean false
25761 .cindex "LMTP" "ignoring quota errors"
25762 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25763 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25764 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25765
25766 .option max_rcpt smtp integer 100
25767 .cindex "RCPT" "maximum number of outgoing"
25768 This option limits the number of RCPT commands that are sent in a single
25769 SMTP message transaction. Each set of addresses is treated independently, and
25770 so can cause parallel connections to the same host if &%remote_max_parallel%&
25771 permits this. A value setting of zero disables the limit.
25772
25773
25774 .option message_linelength_limit smtp integer 998
25775 .cindex "line length" limit
25776 This option sets the maximum line length, in bytes, that the transport
25777 will send.  Any messages with lines exceeding the given value
25778 will fail and a failure-DSN ("bounce") message will if possible be returned
25779 to the sender.
25780 The default value is that defined by the SMTP standards.
25781
25782 It is generally wise to also check in the data ACL so that messages
25783 received via SMTP can be refused without producing a bounce.
25784
25785
25786 .option multi_domain smtp boolean&!! true
25787 .vindex "&$domain$&"
25788 When this option is set, the &(smtp)& transport can handle a number of
25789 addresses containing a mixture of different domains provided they all resolve
25790 to the same list of hosts. Turning the option off restricts the transport to
25791 handling only one domain at a time. This is useful if you want to use
25792 &$domain$& in an expansion for the transport, because it is set only when there
25793 is a single domain involved in a remote delivery.
25794
25795 It is expanded per-address and can depend on any of
25796 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25797 &$host$&, &$host_address$& and &$host_port$&.
25798
25799 If the connection is DANE-enabled then this option is ignored;
25800 only messages having the domain used for the DANE TLSA lookup are
25801 sent on the connection.
25802
25803 .option port smtp string&!! "see below"
25804 .cindex "port" "sending TCP/IP"
25805 .cindex "TCP/IP" "setting outgoing port"
25806 This option specifies the TCP/IP port on the server to which Exim connects.
25807 &*Note:*& Do not confuse this with the port that was used when a message was
25808 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25809 The name was changed to minimize confusion with the outgoing port. There is no
25810 variable that contains an outgoing port.
25811
25812 If the value of this option begins with a digit it is taken as a port number;
25813 otherwise it is looked up using &[getservbyname()]&. The default value is
25814 normally &"smtp"&,
25815 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25816 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25817 If the expansion fails, or if a port number cannot be found, delivery
25818 is deferred.
25819
25820 Note that at least one Linux distribution has been seen failing
25821 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25822
25823
25824
25825 .option protocol smtp string smtp
25826 .cindex "LMTP" "over TCP/IP"
25827 .cindex "ssmtp protocol" "outbound"
25828 .cindex "TLS" "SSL-on-connect outbound"
25829 .vindex "&$port$&"
25830 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25831 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25832 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25833 deliveries into closed message stores. Exim also has support for running LMTP
25834 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25835
25836 If this option is set to &"smtps"&, the default value for the &%port%& option
25837 changes to &"smtps"&, and the transport initiates TLS immediately after
25838 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25839 The Internet standards bodies used to strongly discourage use of this mode,
25840 but as of RFC 8314 it is preferred over STARTTLS for message submission
25841 (as distinct from MTA-MTA communication).
25842
25843
25844 .option retry_include_ip_address smtp boolean&!! true
25845 Exim normally includes both the host name and the IP address in the key it
25846 constructs for indexing retry data after a temporary delivery failure. This
25847 means that when one of several IP addresses for a host is failing, it gets
25848 tried periodically (controlled by the retry rules), but use of the other IP
25849 addresses is not affected.
25850
25851 However, in some dialup environments hosts are assigned a different IP address
25852 each time they connect. In this situation the use of the IP address as part of
25853 the retry key leads to undesirable behaviour. Setting this option false causes
25854 Exim to use only the host name.
25855 Since it is expanded it can be made to depend on the host or domain.
25856
25857
25858 .option serialize_hosts smtp "host list&!!" unset
25859 .cindex "serializing connections"
25860 .cindex "host" "serializing connections"
25861 Because Exim operates in a distributed manner, if several messages for the same
25862 host arrive at around the same time, more than one simultaneous connection to
25863 the remote host can occur. This is not usually a problem except when there is a
25864 slow link between the hosts. In that situation it may be helpful to restrict
25865 Exim to one connection at a time. This can be done by setting
25866 &%serialize_hosts%& to match the relevant hosts.
25867
25868 .cindex "hints database" "serializing deliveries to a host"
25869 Exim implements serialization by means of a hints database in which a record is
25870 written whenever a process connects to one of the restricted hosts. The record
25871 is deleted when the connection is completed. Obviously there is scope for
25872 records to get left lying around if there is a system or program crash. To
25873 guard against this, Exim ignores any records that are more than six hours old.
25874
25875 If you set up this kind of serialization, you should also arrange to delete the
25876 relevant hints database whenever your system reboots. The names of the files
25877 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25878 may be one or two files, depending on the type of DBM in use. The same files
25879 are used for ETRN serialization.
25880
25881 See also the &%max_parallel%& generic transport option.
25882
25883
25884 .option size_addition smtp integer 1024
25885 .cindex "SIZE" "ESMTP extension"
25886 .cindex "message" "size issue for transport filter"
25887 .cindex "size" "of message"
25888 .cindex "transport" "filter"
25889 .cindex "filter" "transport filter"
25890 If a remote SMTP server indicates that it supports the SIZE option of the
25891 MAIL command, Exim uses this to pass over the message size at the start of
25892 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25893 sends, to allow for headers and other text that may be added during delivery by
25894 configuration options or in a transport filter. It may be necessary to increase
25895 this if a lot of text is added to messages.
25896
25897 Alternatively, if the value of &%size_addition%& is set negative, it disables
25898 the use of the SIZE option altogether.
25899
25900
25901 .option socks_proxy smtp string&!! unset
25902 .cindex proxy SOCKS
25903 This option enables use of SOCKS proxies for connections made by the
25904 transport.  For details see section &<<SECTproxySOCKS>>&.
25905
25906
25907 .option tls_alpn smtp string&!! unset
25908 .cindex TLS "Application Layer Protocol Names"
25909 .cindex TLS ALPN
25910 .cindex ALPN "set name in client"
25911 If this option is set
25912 and the TLS library supports ALPN,
25913 the value given is used.
25914
25915 As of writing no value has been standardised for email use.
25916 The authors suggest using &"smtp"&.
25917
25918
25919
25920 .option tls_certificate smtp string&!! unset
25921 .cindex "TLS" "client certificate, location of"
25922 .cindex "certificate" "client, location of"
25923 .vindex "&$host$&"
25924 .vindex "&$host_address$&"
25925 The value of this option must be the absolute path to a file which contains the
25926 client's certificate, for possible use when sending a message over an encrypted
25927 connection. The values of &$host$& and &$host_address$& are set to the name and
25928 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25929 details of TLS.
25930
25931 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25932 certificate when sending messages as a client. The global option of the same
25933 name specifies the certificate for Exim as a server; it is not automatically
25934 assumed that the same certificate should be used when Exim is operating as a
25935 client.
25936
25937
25938 .option tls_crl smtp string&!! unset
25939 .cindex "TLS" "client certificate revocation list"
25940 .cindex "certificate" "revocation list for client"
25941 This option specifies a certificate revocation list. The expanded value must
25942 be the name of a file that contains a CRL in PEM format.
25943
25944
25945 .option tls_dh_min_bits smtp integer 1024
25946 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25947 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25948 key agreement is negotiated, the server will provide a large prime number
25949 for use.  This option establishes the minimum acceptable size of that number.
25950 If the parameter offered by the server is too small, then the TLS handshake
25951 will fail.
25952
25953 Only supported when using GnuTLS.
25954
25955
25956 .option tls_privatekey smtp string&!! unset
25957 .cindex "TLS" "client private key, location of"
25958 .vindex "&$host$&"
25959 .vindex "&$host_address$&"
25960 The value of this option must be the absolute path to a file which contains the
25961 client's private key. This is used when sending a message over an encrypted
25962 connection using a client certificate. The values of &$host$& and
25963 &$host_address$& are set to the name and address of the server during the
25964 expansion. If this option is unset, or the expansion is forced to fail, or the
25965 result is an empty string, the private key is assumed to be in the same file as
25966 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25967
25968
25969 .option tls_require_ciphers smtp string&!! unset
25970 .cindex "TLS" "requiring specific ciphers"
25971 .cindex "cipher" "requiring specific"
25972 .vindex "&$host$&"
25973 .vindex "&$host_address$&"
25974 The value of this option must be a list of permitted cipher suites, for use
25975 when setting up an outgoing encrypted connection. (There is a global option of
25976 the same name for controlling incoming connections.) The values of &$host$& and
25977 &$host_address$& are set to the name and address of the server during the
25978 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25979 is used in different ways by OpenSSL and GnuTLS (see sections
25980 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25981 ciphers is a preference order.
25982
25983
25984 .option tls_resumption_hosts smtp "host list&!!" unset
25985 .cindex TLS resumption
25986 This option controls which connections to use the TLS resumption feature.
25987 See &<<SECTresumption>>& for details.
25988
25989
25990
25991 .option tls_sni smtp string&!! unset
25992 .cindex "TLS" "Server Name Indication"
25993 .cindex "TLS" SNI
25994 .cindex SNI "setting in client"
25995 .vindex "&$tls_sni$&"
25996 If this option is set
25997 and the connection is not DANE-validated
25998 then it sets the $tls_out_sni variable and causes any
25999 TLS session to pass this value as the Server Name Indication extension to
26000 the remote side, which can be used by the remote side to select an appropriate
26001 certificate and private key for the session.
26002
26003 See &<<SECTtlssni>>& for more information.
26004
26005 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
26006 TLS extensions.
26007
26008
26009
26010
26011 .option tls_tempfail_tryclear smtp boolean true
26012 .cindex "4&'xx'& responses" "to STARTTLS"
26013 When the server host is not in &%hosts_require_tls%&, and there is a problem in
26014 setting up a TLS session, this option determines whether or not Exim should try
26015 to deliver the message unencrypted. If it is set false, delivery to the
26016 current host is deferred; if there are other hosts, they are tried. If this
26017 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
26018 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
26019 TLS negotiation fails, Exim closes the current connection (because it is in an
26020 unknown state), opens a new one to the same host, and then tries the delivery
26021 in clear.
26022
26023
26024 .option tls_try_verify_hosts smtp "host list&!!" *
26025 .cindex "TLS" "server certificate verification"
26026 .cindex "certificate" "verification of server"
26027 This option gives a list of hosts for which, on encrypted connections,
26028 certificate verification will be tried but need not succeed.
26029 The &%tls_verify_certificates%& option must also be set.
26030 Note that unless the host is in this list
26031 TLS connections will be denied to hosts using self-signed certificates
26032 when &%tls_verify_certificates%& is matched.
26033 The &$tls_out_certificate_verified$& variable is set when
26034 certificate verification succeeds.
26035
26036
26037 .option tls_verify_cert_hostnames smtp "host list&!!" *
26038 .cindex "TLS" "server certificate hostname verification"
26039 .cindex "certificate" "verification of server"
26040 This option give a list of hosts for which,
26041 while verifying the server certificate,
26042 checks will be included on the host name
26043 (note that this will generally be the result of a DNS MX lookup)
26044 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
26045 limited to being the initial component of a 3-or-more component FQDN.
26046
26047 There is no equivalent checking on client certificates.
26048
26049
26050 .option tls_verify_certificates smtp string&!! system
26051 .cindex "TLS" "server certificate verification"
26052 .cindex "certificate" "verification of server"
26053 .vindex "&$host$&"
26054 .vindex "&$host_address$&"
26055 The value of this option must be either the
26056 word "system"
26057 or the absolute path to
26058 a file or directory containing permitted certificates for servers,
26059 for use when setting up an encrypted connection.
26060
26061 The "system" value for the option will use a location compiled into the SSL library.
26062 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
26063 is taken as empty and an explicit location
26064 must be specified.
26065
26066 The use of a directory for the option value is not available for GnuTLS versions
26067 preceding 3.3.6 and a single file must be used.
26068
26069 With OpenSSL the certificates specified
26070 explicitly
26071 either by file or directory
26072 are added to those given by the system default location.
26073
26074 The values of &$host$& and
26075 &$host_address$& are set to the name and address of the server during the
26076 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
26077
26078 For back-compatibility,
26079 if neither tls_verify_hosts nor tls_try_verify_hosts are set
26080 (a single-colon empty list counts as being set)
26081 and certificate verification fails the TLS connection is closed.
26082
26083
26084 .option tls_verify_hosts smtp "host list&!!" unset
26085 .cindex "TLS" "server certificate verification"
26086 .cindex "certificate" "verification of server"
26087 This option gives a list of hosts for which, on encrypted connections,
26088 certificate verification must succeed.
26089 The &%tls_verify_certificates%& option must also be set.
26090 If both this option and &%tls_try_verify_hosts%& are unset
26091 operation is as if this option selected all hosts.
26092 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
26093 that connections use TLS.
26094 Fallback to in-clear communication will be done unless restricted by
26095 the &%hosts_require_tls%& option.
26096
26097 .option utf8_downconvert smtp integer&!! -1
26098 .cindex utf8 "address downconversion"
26099 .cindex i18n "utf8 address downconversion"
26100 If built with internationalization support,
26101 this option controls conversion of UTF-8 in message envelope addresses
26102 to a-label form.
26103 If, after expansion, the value is 1, 0, or -1 then this value overrides
26104 any value previously set for the message.  Otherwise, any previously
26105 set value is used.  To permit use of a previous value,
26106 set this option to an empty string.
26107 For details on the values see section &<<SECTi18nMTA>>&.
26108
26109
26110
26111
26112 .section "How the limits for the number of hosts to try are used" &&&
26113          "SECTvalhosmax"
26114 .cindex "host" "maximum number to try"
26115 .cindex "limit" "hosts; maximum number tried"
26116 There are two options that are concerned with the number of hosts that are
26117 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
26118 &%hosts_max_try_hardlimit%&.
26119
26120
26121 The &%hosts_max_try%& option limits the number of hosts that are tried
26122 for a single delivery. However, despite the term &"host"& in its name, the
26123 option actually applies to each IP address independently. In other words, a
26124 multihomed host is treated as several independent hosts, just as it is for
26125 retrying.
26126
26127 Many of the larger ISPs have multiple MX records which often point to
26128 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26129 created as a result of routing one of these domains.
26130
26131 Trying every single IP address on such a long list does not seem sensible; if
26132 several at the top of the list fail, it is reasonable to assume there is some
26133 problem that is likely to affect all of them. Roughly speaking, the value of
26134 &%hosts_max_try%& is the maximum number that are tried before deferring the
26135 delivery. However, the logic cannot be quite that simple.
26136
26137 Firstly, IP addresses that are skipped because their retry times have not
26138 arrived do not count, and in addition, addresses that are past their retry
26139 limits are also not counted, even when they are tried. This means that when
26140 some IP addresses are past their retry limits, more than the value of
26141 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26142 that all IP addresses are considered before timing out an email address (but
26143 see below for an exception).
26144
26145 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26146 list to see if there is a subsequent host with a different (higher valued) MX.
26147 If there is, that host is considered next, and the current IP address is used
26148 but not counted. This behaviour helps in the case of a domain with a retry rule
26149 that hardly ever delays any hosts, as is now explained:
26150
26151 Consider the case of a long list of hosts with one MX value, and a few with a
26152 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26153 hosts at the top of the list are tried at first. With the default retry rule,
26154 which specifies increasing retry times, the higher MX hosts are eventually
26155 tried when those at the top of the list are skipped because they have not
26156 reached their retry times.
26157
26158 However, it is common practice to put a fixed short retry time on domains for
26159 large ISPs, on the grounds that their servers are rarely down for very long.
26160 Unfortunately, these are exactly the domains that tend to resolve to long lists
26161 of hosts. The short retry time means that the lowest MX hosts are tried every
26162 time. The attempts may be in a different order because of random sorting, but
26163 without the special MX check, the higher MX hosts would never be tried until
26164 all the lower MX hosts had timed out (which might be several days), because
26165 there are always some lower MX hosts that have reached their retry times. With
26166 the special check, Exim considers at least one IP address from each MX value at
26167 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26168 reached.
26169
26170 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26171 particular, Exim normally eventually tries all the IP addresses before timing
26172 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26173 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26174 been set up with hundreds of IP addresses for some domains. It can
26175 take a very long time indeed for an address to time out in these cases.
26176
26177 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26178 Exim never tries more than this number of IP addresses; if it hits this limit
26179 and they are all timed out, the email address is bounced, even though not all
26180 possible IP addresses have been tried.
26181 .ecindex IIDsmttra1
26182 .ecindex IIDsmttra2
26183
26184
26185
26186
26187
26188 . ////////////////////////////////////////////////////////////////////////////
26189 . ////////////////////////////////////////////////////////////////////////////
26190
26191 .chapter "Address rewriting" "CHAPrewrite"
26192 .scindex IIDaddrew "rewriting" "addresses"
26193 There are some circumstances in which Exim automatically rewrites domains in
26194 addresses. The two most common are when an address is given without a domain
26195 (referred to as an &"unqualified address"&) or when an address contains an
26196 abbreviated domain that is expanded by DNS lookup.
26197
26198 Unqualified envelope addresses are accepted only for locally submitted
26199 messages, or for messages that are received from hosts matching
26200 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26201 appropriate. Unqualified addresses in header lines are qualified if they are in
26202 locally submitted messages, or messages from hosts that are permitted to send
26203 unqualified envelope addresses. Otherwise, unqualified addresses in header
26204 lines are neither qualified nor rewritten.
26205
26206 One situation in which Exim does &'not'& automatically rewrite a domain is
26207 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26208 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26209 do this. The new RFCs do not contain this suggestion.
26210
26211
26212 .section "Explicitly configured address rewriting" "SECID147"
26213 This chapter describes the rewriting rules that can be used in the
26214 main rewrite section of the configuration file, and also in the generic
26215 &%headers_rewrite%& option that can be set on any transport.
26216
26217 Some people believe that configured address rewriting is a Mortal Sin.
26218 Others believe that life is not possible without it. Exim provides the
26219 facility; you do not have to use it.
26220
26221 The main rewriting rules that appear in the &"rewrite"& section of the
26222 configuration file are applied to addresses in incoming messages, both envelope
26223 addresses and addresses in header lines. Each rule specifies the types of
26224 address to which it applies.
26225
26226 Whether or not addresses in header lines are rewritten depends on the origin of
26227 the headers and the type of rewriting. Global rewriting, that is, rewriting
26228 rules from the rewrite section of the configuration file, is applied only to
26229 those headers that were received with the message. Header lines that are added
26230 by ACLs or by a system filter or by individual routers or transports (which
26231 are specific to individual recipient addresses) are not rewritten by the global
26232 rules.
26233
26234 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26235 applies all headers except those added by routers and transports. That is, as
26236 well as the headers that were received with the message, it also applies to
26237 headers that were added by an ACL or a system filter.
26238
26239
26240 In general, rewriting addresses from your own system or domain has some
26241 legitimacy. Rewriting other addresses should be done only with great care and
26242 in special circumstances. The author of Exim believes that rewriting should be
26243 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26244 Although it can sometimes be used as a routing tool, this is very strongly
26245 discouraged.
26246
26247 There are two commonly encountered circumstances where rewriting is used, as
26248 illustrated by these examples:
26249
26250 .ilist
26251 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26252 exchange mail with each other behind a firewall, but there is only a single
26253 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26254 &'hitch.fict.example'& when sending mail off-site.
26255 .next
26256 A host rewrites the local parts of its own users so that, for example,
26257 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26258 .endlist
26259
26260
26261
26262 .section "When does rewriting happen?" "SECID148"
26263 .cindex "rewriting" "timing of"
26264 .cindex "&ACL;" "rewriting addresses in"
26265 Configured address rewriting can take place at several different stages of a
26266 message's processing.
26267
26268 .vindex "&$sender_address$&"
26269 At the start of an ACL for MAIL, the sender address may have been rewritten
26270 by a special SMTP-time rewrite rule (see section &<<SSECTrewriteS>>&), but no
26271 ordinary rewrite rules have yet been applied. If, however, the sender address
26272 is verified in the ACL, it is rewritten before verification, and remains
26273 rewritten thereafter. The subsequent value of &$sender_address$& is the
26274 rewritten address. This also applies if sender verification happens in a
26275 RCPT ACL. Otherwise, when the sender address is not verified, it is
26276 rewritten as soon as a message's header lines have been received.
26277
26278 .vindex "&$domain$&"
26279 .vindex "&$local_part$&"
26280 Similarly, at the start of an ACL for RCPT, the current recipient's address
26281 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26282 rewrite rules have yet been applied to it. However, the behaviour is different
26283 from the sender address when a recipient is verified. The address is rewritten
26284 for the verification, but the rewriting is not remembered at this stage. The
26285 value of &$local_part$& and &$domain$& after verification are always the same
26286 as they were before (that is, they contain the unrewritten &-- except for
26287 SMTP-time rewriting &-- address).
26288
26289 As soon as a message's header lines have been received, all the envelope
26290 recipient addresses are permanently rewritten, and rewriting is also applied to
26291 the addresses in the header lines (if configured). This happens before adding
26292 any header lines that were specified in MAIL or RCPT ACLs, and
26293 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26294 before the DATA ACL and &[local_scan()]& functions are run.
26295
26296 When an address is being routed, either for delivery or for verification,
26297 rewriting is applied immediately to child addresses that are generated by
26298 redirection, unless &%no_rewrite%& is set on the router.
26299
26300 .cindex "envelope from"
26301 .cindex "envelope sender" "rewriting at transport time"
26302 .cindex "rewriting" "at transport time"
26303 .cindex "header lines" "rewriting at transport time"
26304 At transport time, additional rewriting of addresses in header lines can be
26305 specified by setting the generic &%headers_rewrite%& option on a transport.
26306 This option contains rules that are identical in form to those in the rewrite
26307 section of the configuration file. They are applied to the original message
26308 header lines and any that were added by ACLs or a system filter. They are not
26309 applied to header lines that are added by routers or the transport.
26310
26311 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26312 transport option. However, it is not possible to rewrite envelope recipients at
26313 transport time.
26314
26315
26316
26317
26318 .section "Testing the rewriting rules that apply on input" "SECID149"
26319 .cindex "rewriting" "testing"
26320 .cindex "testing" "rewriting"
26321 Exim's input rewriting configuration appears in a part of the runtime
26322 configuration file headed by &"begin rewrite"&. It can be tested by the
26323 &%-brw%& command line option. This takes an address (which can be a full RFC
26324 2822 address) as its argument. The output is a list of how the address would be
26325 transformed by the rewriting rules for each of the different places it might
26326 appear in an incoming message, that is, for each different header and for the
26327 envelope sender and recipient fields. For example,
26328 .code
26329 exim -brw ph10@exim.workshop.example
26330 .endd
26331 might produce the output
26332 .code
26333 sender: Philip.Hazel@exim.workshop.example
26334 from: Philip.Hazel@exim.workshop.example
26335 to: ph10@exim.workshop.example
26336 cc: ph10@exim.workshop.example
26337 bcc: ph10@exim.workshop.example
26338 reply-to: Philip.Hazel@exim.workshop.example
26339 env-from: Philip.Hazel@exim.workshop.example
26340 env-to: ph10@exim.workshop.example
26341 .endd
26342 which shows that rewriting has been set up for that address when used in any of
26343 the source fields, but not when it appears as a recipient address. At the
26344 present time, there is no equivalent way of testing rewriting rules that are
26345 set for a particular transport.
26346
26347
26348 .section "Rewriting rules" "SECID150"
26349 .cindex "rewriting" "rules"
26350 The rewrite section of the configuration file consists of lines of rewriting
26351 rules in the form
26352 .display
26353 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26354 .endd
26355 Rewriting rules that are specified for the &%headers_rewrite%& generic
26356 transport option are given as a colon-separated list. Each item in the list
26357 takes the same form as a line in the main rewriting configuration (except that
26358 any colons must be doubled, of course).
26359
26360 The formats of source patterns and replacement strings are described below.
26361 Each is terminated by white space, unless enclosed in double quotes, in which
26362 case normal quoting conventions apply inside the quotes. The flags are single
26363 characters which may appear in any order. Spaces and tabs between them are
26364 ignored.
26365
26366 For each address that could potentially be rewritten, the rules are scanned in
26367 order, and replacements for the address from earlier rules can themselves be
26368 replaced by later rules (but see the &"q"& and &"R"& flags).
26369
26370 The order in which addresses are rewritten is undefined, may change between
26371 releases, and must not be relied on, with one exception: when a message is
26372 received, the envelope sender is always rewritten first, before any header
26373 lines are rewritten. For example, the replacement string for a rewrite of an
26374 address in &'To:'& must not assume that the message's address in &'From:'& has
26375 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26376 that the envelope sender has already been rewritten.
26377
26378 .vindex "&$domain$&"
26379 .vindex "&$local_part$&"
26380 The variables &$local_part$& and &$domain$& can be used in the replacement
26381 string to refer to the address that is being rewritten. Note that lookup-driven
26382 rewriting can be done by a rule of the form
26383 .code
26384 *@*   ${lookup ...
26385 .endd
26386 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26387 refer to the address that is being rewritten.
26388
26389
26390 .section "Rewriting patterns" "SECID151"
26391 .cindex "rewriting" "patterns"
26392 .cindex "address list" "in a rewriting pattern"
26393 The source pattern in a rewriting rule is any item which may appear in an
26394 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26395 single-item address list, which means that it is expanded before being tested
26396 against the address. As always, if you use a regular expression as a pattern,
26397 you must take care to escape dollar and backslash characters, or use the &`\N`&
26398 facility to suppress string expansion within the regular expression.
26399
26400 Domains in patterns should be given in lower case. Local parts in patterns are
26401 case-sensitive. If you want to do case-insensitive matching of local parts, you
26402 can use a regular expression that starts with &`^(?i)`&.
26403
26404 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26405 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26406 depending on the type of match which occurred. These can be used in the
26407 replacement string to insert portions of the incoming address. &$0$& always
26408 refers to the complete incoming address. When a regular expression is used, the
26409 numerical variables are set from its capturing subexpressions. For other types
26410 of pattern they are set as follows:
26411
26412 .ilist
26413 If a local part or domain starts with an asterisk, the numerical variables
26414 refer to the character strings matched by asterisks, with &$1$& associated with
26415 the first asterisk, and &$2$& with the second, if present. For example, if the
26416 pattern
26417 .code
26418 *queen@*.fict.example
26419 .endd
26420 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26421 .code
26422 $0 = hearts-queen@wonderland.fict.example
26423 $1 = hearts-
26424 $2 = wonderland
26425 .endd
26426 Note that if the local part does not start with an asterisk, but the domain
26427 does, it is &$1$& that contains the wild part of the domain.
26428
26429 .next
26430 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26431 of the domain are placed in the next available numerical variables. Suppose,
26432 for example, that the address &'foo@bar.baz.example'& is processed by a
26433 rewriting rule of the form
26434 .display
26435 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26436 .endd
26437 and the key in the file that matches the domain is &`*.baz.example`&. Then
26438 .code
26439 $1 = foo
26440 $2 = bar
26441 $3 = baz.example
26442 .endd
26443 If the address &'foo@baz.example'& is looked up, this matches the same
26444 wildcard file entry, and in this case &$2$& is set to the empty string, but
26445 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26446 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26447 whole domain. For non-partial domain lookups, no numerical variables are set.
26448 .endlist
26449
26450
26451 .section "Rewriting replacements" "SECID152"
26452 .cindex "rewriting" "replacements"
26453 If the replacement string for a rule is a single asterisk, addresses that
26454 match the pattern and the flags are &'not'& rewritten, and no subsequent
26455 rewriting rules are scanned. For example,
26456 .code
26457 hatta@lookingglass.fict.example  *  f
26458 .endd
26459 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26460 &'From:'& headers.
26461
26462 .vindex "&$domain$&"
26463 .vindex "&$local_part$&"
26464 If the replacement string is not a single asterisk, it is expanded, and must
26465 yield a fully qualified address. Within the expansion, the variables
26466 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26467 Any letters they contain retain their original case &-- they are not lower
26468 cased. The numerical variables are set up according to the type of pattern that
26469 matched the address, as described above. If the expansion is forced to fail by
26470 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26471 current rule is abandoned, but subsequent rules may take effect. Any other
26472 expansion failure causes the entire rewriting operation to be abandoned, and an
26473 entry written to the panic log.
26474
26475
26476
26477 .subsection "Rewriting flags" "SSECID153"
26478 There are three different kinds of flag that may appear on rewriting rules:
26479
26480 .ilist
26481 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26482 c, f, h, r, s, t.
26483 .next
26484 A flag that specifies rewriting at SMTP time: S.
26485 .next
26486 Flags that control the rewriting process: Q, q, R, w.
26487 .endlist
26488
26489 For rules that are part of the &%headers_rewrite%& generic transport option,
26490 E, F, T, and S are not permitted.
26491
26492
26493
26494 .subsection "Flags specifying which headers and envelope addresses to rewrite" &&&
26495          "SSECID154"
26496 .cindex rewriting flags
26497 If none of the following flag letters, nor the &"S"& flag (see section
26498 &<<SSECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26499 and to both the sender and recipient fields of the envelope, whereas a
26500 transport-time rewriting rule just applies to all headers. Otherwise, the
26501 rewriting rule is skipped unless the relevant addresses are being processed.
26502 .display
26503 &`E`&       rewrite all envelope fields
26504 &`F`&       rewrite the envelope From field
26505 &`T`&       rewrite the envelope To field
26506 &`b`&       rewrite the &'Bcc:'& header
26507 &`c`&       rewrite the &'Cc:'& header
26508 &`f`&       rewrite the &'From:'& header
26509 &`h`&       rewrite all headers
26510 &`r`&       rewrite the &'Reply-To:'& header
26511 &`s`&       rewrite the &'Sender:'& header
26512 &`t`&       rewrite the &'To:'& header
26513 .endd
26514 "All headers" means all of the headers listed above that can be selected
26515 individually, plus their &'Resent-'& versions. It does not include
26516 other headers such as &'Subject:'& etc.
26517
26518 You should be particularly careful about rewriting &'Sender:'& headers, and
26519 restrict this to special known cases in your own domains.
26520
26521
26522 .subsection "The SMTP-time rewriting flag" SSECTrewriteS
26523 .cindex SMTP "rewriting malformed addresses"
26524 .cindex RCPT "rewriting argument of"
26525 .cindex MAIL "rewriting argument of"
26526 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26527 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26528 before any other processing; even before syntax checking. The pattern is
26529 required to be a regular expression, and it is matched against the whole of the
26530 data for the command, including any surrounding angle brackets.
26531
26532 .vindex "&$domain$&"
26533 .vindex "&$local_part$&"
26534 This form of rewrite rule allows for the handling of addresses that are not
26535 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26536 input). Because the input is not required to be a syntactically valid address,
26537 the variables &$local_part$& and &$domain$& are not available during the
26538 expansion of the replacement string. The result of rewriting replaces the
26539 original address in the MAIL or RCPT command.
26540
26541
26542 .subsection "Flags controlling the rewriting process" SSECID155
26543 There are four flags which control the way the rewriting process works. These
26544 take effect only when a rule is invoked, that is, when the address is of the
26545 correct type (matches the flags) and matches the pattern:
26546
26547 .ilist
26548 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26549 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26550 absence of &"Q"& the rewritten address must always include a domain.
26551 .next
26552 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26553 even if no rewriting actually takes place because of a &"fail"& in the
26554 expansion. The &"q"& flag is not effective if the address is of the wrong type
26555 (does not match the flags) or does not match the pattern.
26556 .next
26557 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26558 address, up to ten times. It can be combined with the &"q"& flag, to stop
26559 rewriting once it fails to match (after at least one successful rewrite).
26560 .next
26561 .cindex "rewriting" "whole addresses"
26562 When an address in a header is rewritten, the rewriting normally applies only
26563 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26564 left unchanged. For example, rewriting might change
26565 .code
26566 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26567 .endd
26568 into
26569 .code
26570 From: Ford Prefect <prefectf@hitch.fict.example>
26571 .endd
26572 .cindex "RFC 2047"
26573 Sometimes there is a need to replace the whole address item, and this can be
26574 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26575 causes an address in a header line to be rewritten, the entire address is
26576 replaced, not just the working part. The replacement must be a complete RFC
26577 2822 address, including the angle brackets if necessary. If text outside angle
26578 brackets contains a character whose value is greater than 126 or less than 32
26579 (except for tab), the text is encoded according to RFC 2047. The character set
26580 is taken from &%headers_charset%&, which gets its default at build time.
26581
26582 When the &"w"& flag is set on a rule that causes an envelope address to be
26583 rewritten, all but the working part of the replacement address is discarded.
26584 .endlist
26585
26586
26587 .section "Rewriting examples" "SECID156"
26588 Here is an example of the two common rewriting paradigms:
26589 .code
26590 *@*.hitch.fict.example  $1@hitch.fict.example
26591 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26592                      {$value}fail}@hitch.fict.example bctfrF
26593 .endd
26594 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26595 the string expansion to fail if the lookup does not succeed. In this context it
26596 has the effect of leaving the original address unchanged, but Exim goes on to
26597 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26598 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26599 explicitly, which would cause the rewritten address to be the same as before,
26600 at the cost of a small bit of processing. Not supplying either of these is an
26601 error, since the rewritten address would then contain no local part.
26602
26603 The first example above replaces the domain with a superior, more general
26604 domain. This may not be desirable for certain local parts. If the rule
26605 .code
26606 root@*.hitch.fict.example  *
26607 .endd
26608 were inserted before the first rule, rewriting would be suppressed for the
26609 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26610
26611 Rewriting can be made conditional on a number of tests, by making use of
26612 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26613 messages that originate outside the local host:
26614 .code
26615 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26616                          {$1@hitch.fict.example}fail}"
26617 .endd
26618 The replacement string is quoted in this example because it contains white
26619 space.
26620
26621 .cindex "rewriting" "bang paths"
26622 .cindex "bang paths" "rewriting"
26623 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26624 an address it treats it as an unqualified local part which it qualifies with
26625 the local qualification domain (if the source of the message is local or if the
26626 remote host is permitted to send unqualified addresses). Rewriting can
26627 sometimes be used to handle simple bang paths with a fixed number of
26628 components. For example, the rule
26629 .code
26630 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26631 .endd
26632 rewrites a two-component bang path &'host.name!user'& as the domain address
26633 &'user@host.name'&. However, there is a security implication in using this as
26634 a global rewriting rule for envelope addresses. It can provide a backdoor
26635 method for using your system as a relay, because the incoming addresses appear
26636 to be local. If the bang path addresses are received via SMTP, it is safer to
26637 use the &"S"& flag to rewrite them as they are received, so that relay checking
26638 can be done on the rewritten addresses.
26639 .ecindex IIDaddrew
26640
26641
26642
26643
26644
26645 . ////////////////////////////////////////////////////////////////////////////
26646 . ////////////////////////////////////////////////////////////////////////////
26647
26648 .chapter "Retry configuration" "CHAPretry"
26649 .scindex IIDretconf1 "retry" "configuration, description of"
26650 .scindex IIDregconf2 "configuration file" "retry section"
26651 The &"retry"& section of the runtime configuration file contains a list of
26652 retry rules that control how often Exim tries to deliver messages that cannot
26653 be delivered at the first attempt. If there are no retry rules (the section is
26654 empty or not present), there are no retries. In this situation, temporary
26655 errors are treated as permanent. The default configuration contains a single,
26656 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26657 line option can be used to test which retry rule will be used for a given
26658 address, domain and error.
26659
26660 The most common cause of retries is temporary failure to deliver to a remote
26661 host because the host is down, or inaccessible because of a network problem.
26662 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26663 address) basis, not on a per-message basis. Thus, if one message has recently
26664 been delayed, delivery of a new message to the same host is not immediately
26665 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26666 log selector is set, the message
26667 .cindex "retry" "time not reached"
26668 &"retry time not reached"& is written to the main log whenever a delivery is
26669 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26670 the handling of errors during remote deliveries.
26671
26672 Retry processing applies to routing as well as to delivering, except as covered
26673 in the next paragraph. The retry rules do not distinguish between these
26674 actions. It is not possible, for example, to specify different behaviour for
26675 failures to route the domain &'snark.fict.example'& and failures to deliver to
26676 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26677 added complication, so did not implement it. However, although they share the
26678 same retry rule, the actual retry times for routing and transporting a given
26679 domain are maintained independently.
26680
26681 When a delivery is not part of a queue run (typically an immediate delivery on
26682 receipt of a message), the routers are always run, and local deliveries are
26683 always attempted, even if retry times are set for them. This makes for better
26684 behaviour if one particular message is causing problems (for example, causing
26685 quota overflow, or provoking an error in a filter file). If such a delivery
26686 suffers a temporary failure, the retry data is updated as normal, and
26687 subsequent delivery attempts from queue runs occur only when the retry time for
26688 the local address is reached.
26689
26690 .section "Changing retry rules" "SECID157"
26691 If you change the retry rules in your configuration, you should consider
26692 whether or not to delete the retry data that is stored in Exim's spool area in
26693 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26694 always safe; that is why they are called &"hints"&.
26695
26696 The hints retry data contains suggested retry times based on the previous
26697 rules. In the case of a long-running problem with a remote host, it might
26698 record the fact that the host has timed out. If your new rules increase the
26699 timeout time for such a host, you should definitely remove the old retry data
26700 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26701 messages that it should now be retaining.
26702
26703
26704
26705 .section "Format of retry rules" "SECID158"
26706 .cindex "retry" "rules"
26707 Each retry rule occupies one line and consists of three or four parts,
26708 separated by white space: a pattern, an error name, an optional list of sender
26709 addresses, and a list of retry parameters. The pattern and sender lists must be
26710 enclosed in double quotes if they contain white space. The rules are searched
26711 in order until one is found where the pattern, error name, and sender list (if
26712 present) match the failing host or address, the error that occurred, and the
26713 message's sender, respectively.
26714
26715
26716 The pattern is any single item that may appear in an address list (see section
26717 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26718 which means that it is expanded before being tested against the address that
26719 has been delayed. A negated address list item is permitted. Address
26720 list processing treats a plain domain name as if it were preceded by &"*@"&,
26721 which makes it possible for many retry rules to start with just a domain. For
26722 example,
26723 .code
26724 lookingglass.fict.example        *  F,24h,30m;
26725 .endd
26726 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26727 whereas
26728 .code
26729 alice@lookingglass.fict.example  *  F,24h,30m;
26730 .endd
26731 applies only to temporary failures involving the local part &%alice%&.
26732 In practice, almost all rules start with a domain name pattern without a local
26733 part.
26734
26735 .cindex "regular expressions" "in retry rules"
26736 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26737 must match a complete address, not just a domain, because that is how regular
26738 expressions work in address lists.
26739 .display
26740 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26741 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26742 .endd
26743
26744
26745 .section "Choosing which retry rule to use for address errors" "SECID159"
26746 When Exim is looking for a retry rule after a routing attempt has failed (for
26747 example, after a DNS timeout), each line in the retry configuration is tested
26748 against the complete address only if &%retry_use_local_part%& is set for the
26749 router. Otherwise, only the domain is used, except when matching against a
26750 regular expression, when the local part of the address is replaced with &"*"&.
26751 A domain on its own can match a domain pattern, or a pattern that starts with
26752 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26753 &%check_local_user%& is true, and false for other routers.
26754
26755 Similarly, when Exim is looking for a retry rule after a local delivery has
26756 failed (for example, after a mailbox full error), each line in the retry
26757 configuration is tested against the complete address only if
26758 &%retry_use_local_part%& is set for the transport (it defaults true for all
26759 local transports).
26760
26761 .cindex "4&'xx'& responses" "retry rules for"
26762 However, when Exim is looking for a retry rule after a remote delivery attempt
26763 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26764 whole address is always used as the key when searching the retry rules. The
26765 rule that is found is used to create a retry time for the combination of the
26766 failing address and the message's sender. It is the combination of sender and
26767 recipient that is delayed in subsequent queue runs until its retry time is
26768 reached. You can delay the recipient without regard to the sender by setting
26769 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26770 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26771 commands.
26772
26773
26774
26775 .section "Choosing which retry rule to use for host and message errors" &&&
26776          "SECID160"
26777 For a temporary error that is not related to an individual address (for
26778 example, a connection timeout), each line in the retry configuration is checked
26779 twice. First, the name of the remote host is used as a domain name (preceded by
26780 &"*@"& when matching a regular expression). If this does not match the line,
26781 the domain from the email address is tried in a similar fashion. For example,
26782 suppose the MX records for &'a.b.c.example'& are
26783 .code
26784 a.b.c.example  MX  5  x.y.z.example
26785                MX  6  p.q.r.example
26786                MX  7  m.n.o.example
26787 .endd
26788 and the retry rules are
26789 .code
26790 p.q.r.example    *      F,24h,30m;
26791 a.b.c.example    *      F,4d,45m;
26792 .endd
26793 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26794 first rule matches neither the host nor the domain, so Exim looks at the second
26795 rule. This does not match the host, but it does match the domain, so it is used
26796 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26797 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26798 first retry rule is used, because it matches the host.
26799
26800 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26801 first rule to determine retry times, but for all the other hosts for the domain
26802 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26803 routing to &'a.b.c.example'& suffers a temporary failure.
26804
26805 &*Note*&: The host name is used when matching the patterns, not its IP address.
26806 However, if a message is routed directly to an IP address without the use of a
26807 host name, for example, if a &(manualroute)& router contains a setting such as:
26808 .code
26809 route_list = *.a.example  192.168.34.23
26810 .endd
26811 then the &"host name"& that is used when searching for a retry rule is the
26812 textual form of the IP address.
26813
26814 .section "Retry rules for specific errors" "SECID161"
26815 .cindex "retry" "specific errors; specifying"
26816 The second field in a retry rule is the name of a particular error, or an
26817 asterisk, which matches any error. The errors that can be tested for are:
26818
26819 .vlist
26820 .vitem &%auth_failed%&
26821 Authentication failed when trying to send to a host in the
26822 &%hosts_require_auth%& list in an &(smtp)& transport.
26823
26824 .vitem &%data_4xx%&
26825 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26826 after the command, or after sending the message's data.
26827
26828 .vitem &%mail_4xx%&
26829 A 4&'xx'& error was received for an outgoing MAIL command.
26830
26831 .vitem &%rcpt_4xx%&
26832 A 4&'xx'& error was received for an outgoing RCPT command.
26833 .endlist
26834
26835 For the three 4&'xx'& errors, either the first or both of the x's can be given
26836 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26837 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26838 and have retries every ten minutes with a one-hour timeout, you could set up a
26839 retry rule of this form:
26840 .code
26841 the.domain.name  rcpt_452   F,1h,10m
26842 .endd
26843 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26844 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26845
26846 .vlist
26847 .vitem &%lost_connection%&
26848 A server unexpectedly closed the SMTP connection. There may, of course,
26849 legitimate reasons for this (host died, network died), but if it repeats a lot
26850 for the same host, it indicates something odd.
26851
26852 .vitem &%lookup%&
26853 A DNS lookup for a host failed.
26854 Note that a &%dnslookup%& router will need to have matched
26855 its &%fail_defer_domains%& option for this retry type to be usable.
26856 Also note that a &%manualroute%& router will probably need
26857 its &%host_find_failed%& option set to &%defer%&.
26858
26859 .vitem &%refused_MX%&
26860 A connection to a host obtained from an MX record was refused.
26861
26862 .vitem &%refused_A%&
26863 A connection to a host not obtained from an MX record was refused.
26864
26865 .vitem &%refused%&
26866 A connection was refused.
26867
26868 .vitem &%timeout_connect_MX%&
26869 A connection attempt to a host obtained from an MX record timed out.
26870
26871 .vitem &%timeout_connect_A%&
26872 A connection attempt to a host not obtained from an MX record timed out.
26873
26874 .vitem &%timeout_connect%&
26875 A connection attempt timed out.
26876
26877 .vitem &%timeout_MX%&
26878 There was a timeout while connecting or during an SMTP session with a host
26879 obtained from an MX record.
26880
26881 .vitem &%timeout_A%&
26882 There was a timeout while connecting or during an SMTP session with a host not
26883 obtained from an MX record.
26884
26885 .vitem &%timeout%&
26886 There was a timeout while connecting or during an SMTP session.
26887
26888 .vitem &%tls_required%&
26889 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26890 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26891 to STARTTLS, or there was a problem setting up the TLS connection.
26892
26893 .vitem &%quota%&
26894 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26895 transport.
26896
26897 .vitem &%quota_%&<&'time'&>
26898 .cindex "quota" "error testing in retry rule"
26899 .cindex "retry" "quota error testing"
26900 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26901 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26902 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26903 for four days.
26904 .endlist
26905
26906 .cindex "mailbox" "time of last read"
26907 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26908 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26909 it should be based on the last time that the user accessed the mailbox.
26910 However, it is not always possible to determine this. Exim uses the following
26911 heuristic rules:
26912
26913 .ilist
26914 If the mailbox is a single file, the time of last access (the &"atime"&) is
26915 used. As no new messages are being delivered (because the mailbox is over
26916 quota), Exim does not access the file, so this is the time of last user access.
26917 .next
26918 .cindex "maildir format" "time of last read"
26919 For a maildir delivery, the time of last modification of the &_new_&
26920 subdirectory is used. As the mailbox is over quota, no new files are created in
26921 the &_new_& subdirectory, because no new messages are being delivered. Any
26922 change to the &_new_& subdirectory is therefore assumed to be the result of an
26923 MUA moving a new message to the &_cur_& directory when it is first read. The
26924 time that is used is therefore the last time that the user read a new message.
26925 .next
26926 For other kinds of multi-file mailbox, the time of last access cannot be
26927 obtained, so a retry rule that uses this type of error field is never matched.
26928 .endlist
26929
26930 The quota errors apply both to system-enforced quotas and to Exim's own quota
26931 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26932 when a local delivery is deferred because a partition is full (the ENOSPC
26933 error).
26934
26935
26936
26937 .section "Retry rules for specified senders" "SECID162"
26938 .cindex "retry" "rules; sender-specific"
26939 You can specify retry rules that apply only when the failing message has a
26940 specific sender. In particular, this can be used to define retry rules that
26941 apply only to bounce messages. The third item in a retry rule can be of this
26942 form:
26943 .display
26944 &`senders=`&<&'address list'&>
26945 .endd
26946 The retry timings themselves are then the fourth item. For example:
26947 .code
26948 *   rcpt_4xx   senders=:   F,1h,30m
26949 .endd
26950 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26951 host. If the address list contains white space, it must be enclosed in quotes.
26952 For example:
26953 .code
26954 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26955 .endd
26956 &*Warning*&: This facility can be unhelpful if it is used for host errors
26957 (which do not depend on the recipient). The reason is that the sender is used
26958 only to match the retry rule. Once the rule has been found for a host error,
26959 its contents are used to set a retry time for the host, and this will apply to
26960 all messages, not just those with specific senders.
26961
26962 When testing retry rules using &%-brt%&, you can supply a sender using the
26963 &%-f%& command line option, like this:
26964 .code
26965 exim -f "" -brt user@dom.ain
26966 .endd
26967 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26968 list is never matched.
26969
26970
26971
26972
26973
26974 .section "Retry parameters" "SECID163"
26975 .cindex "retry" "parameters in rules"
26976 The third (or fourth, if a senders list is present) field in a retry rule is a
26977 sequence of retry parameter sets, separated by semicolons. Each set consists of
26978 .display
26979 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26980 .endd
26981 The letter identifies the algorithm for computing a new retry time; the cutoff
26982 time is the time beyond which this algorithm no longer applies, and the
26983 arguments vary the algorithm's action. The cutoff time is measured from the
26984 time that the first failure for the domain (combined with the local part if
26985 relevant) was detected, not from the time the message was received.
26986
26987 .cindex "retry" "algorithms"
26988 .cindex "retry" "fixed intervals"
26989 .cindex "retry" "increasing intervals"
26990 .cindex "retry" "random intervals"
26991 The available algorithms are:
26992
26993 .ilist
26994 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26995 the interval.
26996 .next
26997 &'G'&: retry at geometrically increasing intervals. The first argument
26998 specifies a starting value for the interval, and the second a multiplier, which
26999 is used to increase the size of the interval at each retry.
27000 .next
27001 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
27002 retry, the previous interval is multiplied by the factor in order to get a
27003 maximum for the next interval. The minimum interval is the first argument of
27004 the parameter, and an actual interval is chosen randomly between them. Such a
27005 rule has been found to be helpful in cluster configurations when all the
27006 members of the cluster restart at once, and may therefore synchronize their
27007 queue processing times.
27008 .endlist
27009
27010 When computing the next retry time, the algorithm definitions are scanned in
27011 order until one whose cutoff time has not yet passed is reached. This is then
27012 used to compute a new retry time that is later than the current time. In the
27013 case of fixed interval retries, this simply means adding the interval to the
27014 current time. For geometrically increasing intervals, retry intervals are
27015 computed from the rule's parameters until one that is greater than the previous
27016 interval is found. The main configuration variable
27017 .cindex "limit" "retry interval"
27018 .cindex "retry" "interval, maximum"
27019 .oindex "&%retry_interval_max%&"
27020 &%retry_interval_max%& limits the maximum interval between retries. It
27021 cannot be set greater than &`24h`&, which is its default value.
27022
27023 A single remote domain may have a number of hosts associated with it, and each
27024 host may have more than one IP address. Retry algorithms are selected on the
27025 basis of the domain name, but are applied to each IP address independently. If,
27026 for example, a host has two IP addresses and one is unusable, Exim will
27027 generate retry times for it and will not try to use it until its next retry
27028 time comes. Thus the good IP address is likely to be tried first most of the
27029 time.
27030
27031 .cindex "hints database" "use for retrying"
27032 Retry times are hints rather than promises. Exim does not make any attempt to
27033 run deliveries exactly at the computed times. Instead, a queue runner process
27034 starts delivery processes for delayed messages periodically, and these attempt
27035 new deliveries only for those addresses that have passed their next retry time.
27036 If a new message arrives for a deferred address, an immediate delivery attempt
27037 occurs only if the address has passed its retry time. In the absence of new
27038 messages, the minimum time between retries is the interval between queue runner
27039 processes. There is not much point in setting retry times of five minutes if
27040 your queue runners happen only once an hour, unless there are a significant
27041 number of incoming messages (which might be the case on a system that is
27042 sending everything to a smart host, for example).
27043
27044 The data in the retry hints database can be inspected by using the
27045 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
27046 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
27047 &'exinext'& utility script can be used to find out what the next retry times
27048 are for the hosts associated with a particular mail domain, and also for local
27049 deliveries that have been deferred.
27050
27051
27052 .section "Retry rule examples" "SECID164"
27053 Here are some example retry rules:
27054 .code
27055 alice@wonderland.fict.example quota_5d  F,7d,3h
27056 wonderland.fict.example       quota_5d
27057 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
27058 lookingglass.fict.example     *         F,24h,30m;
27059 *                 refused_A   F,2h,20m;
27060 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
27061 .endd
27062 The first rule sets up special handling for mail to
27063 &'alice@wonderland.fict.example'& when there is an over-quota error and the
27064 mailbox has not been read for at least 5 days. Retries continue every three
27065 hours for 7 days. The second rule handles over-quota errors for all other local
27066 parts at &'wonderland.fict.example'&; the absence of a local part has the same
27067 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
27068 fail are bounced immediately if the mailbox has not been read for at least 5
27069 days.
27070
27071 The third rule handles all other errors at &'wonderland.fict.example'&; retries
27072 happen every 15 minutes for an hour, then with geometrically increasing
27073 intervals until two days have passed since a delivery first failed. After the
27074 first hour there is a delay of one hour, then two hours, then four hours, and
27075 so on (this is a rather extreme example).
27076
27077 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
27078 They happen every 30 minutes for 24 hours only. The remaining two rules handle
27079 all other domains, with special action for connection refusal from hosts that
27080 were not obtained from an MX record.
27081
27082 The final rule in a retry configuration should always have asterisks in the
27083 first two fields so as to provide a general catch-all for any addresses that do
27084 not have their own special handling. This example tries every 15 minutes for 2
27085 hours, then with intervals starting at one hour and increasing by a factor of
27086 1.5 up to 16 hours, then every 8 hours up to 5 days.
27087
27088
27089
27090 .section "Timeout of retry data" "SECID165"
27091 .cindex "timeout" "of retry data"
27092 .oindex "&%retry_data_expire%&"
27093 .cindex "hints database" "data expiry"
27094 .cindex "retry" "timeout of data"
27095 Exim timestamps the data that it writes to its retry hints database. When it
27096 consults the data during a delivery it ignores any that is older than the value
27097 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
27098 been tried for 7 days, Exim will try to deliver to it immediately a message
27099 arrives, and if that fails, it will calculate a retry time as if it were
27100 failing for the first time.
27101
27102 This improves the behaviour for messages routed to rarely-used hosts such as MX
27103 backups. If such a host was down at one time, and happens to be down again when
27104 Exim tries a month later, using the old retry data would imply that it had been
27105 down all the time, which is not a justified assumption.
27106
27107 If a host really is permanently dead, this behaviour causes a burst of retries
27108 every now and again, but only if messages routed to it are rare. If there is a
27109 message at least once every 7 days the retry data never expires.
27110
27111
27112
27113
27114 .section "Long-term failures" "SECID166"
27115 .cindex "delivery failure, long-term"
27116 .cindex "retry" "after long-term failure"
27117 Special processing happens when an email address has been failing for so long
27118 that the cutoff time for the last algorithm is reached. For example, using the
27119 default retry rule:
27120 .code
27121 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
27122 .endd
27123 the cutoff time is four days. Reaching the retry cutoff is independent of how
27124 long any specific message has been failing; it is the length of continuous
27125 failure for the recipient address that counts.
27126
27127 When the cutoff time is reached for a local delivery, or for all the IP
27128 addresses associated with a remote delivery, a subsequent delivery failure
27129 causes Exim to give up on the address, and a bounce message is generated.
27130 In order to cater for new messages that use the failing address, a next retry
27131 time is still computed from the final algorithm, and is used as follows:
27132
27133 For local deliveries, one delivery attempt is always made for any subsequent
27134 messages. If this delivery fails, the address fails immediately. The
27135 post-cutoff retry time is not used.
27136
27137 .cindex "final cutoff" "retries, controlling"
27138 .cindex retry "final cutoff"
27139 If the delivery is remote, there are two possibilities, controlled by the
27140 .oindex "&%delay_after_cutoff%&"
27141 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27142 default. Until the post-cutoff retry time for one of the IP addresses,
27143 as set by the &%retry_data_expire%& option, is
27144 reached, the failing email address is bounced immediately, without a delivery
27145 attempt taking place. After that time, one new delivery attempt is made to
27146 those IP addresses that are past their retry times, and if that still fails,
27147 the address is bounced and new retry times are computed.
27148
27149 In other words, when all the hosts for a given email address have been failing
27150 for a long time, Exim bounces rather then defers until one of the hosts' retry
27151 times is reached. Then it tries once, and bounces if that attempt fails. This
27152 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27153 to a broken destination, but if the host does recover, Exim will eventually
27154 notice.
27155
27156 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27157 addresses are past their final cutoff time, Exim tries to deliver to those IP
27158 addresses that have not been tried since the message arrived. If there are
27159 no suitable IP addresses, or if they all fail, the address is bounced. In other
27160 words, it does not delay when a new message arrives, but tries the expired
27161 addresses immediately, unless they have been tried since the message arrived.
27162 If there is a continuous stream of messages for the failing domains, setting
27163 &%delay_after_cutoff%& false means that there will be many more attempts to
27164 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27165 true.
27166
27167 .section "Deliveries that work intermittently" "SECID167"
27168 .cindex "retry" "intermittently working deliveries"
27169 Some additional logic is needed to cope with cases where a host is
27170 intermittently available, or when a message has some attribute that prevents
27171 its delivery when others to the same address get through. In this situation,
27172 because some messages are successfully delivered, the &"retry clock"& for the
27173 host or address keeps getting reset by the successful deliveries, and so
27174 failing messages remain in the queue for ever because the cutoff time is never
27175 reached.
27176
27177 Two exceptional actions are applied to prevent this happening. The first
27178 applies to errors that are related to a message rather than a remote host.
27179 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27180 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27181 commands, and quota failures. For this type of error, if a message's arrival
27182 time is earlier than the &"first failed"& time for the error, the earlier time
27183 is used when scanning the retry rules to decide when to try next and when to
27184 time out the address.
27185
27186 The exceptional second action applies in all cases. If a message has been on
27187 the queue for longer than the cutoff time of any applicable retry rule for a
27188 given address, a delivery is attempted for that address, even if it is not yet
27189 time, and if this delivery fails, the address is timed out. A new retry time is
27190 not computed in this case, so that other messages for the same address are
27191 considered immediately.
27192 .ecindex IIDretconf1
27193 .ecindex IIDregconf2
27194
27195
27196
27197
27198
27199
27200 . ////////////////////////////////////////////////////////////////////////////
27201 . ////////////////////////////////////////////////////////////////////////////
27202
27203 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27204 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27205 .scindex IIDauthconf2 "authentication"
27206 The &"authenticators"& section of Exim's runtime configuration is concerned
27207 with SMTP authentication. This facility is an extension to the SMTP protocol,
27208 described in RFC 2554, which allows a client SMTP host to authenticate itself
27209 to a server. This is a common way for a server to recognize clients that are
27210 permitted to use it as a relay. SMTP authentication is not of relevance to the
27211 transfer of mail between servers that have no managerial connection with each
27212 other.
27213
27214 The name of an authenticator is limited to be &drivernamemax; ASCII characters long;
27215 prior to Exim 4.95 names would be silently truncated at this length, but now
27216 it is enforced.
27217
27218 .cindex "AUTH" "description of"
27219 .cindex "ESMTP extensions" AUTH
27220 Very briefly, the way SMTP authentication works is as follows:
27221
27222 .olist
27223 The server advertises a number of authentication &'mechanisms'& in response to
27224 the client's EHLO command.
27225 .next
27226 The client issues an AUTH command, naming a specific mechanism. The command
27227 may, optionally, contain some authentication data.
27228 .next
27229 The server may issue one or more &'challenges'&, to which the client must send
27230 appropriate responses. In simple authentication mechanisms, the challenges are
27231 just prompts for user names and passwords. The server does not have to issue
27232 any challenges &-- in some mechanisms the relevant data may all be transmitted
27233 with the AUTH command.
27234 .next
27235 The server either accepts or denies authentication.
27236 .next
27237 If authentication succeeds, the client may optionally make use of the AUTH
27238 option on the MAIL command to pass an authenticated sender in subsequent
27239 mail transactions. Authentication lasts for the remainder of the SMTP
27240 connection.
27241 .next
27242 If authentication fails, the client may give up, or it may try a different
27243 authentication mechanism, or it may try transferring mail over the
27244 unauthenticated connection.
27245 .endlist
27246
27247 If you are setting up a client, and want to know which authentication
27248 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27249 SMTP port) on the server, and issue an EHLO command. The response to this
27250 includes the list of supported mechanisms. For example:
27251 .display
27252 &`$ `&&*&`telnet server.example 25`&*&
27253 &`Trying 192.168.34.25...`&
27254 &`Connected to server.example.`&
27255 &`Escape character is &#x0027;^]&#x0027;.`&
27256 &`220 server.example ESMTP Exim 4.20 ...`&
27257 &*&`ehlo client.example`&*&
27258 &`250-server.example Hello client.example [10.8.4.5]`&
27259 &`250-SIZE 52428800`&
27260 &`250-PIPELINING`&
27261 &`250-AUTH PLAIN`&
27262 &`250 HELP`&
27263 .endd
27264 The second-last line of this example output shows that the server supports
27265 authentication using the PLAIN mechanism. In Exim, the different authentication
27266 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27267 routers and transports, which authenticators are included in the binary is
27268 controlled by build-time definitions. The following are currently available,
27269 included by setting
27270 .code
27271 AUTH_CRAM_MD5=yes
27272 AUTH_CYRUS_SASL=yes
27273 AUTH_DOVECOT=yes
27274 AUTH_EXTERNAL=yes
27275 AUTH_GSASL=yes
27276 AUTH_HEIMDAL_GSSAPI=yes
27277 AUTH_PLAINTEXT=yes
27278 AUTH_SPA=yes
27279 AUTH_TLS=yes
27280 .endd
27281 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27282 authentication mechanism (RFC 2195), and the second provides an interface to
27283 the Cyrus SASL authentication library.
27284 The third is an interface to Dovecot's authentication system, delegating the
27285 work via a socket interface.
27286 The fourth provides for negotiation of authentication done via non-SMTP means,
27287 as defined by RFC 4422 Appendix A.
27288 The fifth provides an interface to the GNU SASL authentication library, which
27289 provides mechanisms but typically not data sources.
27290 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27291 supporting setting a server keytab.
27292 The seventh can be configured to support
27293 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27294 not formally documented, but used by several MUAs.
27295 The eighth authenticator
27296 supports Microsoft's &'Secure Password Authentication'& mechanism.
27297 The last is an Exim authenticator but not an SMTP one;
27298 instead it can use information from a TLS negotiation.
27299
27300 The authenticators are configured using the same syntax as other drivers (see
27301 section &<<SECTfordricon>>&). If no authenticators are required, no
27302 authentication section need be present in the configuration file. Each
27303 authenticator can in principle have both server and client functions. When Exim
27304 is receiving SMTP mail, it is acting as a server; when it is sending out
27305 messages over SMTP, it is acting as a client. Authenticator configuration
27306 options are provided for use in both these circumstances.
27307
27308 To make it clear which options apply to which situation, the prefixes
27309 &%server_%& and &%client_%& are used on option names that are specific to
27310 either the server or the client function, respectively. Server and client
27311 functions are disabled if none of their options are set. If an authenticator is
27312 to be used for both server and client functions, a single definition, using
27313 both sets of options, is required. For example:
27314 .code
27315 cram:
27316   driver = cram_md5
27317   public_name = CRAM-MD5
27318   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27319   client_name = ph10
27320   client_secret = secret2
27321 .endd
27322 The &%server_%& option is used when Exim is acting as a server, and the
27323 &%client_%& options when it is acting as a client.
27324
27325 Descriptions of the individual authenticators are given in subsequent chapters.
27326 The remainder of this chapter covers the generic options for the
27327 authenticators, followed by general discussion of the way authentication works
27328 in Exim.
27329
27330 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27331 per-mechanism basis.  Please read carefully to determine which variables hold
27332 account labels such as usercodes and which hold passwords or other
27333 authenticating data.
27334
27335 Note that some mechanisms support two different identifiers for accounts: the
27336 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27337 and &'authz'& are commonly encountered.  The American spelling is standard here.
27338 Conceptually, authentication data such as passwords are tied to the identifier
27339 used to authenticate; servers may have rules to permit one user to act as a
27340 second user, so that after login the session is treated as though that second
27341 user had logged in.  That second user is the &'authorization id'&.  A robust
27342 configuration might confirm that the &'authz'& field is empty or matches the
27343 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27344 as verified data, the &'authz'& as an unverified request which the server might
27345 choose to honour.
27346
27347 A &'realm'& is a text string, typically a domain name, presented by a server
27348 to a client to help it select an account and credentials to use.  In some
27349 mechanisms, the client and server provably agree on the realm, but clients
27350 typically can not treat the realm as secure data to be blindly trusted.
27351
27352
27353
27354 .section "Generic options for authenticators" "SECID168"
27355 .cindex "authentication" "generic options"
27356 .cindex "options" "generic; for authenticators"
27357
27358 .option client_condition authenticators string&!! unset
27359 When Exim is authenticating as a client, it skips any authenticator whose
27360 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27361 used, for example, to skip plain text authenticators when the connection is not
27362 encrypted by a setting such as:
27363 .code
27364 client_condition = ${if !eq{$tls_out_cipher}{}}
27365 .endd
27366
27367
27368 .option client_set_id authenticators string&!! unset
27369 When client authentication succeeds, this condition is expanded; the
27370 result is used in the log lines for outbound messages.
27371 Typically it will be the user name used for authentication.
27372
27373
27374 .option driver authenticators string unset
27375 This option must always be set. It specifies which of the available
27376 authenticators is to be used.
27377
27378
27379 .option public_name authenticators string unset
27380 This option specifies the name of the authentication mechanism that the driver
27381 implements, and by which it is known to the outside world. These names should
27382 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27383 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27384 defaults to the driver's instance name.
27385
27386
27387 .option server_advertise_condition authenticators string&!! unset
27388 When a server is about to advertise an authentication mechanism, the condition
27389 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27390 mechanism is not advertised.
27391 If the expansion fails, the mechanism is not advertised. If the failure was not
27392 forced, and was not caused by a lookup defer, the incident is logged.
27393 See section &<<SECTauthexiser>>& below for further discussion.
27394
27395
27396 .option server_condition authenticators string&!! unset
27397 This option must be set for a &%plaintext%& server authenticator, where it
27398 is used directly to control authentication. See section &<<SECTplainserver>>&
27399 for details.
27400
27401 For the &(gsasl)& authenticator, this option is required for various
27402 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27403
27404 For the other authenticators, &%server_condition%& can be used as an additional
27405 authentication or authorization mechanism that is applied after the other
27406 authenticator conditions succeed. If it is set, it is expanded when the
27407 authenticator would otherwise return a success code. If the expansion is forced
27408 to fail, authentication fails. Any other expansion failure causes a temporary
27409 error code to be returned. If the result of a successful expansion is an empty
27410 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27411 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27412 other result, a temporary error code is returned, with the expanded string as
27413 the error text.
27414
27415
27416 .option server_debug_print authenticators string&!! unset
27417 If this option is set and authentication debugging is enabled (see the &%-d%&
27418 command line option), the string is expanded and included in the debugging
27419 output when the authenticator is run as a server. This can help with checking
27420 out the values of variables.
27421 If expansion of the string fails, the error message is written to the debugging
27422 output, and Exim carries on processing.
27423
27424
27425 .option server_set_id authenticators string&!! unset
27426 .vindex "&$authenticated_id$&"
27427 .vindex "&$authenticated_fail_id$&"
27428 When an Exim server successfully authenticates a client, this string is
27429 expanded using data from the authentication, and preserved for any incoming
27430 messages in the variable &$authenticated_id$&. It is also included in the log
27431 lines for incoming messages. For example, a user/password authenticator
27432 configuration might preserve the user name that was used to authenticate, and
27433 refer to it subsequently during delivery of the message.
27434 On a failing authentication the expansion result is instead saved in
27435 the &$authenticated_fail_id$& variable.
27436 If expansion fails, the option is ignored.
27437
27438
27439 .option server_mail_auth_condition authenticators string&!! unset
27440 This option allows a server to discard authenticated sender addresses supplied
27441 as part of MAIL commands in SMTP connections that are authenticated by the
27442 driver on which &%server_mail_auth_condition%& is set. The option is not used
27443 as part of the authentication process; instead its (unexpanded) value is
27444 remembered for later use.
27445 How it is used is described in the following section.
27446
27447
27448
27449
27450
27451 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27452 .cindex "authentication" "sender; authenticated"
27453 .cindex "AUTH" "on MAIL command"
27454 When a client supplied an AUTH= item on a MAIL command, Exim applies
27455 the following checks before accepting it as the authenticated sender of the
27456 message:
27457
27458 .ilist
27459 If the connection is not using extended SMTP (that is, HELO was used rather
27460 than EHLO), the use of AUTH= is a syntax error.
27461 .next
27462 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27463 .next
27464 .vindex "&$authenticated_sender$&"
27465 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27466 running, the value of &$authenticated_sender$& is set to the value obtained
27467 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27468 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27469 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27470 given for the MAIL command.
27471 .next
27472 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27473 is accepted and placed in &$authenticated_sender$& only if the client has
27474 authenticated.
27475 .next
27476 If the AUTH= value was accepted by either of the two previous rules, and
27477 the client has authenticated, and the authenticator has a setting for the
27478 &%server_mail_auth_condition%&, the condition is checked at this point. The
27479 valued that was saved from the authenticator is expanded. If the expansion
27480 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27481 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27482 the value of &$authenticated_sender$& is retained and passed on with the
27483 message.
27484 .endlist
27485
27486
27487 When &$authenticated_sender$& is set for a message, it is passed on to other
27488 hosts to which Exim authenticates as a client. Do not confuse this value with
27489 &$authenticated_id$&, which is a string obtained from the authentication
27490 process, and which is not usually a complete email address.
27491
27492 .vindex "&$sender_address$&"
27493 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27494 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27495 therefore make use of &$authenticated_sender$&. The converse is not true: the
27496 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27497 ACL is run.
27498
27499
27500
27501 .section "Authentication on an Exim server" "SECTauthexiser"
27502 .cindex "authentication" "on an Exim server"
27503 When Exim receives an EHLO command, it advertises the public names of those
27504 authenticators that are configured as servers, subject to the following
27505 conditions:
27506
27507 .ilist
27508 The client host must match &%auth_advertise_hosts%& (default *).
27509 .next
27510 If the &%server_advertise_condition%& option is set, its expansion must not
27511 yield the empty string, &"0"&, &"no"&, or &"false"&.
27512 .endlist
27513
27514 The order in which the authenticators are defined controls the order in which
27515 the mechanisms are advertised.
27516
27517 Some mail clients (for example, some versions of Netscape) require the user to
27518 provide a name and password for authentication whenever AUTH is advertised,
27519 even though authentication may not in fact be needed (for example, Exim may be
27520 set up to allow unconditional relaying from the client by an IP address check).
27521 You can make such clients more friendly by not advertising AUTH to them.
27522 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27523 that runs for RCPT) to relay without authentication, you should set
27524 .code
27525 auth_advertise_hosts = ! 10.9.8.0/24
27526 .endd
27527 so that no authentication mechanisms are advertised to them.
27528
27529 The &%server_advertise_condition%& controls the advertisement of individual
27530 authentication mechanisms. For example, it can be used to restrict the
27531 advertisement of a particular mechanism to encrypted connections, by a setting
27532 such as:
27533 .code
27534 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27535 .endd
27536 .vindex "&$tls_in_cipher$&"
27537 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27538 yields &"yes"&, which allows the advertisement to happen.
27539
27540 When an Exim server receives an AUTH command from a client, it rejects it
27541 immediately if AUTH was not advertised in response to an earlier EHLO
27542 command. This is the case if
27543
27544 .ilist
27545 The client host does not match &%auth_advertise_hosts%&; or
27546 .next
27547 No authenticators are configured with server options; or
27548 .next
27549 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27550 server authenticators.
27551 .endlist
27552
27553
27554 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27555 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27556 AUTH is accepted from any client host.
27557
27558 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27559 server authentication mechanism that was advertised in response to EHLO and
27560 that matches the one named in the AUTH command. If it finds one, it runs
27561 the appropriate authentication protocol, and authentication either succeeds or
27562 fails. If there is no matching advertised mechanism, the AUTH command is
27563 rejected with a 504 error.
27564
27565 .vindex "&$received_protocol$&"
27566 .vindex "&$sender_host_authenticated$&"
27567 When a message is received from an authenticated host, the value of
27568 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27569 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27570 public name) of the authenticator driver that successfully authenticated the
27571 client from which the message was received. This variable is empty if there was
27572 no successful authentication.
27573
27574 .cindex authentication "expansion item"
27575 Successful authentication sets up information used by the
27576 &%authresults%& expansion item.
27577
27578 .new
27579 .cindex authentication "failure event, server"
27580 If an authenticator is run and does not succeed,
27581 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27582 While the event is being processed the variables
27583 &$sender_host_authenticated$& (with the authenticator name)
27584 and &$authenticated_fail_id$& (as set by the authenticator &%server_set_id%& option)
27585 will be valid.
27586 If the event is serviced and a string is returned then the string will be logged
27587 instead of the default log line.
27588 See <<CHAPevents>> for details on events.
27589 .wen
27590
27591
27592 .section "Testing server authentication" "SECID169"
27593 .cindex "authentication" "testing a server"
27594 .cindex "AUTH" "testing a server"
27595 .cindex "base64 encoding" "creating authentication test data"
27596 Exim's &%-bh%& option can be useful for testing server authentication
27597 configurations. The data for the AUTH command has to be sent using base64
27598 encoding. A quick way to produce such data for testing is the following Perl
27599 script:
27600 .code
27601 use MIME::Base64;
27602 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27603 .endd
27604 .cindex "binary zero" "in authentication data"
27605 This interprets its argument as a Perl string, and then encodes it. The
27606 interpretation as a Perl string allows binary zeros, which are required for
27607 some kinds of authentication, to be included in the data. For example, a
27608 command line to run this script on such data might be
27609 .code
27610 encode '\0user\0password'
27611 .endd
27612 Note the use of single quotes to prevent the shell interpreting the
27613 backslashes, so that they can be interpreted by Perl to specify characters
27614 whose code value is zero.
27615
27616 &*Warning 1*&: If either of the user or password strings starts with an octal
27617 digit, you must use three zeros instead of one after the leading backslash. If
27618 you do not, the octal digit that starts your string will be incorrectly
27619 interpreted as part of the code for the first character.
27620
27621 &*Warning 2*&: If there are characters in the strings that Perl interprets
27622 specially, you must use a Perl escape to prevent them being misinterpreted. For
27623 example, a command such as
27624 .code
27625 encode '\0user@domain.com\0pas$$word'
27626 .endd
27627 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27628
27629 If you have the &%mimencode%& command installed, another way to produce
27630 base64-encoded strings is to run the command
27631 .code
27632 echo -e -n `\0user\0password' | mimencode
27633 .endd
27634 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27635 in the argument, and the &%-n%& option specifies no newline at the end of its
27636 output. However, not all versions of &%echo%& recognize these options, so you
27637 should check your version before relying on this suggestion.
27638
27639
27640
27641 .section "Authentication by an Exim client" "SECID170"
27642 .cindex "authentication" "on an Exim client"
27643 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27644 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27645 announces support for authentication, and the host matches an entry in either
27646 of these options, Exim (as a client) tries to authenticate as follows:
27647
27648 .ilist
27649 For each authenticator that is configured as a client, in the order in which
27650 they are defined in the configuration, it searches the authentication
27651 mechanisms announced by the server for one whose name matches the public name
27652 of the authenticator.
27653 .next
27654 .vindex "&$host$&"
27655 .vindex "&$host_address$&"
27656 When it finds one that matches, it runs the authenticator's client code. The
27657 variables &$host$& and &$host_address$& are available for any string expansions
27658 that the client might do. They are set to the server's name and IP address. If
27659 any expansion is forced to fail, the authentication attempt is abandoned, and
27660 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27661 delivery to be deferred.
27662 .next
27663 If the result of the authentication attempt is a temporary error or a timeout,
27664 Exim abandons trying to send the message to the host for the moment. It will
27665 try again later. If there are any backup hosts available, they are tried in the
27666 usual way.
27667
27668 .new
27669 .next
27670 .cindex authentication "failure event, client"
27671 If the response to authentication is a permanent error (5&'xx'& code),
27672 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27673 While the event is being processed the variable
27674 &$sender_host_authenticated$& (with the authenticator name)
27675 will be valid.
27676 If the event is serviced and a string is returned then the string will be logged.
27677 See <<CHAPevents>> for details on events.
27678 .wen
27679
27680 .next
27681 If the response to authentication is a permanent error (5&'xx'& code), Exim
27682 carries on searching the list of authenticators and tries another one if
27683 possible. If all authentication attempts give permanent errors, or if there are
27684 no attempts because no mechanisms match (or option expansions force failure),
27685 what happens depends on whether the host matches &%hosts_require_auth%& or
27686 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27687 delivery is deferred. The error can be detected in the retry rules, and thereby
27688 turned into a permanent error if you wish. In the second case, Exim tries to
27689 deliver the message unauthenticated.
27690 .endlist
27691
27692 Note that the hostlist test for whether to do authentication can be
27693 confused if name-IP lookups change between the time the peer is decided
27694 upon and the time that the transport runs.  For example, with a manualroute
27695 router given a host name, and with DNS "round-robin" used by that name: if
27696 the local resolver cache times out between the router and the transport
27697 running, the transport may get an IP for the name for its authentication
27698 check which does not match the connection peer IP.
27699 No authentication will then be done, despite the names being identical.
27700
27701 For such cases use a separate transport which always authenticates.
27702
27703 .cindex "AUTH" "on MAIL command"
27704 When Exim has authenticated itself to a remote server, it adds the AUTH
27705 parameter to the MAIL commands it sends, if it has an authenticated sender for
27706 the message. If the message came from a remote host, the authenticated sender
27707 is the one that was receiving on an incoming MAIL command, provided that the
27708 incoming connection was authenticated and the &%server_mail_auth%& condition
27709 allowed the authenticated sender to be retained. If a local process calls Exim
27710 to send a message, the sender address that is built from the login name and
27711 &%qualify_domain%& is treated as authenticated. However, if the
27712 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27713 the authenticated sender that was received with the message.
27714 .ecindex IIDauthconf1
27715 .ecindex IIDauthconf2
27716
27717
27718
27719
27720
27721
27722 . ////////////////////////////////////////////////////////////////////////////
27723 . ////////////////////////////////////////////////////////////////////////////
27724
27725 .chapter "The plaintext authenticator" "CHAPplaintext"
27726 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27727 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27728 The &(plaintext)& authenticator can be configured to support the PLAIN and
27729 LOGIN authentication mechanisms, both of which transfer authentication data as
27730 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27731 security risk; you are strongly advised to insist on the use of SMTP encryption
27732 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27733 use unencrypted plain text, you should not use the same passwords for SMTP
27734 connections as you do for login accounts.
27735
27736 .section "Avoiding cleartext use" "SECTplain_TLS"
27737 The following generic option settings will disable &(plaintext)& authenticators when
27738 TLS is not being used:
27739 .code
27740   server_advertise_condition = ${if def:tls_in_cipher }
27741   client_condition =           ${if def:tls_out_cipher}
27742 .endd
27743
27744 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27745 but is still vulnerable to a Man In The Middle attack unless certificates
27746 (including their names) have been properly verified.
27747
27748 .section "Plaintext server options" "SECID171"
27749 .cindex "options" "&(plaintext)& authenticator (server)"
27750 When configured as a server, &(plaintext)& uses the following options:
27751
27752 .option server_condition authenticators string&!! unset
27753 This is actually a global authentication option, but it must be set in order to
27754 configure the &(plaintext)& driver as a server. Its use is described below.
27755
27756 .option server_prompts plaintext "string list&!!" unset
27757 The contents of this option, after expansion, must be a colon-separated list of
27758 prompt strings. If expansion fails, a temporary authentication rejection is
27759 given.
27760
27761 .section "Using plaintext in a server" "SECTplainserver"
27762 .cindex "AUTH" "in &(plaintext)& authenticator"
27763 .cindex "binary zero" "in &(plaintext)& authenticator"
27764 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27765         "in &(plaintext)& authenticator"
27766 .vindex "&$auth1$&, &$auth2$&, etc"
27767 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27768
27769 When running as a server, &(plaintext)& performs the authentication test by
27770 expanding a string. The data sent by the client with the AUTH command, or in
27771 response to subsequent prompts, is base64 encoded, and so may contain any byte
27772 values when decoded. If any data is supplied with the command, it is treated as
27773 a list of strings, separated by NULs (binary zeros), the first three of which
27774 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27775 (neither LOGIN nor PLAIN uses more than three strings).
27776
27777 For compatibility with previous releases of Exim, the values are also placed in
27778 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27779 variables for this purpose is now deprecated, as it can lead to confusion in
27780 string expansions that also use them for other things.
27781
27782 If there are more strings in &%server_prompts%& than the number of strings
27783 supplied with the AUTH command, the remaining prompts are used to obtain more
27784 data. Each response from the client may be a list of NUL-separated strings.
27785
27786 .vindex "&$authenticated_id$&"
27787 Once a sufficient number of data strings have been received,
27788 &%server_condition%& is expanded. If the expansion is forced to fail,
27789 authentication fails. Any other expansion failure causes a temporary error code
27790 to be returned. If the result of a successful expansion is an empty string,
27791 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27792 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27793 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27794 For any other result, a temporary error code is returned, with the expanded
27795 string as the error text.
27796
27797 &*Warning*&: If you use a lookup in the expansion to find the user's
27798 password, be sure to make the authentication fail if the user is unknown.
27799 There are good and bad examples at the end of the next section.
27800
27801
27802
27803 .section "The PLAIN authentication mechanism" "SECID172"
27804 .cindex "PLAIN authentication mechanism"
27805 .cindex authentication PLAIN
27806 .cindex "binary zero" "in &(plaintext)& authenticator"
27807 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27808 sent as one item of data (that is, one combined string containing two NUL
27809 separators). The data is sent either as part of the AUTH command, or
27810 subsequently in response to an empty prompt from the server.
27811
27812 The second and third strings are a user name and a corresponding password.
27813 Using a single fixed user name and password as an example, this could be
27814 configured as follows:
27815 .code
27816 fixed_plain:
27817   driver = plaintext
27818   public_name = PLAIN
27819   server_prompts = :
27820   server_condition = \
27821     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27822   server_set_id = $auth2
27823 .endd
27824 Note that the default result strings from &%if%& (&"true"& or an empty string)
27825 are exactly what we want here, so they need not be specified. Obviously, if the
27826 password contains expansion-significant characters such as dollar, backslash,
27827 or closing brace, they have to be escaped.
27828
27829 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27830 the end of a string list are ignored). If all the data comes as part of the
27831 AUTH command, as is commonly the case, the prompt is not used. This
27832 authenticator is advertised in the response to EHLO as
27833 .code
27834 250-AUTH PLAIN
27835 .endd
27836 and a client host can authenticate itself by sending the command
27837 .code
27838 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27839 .endd
27840 As this contains three strings (more than the number of prompts), no further
27841 data is required from the client. Alternatively, the client may just send
27842 .code
27843 AUTH PLAIN
27844 .endd
27845 to initiate authentication, in which case the server replies with an empty
27846 prompt. The client must respond with the combined data string.
27847
27848 The data string is base64 encoded, as required by the RFC. This example,
27849 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27850 represents a zero byte. This is split up into three strings, the first of which
27851 is empty. The &%server_condition%& option in the authenticator checks that the
27852 second two are &`username`& and &`mysecret`& respectively.
27853
27854 Having just one fixed user name and password, as in this example, is not very
27855 realistic, though for a small organization with only a handful of
27856 authenticating clients it could make sense.
27857
27858 A more sophisticated instance of this authenticator could use the user name in
27859 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27860 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27861 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27862 This is an incorrect example:
27863 .code
27864 server_condition = \
27865   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27866 .endd
27867 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27868 which it then compares to the supplied password (&$auth3$&). Why is this example
27869 incorrect? It works fine for existing users, but consider what happens if a
27870 non-existent user name is given. The lookup fails, but as no success/failure
27871 strings are given for the lookup, it yields an empty string. Thus, to defeat
27872 the authentication, all a client has to do is to supply a non-existent user
27873 name and an empty password. The correct way of writing this test is:
27874 .code
27875 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27876   {${if eq{$value}{$auth3}}} {false}}
27877 .endd
27878 In this case, if the lookup succeeds, the result is checked; if the lookup
27879 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27880 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27881 always fails if its second argument is empty. However, the second way of
27882 writing the test makes the logic clearer.
27883
27884
27885 .section "The LOGIN authentication mechanism" "SECID173"
27886 .cindex "LOGIN authentication mechanism"
27887 .cindex authentication LOGIN
27888 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27889 in a number of programs. No data is sent with the AUTH command. Instead, a
27890 user name and password are supplied separately, in response to prompts. The
27891 plaintext authenticator can be configured to support this as in this example:
27892 .code
27893 fixed_login:
27894   driver = plaintext
27895   public_name = LOGIN
27896   server_prompts = User Name : Password
27897   server_condition = \
27898     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27899   server_set_id = $auth1
27900 .endd
27901 Because of the way plaintext operates, this authenticator accepts data supplied
27902 with the AUTH command (in contravention of the specification of LOGIN), but
27903 if the client does not supply it (as is the case for LOGIN clients), the prompt
27904 strings are used to obtain two data items.
27905
27906 Some clients are very particular about the precise text of the prompts. For
27907 example, Outlook Express is reported to recognize only &"Username:"& and
27908 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27909 strings. It uses the &%ldapauth%& expansion condition to check the user
27910 name and password by binding to an LDAP server:
27911 .code
27912 login:
27913   driver = plaintext
27914   public_name = LOGIN
27915   server_prompts = Username:: : Password::
27916   server_condition = ${if and{{ \
27917     !eq{}{$auth1} }{ \
27918     ldapauth{\
27919       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27920       pass=${quote:$auth2} \
27921       ldap://ldap.example.org/} }} }
27922   server_set_id = uid=$auth1,ou=people,o=example.org
27923 .endd
27924 We have to check that the username is not empty before using it, because LDAP
27925 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27926 operator to correctly quote the DN for authentication. However, the basic
27927 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27928 correct one to use for the password, because quoting is needed only to make
27929 the password conform to the Exim syntax. At the LDAP level, the password is an
27930 uninterpreted string.
27931
27932
27933 .section "Support for different kinds of authentication" "SECID174"
27934 A number of string expansion features are provided for the purpose of
27935 interfacing to different ways of user authentication. These include checking
27936 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27937 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27938 &<<SECTexpcond>>&.
27939
27940
27941
27942
27943 .section "Using plaintext in a client" "SECID175"
27944 .cindex "options" "&(plaintext)& authenticator (client)"
27945 The &(plaintext)& authenticator has two client options:
27946
27947 .option client_ignore_invalid_base64 plaintext boolean false
27948 If the client receives a server prompt that is not a valid base64 string,
27949 authentication is abandoned by default. However, if this option is set true,
27950 the error in the challenge is ignored and the client sends the response as
27951 usual.
27952
27953 .option client_send plaintext string&!! unset
27954 The string is a colon-separated list of authentication data strings. Each
27955 string is independently expanded before being sent to the server. The first
27956 string is sent with the AUTH command; any more strings are sent in response
27957 to prompts from the server. Before each string is expanded, the value of the
27958 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27959 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27960 way. Thus, the prompt that is received in response to sending the first string
27961 (with the AUTH command) can be used in the expansion of the second string, and
27962 so on. If an invalid base64 string is received when
27963 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27964 &$auth$&<&'n'&> variable.
27965
27966 &*Note*&: You cannot use expansion to create multiple strings, because
27967 splitting takes priority and happens first.
27968
27969 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27970 the data, further processing is applied to each string before it is sent. If
27971 there are any single circumflex characters in the string, they are converted to
27972 NULs. Should an actual circumflex be required as data, it must be doubled in
27973 the string.
27974
27975 This is an example of a client configuration that implements the PLAIN
27976 authentication mechanism with a fixed user name and password:
27977 .code
27978 fixed_plain:
27979   driver = plaintext
27980   public_name = PLAIN
27981   client_send = ^username^mysecret
27982 .endd
27983 The lack of colons means that the entire text is sent with the AUTH
27984 command, with the circumflex characters converted to NULs.
27985 Note that due to the ambiguity of parsing three consectutive circumflex characters
27986 there is no way to provide a password having a leading circumflex.
27987
27988
27989 A similar example
27990 that uses the LOGIN mechanism is:
27991 .code
27992 fixed_login:
27993   driver = plaintext
27994   public_name = LOGIN
27995   client_send = : username : mysecret
27996 .endd
27997 The initial colon means that the first string is empty, so no data is sent with
27998 the AUTH command itself. The remaining strings are sent in response to
27999 prompts.
28000 .ecindex IIDplaiauth1
28001 .ecindex IIDplaiauth2
28002
28003
28004
28005
28006 . ////////////////////////////////////////////////////////////////////////////
28007 . ////////////////////////////////////////////////////////////////////////////
28008
28009 .chapter "The cram_md5 authenticator" "CHID9"
28010 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
28011 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
28012 .cindex "CRAM-MD5 authentication mechanism"
28013 .cindex authentication CRAM-MD5
28014 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
28015 sends a challenge string to the client, and the response consists of a user
28016 name and the CRAM-MD5 digest of the challenge string combined with a secret
28017 string (password) which is known to both server and client. Thus, the secret
28018 is not sent over the network as plain text, which makes this authenticator more
28019 secure than &(plaintext)&. However, the downside is that the secret has to be
28020 available in plain text at either end.
28021
28022
28023 .section "Using cram_md5 as a server" "SECID176"
28024 .cindex "options" "&(cram_md5)& authenticator (server)"
28025 This authenticator has one server option, which must be set to configure the
28026 authenticator as a server:
28027
28028 .option server_secret cram_md5 string&!! unset
28029 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
28030 When the server receives the client's response, the user name is placed in
28031 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
28032 obtain the password for that user. The server then computes the CRAM-MD5 digest
28033 that the client should have sent, and checks that it received the correct
28034 string. If the expansion of &%server_secret%& is forced to fail, authentication
28035 fails. If the expansion fails for some other reason, a temporary error code is
28036 returned to the client.
28037
28038 For compatibility with previous releases of Exim, the user name is also placed
28039 in &$1$&. However, the use of this variables for this purpose is now
28040 deprecated, as it can lead to confusion in string expansions that also use
28041 numeric variables for other things.
28042
28043 For example, the following authenticator checks that the user name given by the
28044 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
28045 user name, authentication fails.
28046 .code
28047 fixed_cram:
28048   driver = cram_md5
28049   public_name = CRAM-MD5
28050   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
28051   server_set_id = $auth1
28052 .endd
28053 .vindex "&$authenticated_id$&"
28054 If authentication succeeds, the setting of &%server_set_id%& preserves the user
28055 name in &$authenticated_id$&. A more typical configuration might look up the
28056 secret string in a file, using the user name as the key. For example:
28057 .code
28058 lookup_cram:
28059   driver = cram_md5
28060   public_name = CRAM-MD5
28061   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
28062                   {$value}fail}
28063   server_set_id = $auth1
28064 .endd
28065 Note that this expansion explicitly forces failure if the lookup fails
28066 because &$auth1$& contains an unknown user name.
28067
28068 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
28069 using the relevant libraries, you need to know the realm to specify in the
28070 lookup and then ask for the &"userPassword"& attribute for that user in that
28071 realm, with:
28072 .code
28073 cyrusless_crammd5:
28074   driver = cram_md5
28075   public_name = CRAM-MD5
28076   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
28077                   dbmjz{/etc/sasldb2}{$value}fail}
28078   server_set_id = $auth1
28079 .endd
28080
28081 .section "Using cram_md5 as a client" "SECID177"
28082 .cindex "options" "&(cram_md5)& authenticator (client)"
28083 When used as a client, the &(cram_md5)& authenticator has two options:
28084
28085
28086
28087 .option client_name cram_md5 string&!! "the primary host name"
28088 This string is expanded, and the result used as the user name data when
28089 computing the response to the server's challenge.
28090
28091
28092 .option client_secret cram_md5 string&!! unset
28093 This option must be set for the authenticator to work as a client. Its value is
28094 expanded and the result used as the secret string when computing the response.
28095
28096
28097 .vindex "&$host$&"
28098 .vindex "&$host_address$&"
28099 Different user names and secrets can be used for different servers by referring
28100 to &$host$& or &$host_address$& in the options. Forced failure of either
28101 expansion string is treated as an indication that this authenticator is not
28102 prepared to handle this case. Exim moves on to the next configured client
28103 authenticator. Any other expansion failure causes Exim to give up trying to
28104 send the message to the current server.
28105
28106 A simple example configuration of a &(cram_md5)& authenticator, using fixed
28107 strings, is:
28108 .code
28109 fixed_cram:
28110   driver = cram_md5
28111   public_name = CRAM-MD5
28112   client_name = ph10
28113   client_secret = secret
28114 .endd
28115 .ecindex IIDcramauth1
28116 .ecindex IIDcramauth2
28117
28118
28119
28120 . ////////////////////////////////////////////////////////////////////////////
28121 . ////////////////////////////////////////////////////////////////////////////
28122
28123 .chapter "The cyrus_sasl authenticator" "CHID10"
28124 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
28125 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
28126 .cindex "Cyrus" "SASL library"
28127 .cindex "Kerberos"
28128 The code for this authenticator was provided by Matthew Byng-Maddick while
28129 at A L Digital Ltd.
28130
28131 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
28132 library implementation of the RFC 2222 (&"Simple Authentication and Security
28133 Layer"&). This library supports a number of authentication mechanisms,
28134 including PLAIN and LOGIN, but also several others that Exim does not support
28135 directly. In particular, there is support for Kerberos authentication.
28136
28137 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
28138 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
28139 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
28140 name of the driver to determine which mechanism to support.
28141
28142 Where access to some kind of secret file is required, for example, in GSSAPI
28143 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
28144 user, and that the Cyrus SASL library has no way of escalating privileges
28145 by default. You may also find you need to set environment variables,
28146 depending on the driver you are using.
28147
28148 The application name provided by Exim is &"exim"&, so various SASL options may
28149 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
28150 Kerberos, note that because of limitations in the GSSAPI interface,
28151 changing the server keytab might need to be communicated down to the Kerberos
28152 layer independently. The mechanism for doing so is dependent upon the Kerberos
28153 implementation.
28154
28155 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
28156 may be set to point to an alternative keytab file. Exim will pass this
28157 variable through from its own inherited environment when started as root or the
28158 Exim user. The keytab file needs to be readable by the Exim user.
28159 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
28160 environment variable.  In practice, for those releases, the Cyrus authenticator
28161 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28162 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28163
28164
28165 .section "Using cyrus_sasl as a server" "SECID178"
28166 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28167 (on a successful authentication) into &$auth1$&. For compatibility with
28168 previous releases of Exim, the username is also placed in &$1$&. However, the
28169 use of this variable for this purpose is now deprecated, as it can lead to
28170 confusion in string expansions that also use numeric variables for other
28171 things.
28172
28173
28174 .option server_hostname cyrus_sasl string&!! "see below"
28175 This option selects the hostname that is used when communicating with the
28176 library. The default value is &`$primary_hostname`&. It is up to the underlying
28177 SASL plug-in what it does with this data.
28178
28179
28180 .option server_mech cyrus_sasl string "see below"
28181 This option selects the authentication mechanism this driver should use. The
28182 default is the value of the generic &%public_name%& option. This option allows
28183 you to use a different underlying mechanism from the advertised name. For
28184 example:
28185 .code
28186 sasl:
28187   driver = cyrus_sasl
28188   public_name = X-ANYTHING
28189   server_mech = CRAM-MD5
28190   server_set_id = $auth1
28191 .endd
28192
28193 .option server_realm cyrus_sasl string&!! unset
28194 This specifies the SASL realm that the server claims to be in.
28195
28196
28197 .option server_service cyrus_sasl string &`smtp`&
28198 This is the SASL service that the server claims to implement.
28199
28200
28201 For straightforward cases, you do not need to set any of the authenticator's
28202 private options. All you need to do is to specify an appropriate mechanism as
28203 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28204 PLAIN, you could have two authenticators as follows:
28205 .code
28206 sasl_cram_md5:
28207   driver = cyrus_sasl
28208   public_name = CRAM-MD5
28209   server_set_id = $auth1
28210
28211 sasl_plain:
28212   driver = cyrus_sasl
28213   public_name = PLAIN
28214   server_set_id = $auth2
28215 .endd
28216 Cyrus SASL does implement the LOGIN authentication method, even though it is
28217 not a standard method. It is disabled by default in the source distribution,
28218 but it is present in many binary distributions.
28219 .ecindex IIDcyrauth1
28220 .ecindex IIDcyrauth2
28221
28222
28223
28224
28225 . ////////////////////////////////////////////////////////////////////////////
28226 . ////////////////////////////////////////////////////////////////////////////
28227 .chapter "The dovecot authenticator" "CHAPdovecot"
28228 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28229 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28230 This authenticator is an interface to the authentication facility of the
28231 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28232 Note that Dovecot must be configured to use auth-client not auth-userdb.
28233 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28234 to use the same mechanisms for SMTP authentication. This is a server
28235 authenticator only. There is only one option:
28236
28237 .option server_socket dovecot string unset
28238
28239 This option must specify the UNIX socket that is the interface to Dovecot
28240 authentication. The &%public_name%& option must specify an authentication
28241 mechanism that Dovecot is configured to support. You can have several
28242 authenticators for different mechanisms. For example:
28243 .code
28244 dovecot_plain:
28245   driver = dovecot
28246   public_name = PLAIN
28247   server_socket = /var/run/dovecot/auth-client
28248   server_set_id = $auth1
28249
28250 dovecot_ntlm:
28251   driver = dovecot
28252   public_name = NTLM
28253   server_socket = /var/run/dovecot/auth-client
28254   server_set_id = $auth1
28255 .endd
28256 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28257 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28258 option is passed in the Dovecot authentication command. If, for a TLS
28259 connection, a client certificate has been verified, the &"valid-client-cert"&
28260 option is passed. When authentication succeeds, the identity of the user
28261 who authenticated is placed in &$auth1$&.
28262
28263 The Dovecot configuration to match the above will look
28264 something like:
28265 .code
28266 conf.d/10-master.conf :-
28267
28268 service auth {
28269 ...
28270 #SASL
28271   unix_listener auth-client {
28272     mode = 0660
28273     user = mail
28274   }
28275 ...
28276 }
28277
28278 conf.d/10-auth.conf :-
28279
28280 auth_mechanisms = plain login ntlm
28281 .endd
28282
28283 .ecindex IIDdcotauth1
28284 .ecindex IIDdcotauth2
28285
28286
28287 . ////////////////////////////////////////////////////////////////////////////
28288 . ////////////////////////////////////////////////////////////////////////////
28289 .chapter "The gsasl authenticator" "CHAPgsasl"
28290 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28291 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28292 .cindex "authentication" "GNU SASL"
28293 .cindex "authentication" "SASL"
28294 .cindex "authentication" "EXTERNAL"
28295 .cindex "authentication" "ANONYMOUS"
28296 .cindex "authentication" "PLAIN"
28297 .cindex "authentication" "LOGIN"
28298 .cindex "authentication" "DIGEST-MD5"
28299 .cindex "authentication" "CRAM-MD5"
28300 .cindex "authentication" "SCRAM family"
28301 The &(gsasl)& authenticator provides integration for the GNU SASL
28302 library and the mechanisms it provides.  This is new as of the 4.80 release
28303 and there are a few areas where the library does not let Exim smoothly
28304 scale to handle future authentication mechanisms, so no guarantee can be
28305 made that any particular new authentication mechanism will be supported
28306 without code changes in Exim.
28307
28308 The library is expected to add support in an upcoming
28309 realease for the SCRAM-SHA-256 method.
28310 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28311 when this happens.
28312
28313 To see the list of mechanisms supported by the library run Exim with "auth" debug
28314 enabled and look for a line containing "GNU SASL supports".
28315 Note however that some may not have been tested from Exim.
28316
28317
28318 .option client_authz gsasl string&!! unset
28319 This option can be used to supply an &'authorization id'&
28320 which is different to the &'authentication_id'& provided
28321 by &%client_username%& option.
28322 If unset or (after expansion) empty it is not used,
28323 which is the common case.
28324
28325 .option client_channelbinding gsasl boolean false
28326 See &%server_channelbinding%& below.
28327
28328 .option client_password gsasl string&!! unset
28329 This option is exapanded before use, and should result in
28330 the password to be used, in clear.
28331
28332 .option client_username gsasl string&!! unset
28333 This option is exapanded before use, and should result in
28334 the account name to be used.
28335
28336
28337 .option client_spassword gsasl string&!! unset
28338 This option is only supported for library versions 1.9.1 and greater.
28339 The macro _HAVE_AUTH_GSASL_SCRAM_S_KEY will be defined when this is so.
28340
28341 If a SCRAM mechanism is being used and this option is set
28342 and correctly sized
28343 it is used in preference to &%client_password%&.
28344 The value after expansion should be
28345 a 40 (for SHA-1) or 64 (for SHA-256) character string
28346 with the PBKDF2-prepared password, hex-encoded.
28347
28348 Note that this value will depend on the salt and iteration-count
28349 supplied by the server.
28350 The option is expanded before use.
28351 During the expansion &$auth1$& is set with the client username,
28352 &$auth2$& with the iteration count, and
28353 &$auth3$& with the salt.
28354
28355 The intent of this option
28356 is to support clients that can cache thes salted password
28357 to save on recalculation costs.
28358 The cache lookup should return an unusable value
28359 (eg. an empty string)
28360 if the salt or iteration count has changed
28361
28362 If the authentication succeeds then the above variables are set,
28363 .vindex "&$auth4$&"
28364 plus the calculated salted password value value in &$auth4$&,
28365 during the expansion of the &%client_set_id%& option.
28366 A side-effect of this expansion can be used to prime the cache.
28367
28368
28369 .option server_channelbinding gsasl boolean false
28370 Some authentication mechanisms are able to use external context at both ends
28371 of the session to bind the authentication to that context, and fail the
28372 authentication process if that context differs.  Specifically, some TLS
28373 ciphersuites can provide identifying information about the cryptographic
28374 context.
28375
28376 This should have meant that certificate identity and verification becomes a
28377 non-issue, as a man-in-the-middle attack will cause the correct client and
28378 server to see different identifiers and authentication will fail.
28379
28380 This is
28381 only usable by mechanisms which support "channel binding"; at time of
28382 writing, that's the SCRAM family.
28383 When using this feature the "-PLUS" variants of the method names need to be used.
28384
28385 This defaults off to ensure smooth upgrade across Exim releases, in case
28386 this option causes some clients to start failing.  Some future release
28387 of Exim might have switched the default to be true.
28388
28389 . However, Channel Binding in TLS has proven to be vulnerable in current versions.
28390 . Do not plan to rely upon this feature for security, ever, without consulting
28391 . with a subject matter expert (a cryptographic engineer).
28392
28393 This option was deprecated in previous releases due to doubts over
28394 the "Triple Handshake" vulnerability.
28395 Exim takes suitable precausions (requiring Extended Master Secret if TLS
28396 Session Resumption was used) for safety.
28397
28398
28399 .option server_hostname gsasl string&!! "see below"
28400 This option selects the hostname that is used when communicating with the
28401 library. The default value is &`$primary_hostname`&.
28402 Some mechanisms will use this data.
28403
28404
28405 .option server_mech gsasl string "see below"
28406 This option selects the authentication mechanism this driver should use. The
28407 default is the value of the generic &%public_name%& option. This option allows
28408 you to use a different underlying mechanism from the advertised name. For
28409 example:
28410 .code
28411 sasl:
28412   driver = gsasl
28413   public_name = X-ANYTHING
28414   server_mech = CRAM-MD5
28415   server_set_id = $auth1
28416 .endd
28417
28418
28419 .option server_password gsasl string&!! unset
28420 Various mechanisms need access to the cleartext password on the server, so
28421 that proof-of-possession can be demonstrated on the wire, without sending
28422 the password itself.
28423
28424 The data available for lookup varies per mechanism.
28425 In all cases, &$auth1$& is set to the &'authentication id'&.
28426 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28427 if available, else the empty string.
28428 The &$auth3$& variable will always be the &'realm'& if available,
28429 else the empty string.
28430
28431 A forced failure will cause authentication to defer.
28432
28433 If using this option, it may make sense to set the &%server_condition%&
28434 option to be simply "true".
28435
28436
28437 .option server_realm gsasl string&!! unset
28438 This specifies the SASL realm that the server claims to be in.
28439 Some mechanisms will use this data.
28440
28441
28442 .option server_scram_iter gsasl string&!! 4096
28443 This option provides data for the SCRAM family of mechanisms.
28444 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28445 when this option is expanded.
28446
28447 The result of expansion should be a decimal number,
28448 and represents both a lower-bound on the security, and
28449 a compute cost factor imposed on the client
28450 (if it does not cache results, or the server changes
28451 either the iteration count or the salt).
28452 A minimum value of 4096 is required by the standards
28453 for all current SCRAM mechanism variants.
28454
28455 .option server_scram_salt gsasl string&!! unset
28456 This option provides data for the SCRAM family of mechanisms.
28457 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28458 when this option is expanded.
28459 The value should be a base64-encoded string,
28460 of random data typically 4-to-16 bytes long.
28461 If unset or empty after expansion the library will provides a value for the
28462 protocol conversation.
28463
28464
28465 .option server_key gsasl string&!! unset
28466 .option server_skey gsasl string&!! unset
28467 These options can be used for the SCRAM family of mechanisms
28468 to provide stored information related to a password,
28469 the storage of which is preferable to plaintext.
28470
28471 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28472 &%server_skey%& is StoredKey.
28473
28474 They are only available for version 1.9.0 (or later) of the gsasl library.
28475 When this is so, the macros
28476 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28477 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28478 will be defined.
28479
28480 The &$authN$& variables are available when these options are expanded.
28481
28482 If set, the results of expansion should for each
28483 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28484 of base64-coded data, and will be used in preference to the
28485 &%server_password%& option.
28486 If unset or not of the right length, &%server_password%& will be used.
28487
28488 The libgsasl library release includes a utility &'gsasl'& which can be used
28489 to generate these values.
28490
28491
28492 .option server_service gsasl string &`smtp`&
28493 This is the SASL service that the server claims to implement.
28494 Some mechanisms will use this data.
28495
28496
28497 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28498 .vindex "&$auth1$&, &$auth2$&, etc"
28499 These may be set when evaluating specific options, as detailed above.
28500 They will also be set when evaluating &%server_condition%&.
28501
28502 Unless otherwise stated below, the &(gsasl)& integration will use the following
28503 meanings for these variables:
28504
28505 .ilist
28506 .vindex "&$auth1$&"
28507 &$auth1$&: the &'authentication id'&
28508 .next
28509 .vindex "&$auth2$&"
28510 &$auth2$&: the &'authorization id'&
28511 .next
28512 .vindex "&$auth3$&"
28513 &$auth3$&: the &'realm'&
28514 .endlist
28515
28516 On a per-mechanism basis:
28517
28518 .ilist
28519 .cindex "authentication" "EXTERNAL"
28520 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28521 the &%server_condition%& option must be present.
28522 .next
28523 .cindex "authentication" "ANONYMOUS"
28524 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28525 the &%server_condition%& option must be present.
28526 .next
28527 .cindex "authentication" "GSSAPI"
28528 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28529 &$auth2$& will be set to the &'authorization id'&,
28530 the &%server_condition%& option must be present.
28531 .endlist
28532
28533 An &'anonymous token'& is something passed along as an unauthenticated
28534 identifier; this is analogous to FTP anonymous authentication passing an
28535 email address, or software-identifier@, as the "password".
28536
28537
28538 An example showing the password having the realm specified in the callback
28539 and demonstrating a Cyrus SASL to GSASL migration approach is:
28540 .code
28541 gsasl_cyrusless_crammd5:
28542   driver = gsasl
28543   public_name = CRAM-MD5
28544   server_realm = imap.example.org
28545   server_password = ${lookup{$auth1:$auth3:userPassword}\
28546                     dbmjz{/etc/sasldb2}{$value}fail}
28547   server_set_id = ${quote:$auth1}
28548   server_condition = yes
28549 .endd
28550
28551
28552 . ////////////////////////////////////////////////////////////////////////////
28553 . ////////////////////////////////////////////////////////////////////////////
28554
28555 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28556 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28557 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28558 .cindex "authentication" "GSSAPI"
28559 .cindex "authentication" "Kerberos"
28560 The &(heimdal_gssapi)& authenticator provides server integration for the
28561 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28562 reliably.
28563
28564 .option server_hostname heimdal_gssapi string&!! "see below"
28565 This option selects the hostname that is used, with &%server_service%&,
28566 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28567 identifier.  The default value is &`$primary_hostname`&.
28568
28569 .option server_keytab heimdal_gssapi string&!! unset
28570 If set, then Heimdal will not use the system default keytab (typically
28571 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28572 The value should be a pathname, with no &"file:"& prefix.
28573
28574 .option server_service heimdal_gssapi string&!! "smtp"
28575 This option specifies the service identifier used, in conjunction with
28576 &%server_hostname%&, for building the identifier for finding credentials
28577 from the keytab.
28578
28579
28580 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28581 Beware that these variables will typically include a realm, thus will appear
28582 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28583 not verified, so a malicious client can set it to anything.
28584
28585 The &$auth1$& field should be safely trustable as a value from the Key
28586 Distribution Center.  Note that these are not quite email addresses.
28587 Each identifier is for a role, and so the left-hand-side may include a
28588 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28589
28590 .vindex "&$auth1$&, &$auth2$&, etc"
28591 .ilist
28592 .vindex "&$auth1$&"
28593 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28594 .next
28595 .vindex "&$auth2$&"
28596 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28597 authentication.  If that was empty, this will also be set to the
28598 GSS Display Name.
28599 .endlist
28600
28601
28602 . ////////////////////////////////////////////////////////////////////////////
28603 . ////////////////////////////////////////////////////////////////////////////
28604
28605 .chapter "The spa authenticator" "CHAPspa"
28606 .scindex IIDspaauth1 "&(spa)& authenticator"
28607 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28608 .cindex "authentication" "Microsoft Secure Password"
28609 .cindex "authentication" "NTLM"
28610 .cindex "Microsoft Secure Password Authentication"
28611 .cindex "NTLM authentication"
28612 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28613 Password Authentication'& mechanism,
28614 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28615 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28616 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28617 server side was subsequently contributed by Tom Kistner. The mechanism works as
28618 follows:
28619
28620 .ilist
28621 After the AUTH command has been accepted, the client sends an SPA
28622 authentication request based on the user name and optional domain.
28623 .next
28624 The server sends back a challenge.
28625 .next
28626 The client builds a challenge response which makes use of the user's password
28627 and sends it to the server, which then accepts or rejects it.
28628 .endlist
28629
28630 Encryption is used to protect the password in transit.
28631
28632
28633
28634 .section "Using spa as a server" "SECID179"
28635 .cindex "options" "&(spa)& authenticator (server)"
28636 The &(spa)& authenticator has just one server option:
28637
28638 .option server_password spa string&!! unset
28639 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28640 This option is expanded, and the result must be the cleartext password for the
28641 authenticating user, whose name is at this point in &$auth1$&. For
28642 compatibility with previous releases of Exim, the user name is also placed in
28643 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28644 it can lead to confusion in string expansions that also use numeric variables
28645 for other things. For example:
28646 .code
28647 spa:
28648   driver = spa
28649   public_name = NTLM
28650   server_password = \
28651     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28652 .endd
28653 If the expansion is forced to fail, authentication fails. Any other expansion
28654 failure causes a temporary error code to be returned.
28655
28656
28657
28658
28659
28660 .section "Using spa as a client" "SECID180"
28661 .cindex "options" "&(spa)& authenticator (client)"
28662 The &(spa)& authenticator has the following client options:
28663
28664
28665
28666 .option client_domain spa string&!! unset
28667 This option specifies an optional domain for the authentication.
28668
28669
28670 .option client_password spa string&!! unset
28671 This option specifies the user's password, and must be set.
28672
28673
28674 .option client_username spa string&!! unset
28675 This option specifies the user name, and must be set. Here is an example of a
28676 configuration of this authenticator for use with the mail servers at
28677 &'msn.com'&:
28678 .code
28679 msn:
28680   driver = spa
28681   public_name = MSN
28682   client_username = msn/msn_username
28683   client_password = msn_plaintext_password
28684   client_domain = DOMAIN_OR_UNSET
28685 .endd
28686 .ecindex IIDspaauth1
28687 .ecindex IIDspaauth2
28688
28689
28690
28691
28692
28693 . ////////////////////////////////////////////////////////////////////////////
28694 . ////////////////////////////////////////////////////////////////////////////
28695
28696 .chapter "The external authenticator" "CHAPexternauth"
28697 .scindex IIDexternauth1 "&(external)& authenticator"
28698 .scindex IIDexternauth2 "authenticators" "&(external)&"
28699 .cindex "authentication" "Client Certificate"
28700 .cindex "authentication" "X509"
28701 .cindex "Certificate-based authentication"
28702 The &(external)& authenticator provides support for
28703 authentication based on non-SMTP information.
28704 The specification is in RFC 4422 Appendix A
28705 (&url(https://tools.ietf.org/html/rfc4422)).
28706 It is only a transport and negotiation mechanism;
28707 the process of authentication is entirely controlled
28708 by the server configuration.
28709
28710 The client presents an identity in-clear.
28711 It is probably wise for a server to only advertise,
28712 and for clients to only attempt,
28713 this authentication method on a secure (eg. under TLS) connection.
28714
28715 One possible use, compatible with the
28716 K-9 Mail Android client (&url(https://k9mail.github.io/)),
28717 is for using X509 client certificates.
28718
28719 It thus overlaps in function with the TLS authenticator
28720 (see &<<CHAPtlsauth>>&)
28721 but is a full SMTP SASL authenticator
28722 rather than being implicit for TLS-connection carried
28723 client certificates only.
28724
28725 The examples and discussion in this chapter assume that
28726 client-certificate authentication is being done.
28727
28728 The client must present a certificate,
28729 for which it must have been requested via the
28730 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28731 (see &<<CHAPTLS>>&).
28732 For authentication to be effective the certificate should be
28733 verifiable against a trust-anchor certificate known to the server.
28734
28735 .section "External options" "SECTexternsoptions"
28736 .cindex "options" "&(external)& authenticator (server)"
28737 The &(external)& authenticator has two server options:
28738
28739 .option server_param2 external string&!! unset
28740 .option server_param3 external string&!! unset
28741 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28742 These options are expanded before the &%server_condition%& option
28743 and the result are placed in &$auth2$& and &$auth3$& resectively.
28744 If the expansion is forced to fail, authentication fails. Any other expansion
28745 failure causes a temporary error code to be returned.
28746
28747 They can be used to clarify the coding of a complex &%server_condition%&.
28748
28749 .section "Using external in a server" "SECTexternserver"
28750 .cindex "AUTH" "in &(external)& authenticator"
28751 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28752         "in &(external)& authenticator"
28753 .vindex "&$auth1$&, &$auth2$&, etc"
28754 .cindex "base64 encoding" "in &(external)& authenticator"
28755
28756 When running as a server, &(external)& performs the authentication test by
28757 expanding a string. The data sent by the client with the AUTH command, or in
28758 response to subsequent prompts, is base64 encoded, and so may contain any byte
28759 values when decoded. The decoded value is treated as
28760 an identity for authentication and
28761 placed in the expansion variable &$auth1$&.
28762
28763 For compatibility with previous releases of Exim, the value is also placed in
28764 the expansion variable &$1$&. However, the use of this
28765 variable for this purpose is now deprecated, as it can lead to confusion in
28766 string expansions that also use them for other things.
28767
28768 .vindex "&$authenticated_id$&"
28769 Once an identity has been received,
28770 &%server_condition%& is expanded. If the expansion is forced to fail,
28771 authentication fails. Any other expansion failure causes a temporary error code
28772 to be returned. If the result of a successful expansion is an empty string,
28773 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28774 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28775 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28776 For any other result, a temporary error code is returned, with the expanded
28777 string as the error text.
28778
28779 Example:
28780 .code
28781 ext_ccert_san_mail:
28782   driver =            external
28783   public_name =       EXTERNAL
28784
28785   server_advertise_condition = $tls_in_certificate_verified
28786   server_param2 =     ${certextract {subj_altname,mail,>:} \
28787                                     {$tls_in_peercert}}
28788   server_condition =  ${if forany {$auth2} \
28789                             {eq {$item}{$auth1}}}
28790   server_set_id =     $auth1
28791 .endd
28792 This accepts a client certificate that is verifiable against any
28793 of your configured trust-anchors
28794 (which usually means the full set of public CAs)
28795 and which has a mail-SAN matching the claimed identity sent by the client.
28796
28797 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28798 The account name is therefore guessable by an opponent.
28799 TLS 1.3 protects both server and client certificates, and is not vulnerable
28800 in this way.
28801
28802
28803 .section "Using external in a client" "SECTexternclient"
28804 .cindex "options" "&(external)& authenticator (client)"
28805 The &(external)& authenticator has one client option:
28806
28807 .option client_send external string&!! unset
28808 This option is expanded and sent with the AUTH command as the
28809 identity being asserted.
28810
28811 Example:
28812 .code
28813 ext_ccert:
28814   driver =      external
28815   public_name = EXTERNAL
28816
28817   client_condition = ${if !eq{$tls_out_cipher}{}}
28818   client_send = myaccount@smarthost.example.net
28819 .endd
28820
28821
28822 .ecindex IIDexternauth1
28823 .ecindex IIDexternauth2
28824
28825
28826
28827
28828
28829 . ////////////////////////////////////////////////////////////////////////////
28830 . ////////////////////////////////////////////////////////////////////////////
28831
28832 .chapter "The tls authenticator" "CHAPtlsauth"
28833 .scindex IIDtlsauth1 "&(tls)& authenticator"
28834 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28835 .cindex "authentication" "Client Certificate"
28836 .cindex "authentication" "X509"
28837 .cindex "Certificate-based authentication"
28838 The &(tls)& authenticator provides server support for
28839 authentication based on client certificates.
28840
28841 It is not an SMTP authentication mechanism and is not
28842 advertised by the server as part of the SMTP EHLO response.
28843 It is an Exim authenticator in the sense that it affects
28844 the protocol element of the log line, can be tested for
28845 by the &%authenticated%& ACL condition, and can set
28846 the &$authenticated_id$& variable.
28847
28848 The client must present a verifiable certificate,
28849 for which it must have been requested via the
28850 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28851 (see &<<CHAPTLS>>&).
28852
28853 If an authenticator of this type is configured it is
28854 run before any SMTP-level communication is done,
28855 and can authenticate the connection.
28856 If it does, SMTP authentication is not offered.
28857
28858 A maximum of one authenticator of this type may be present.
28859
28860
28861 .cindex "options" "&(tls)& authenticator (server)"
28862 The &(tls)& authenticator has three server options:
28863
28864 .option server_param1 tls string&!! unset
28865 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28866 This option is expanded after the TLS negotiation and
28867 the result is placed in &$auth1$&.
28868 If the expansion is forced to fail, authentication fails. Any other expansion
28869 failure causes a temporary error code to be returned.
28870
28871 .option server_param2 tls string&!! unset
28872 .option server_param3 tls string&!! unset
28873 As above, for &$auth2$& and &$auth3$&.
28874
28875 &%server_param1%& may also be spelled &%server_param%&.
28876
28877
28878 Example:
28879 .code
28880 tls:
28881   driver = tls
28882   server_param1 =     ${certextract {subj_altname,mail,>:} \
28883                                     {$tls_in_peercert}}
28884   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28885                                  {forany {$auth1} \
28886                             {!= {0} \
28887                                 {${lookup ldap{ldap:///\
28888                          mailname=${quote_ldap_dn:${lc:$item}},\
28889                          ou=users,LDAP_DC?mailid} {$value}{0} \
28890                        }    }  } }}}
28891   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28892 .endd
28893 This accepts a client certificate that is verifiable against any
28894 of your configured trust-anchors
28895 (which usually means the full set of public CAs)
28896 and which has a SAN with a good account name.
28897
28898 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28899 The account name is therefore guessable by an opponent.
28900 TLS 1.3 protects both server and client certificates, and is not vulnerable
28901 in this way.
28902 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28903
28904 . An alternative might use
28905 . .code
28906 .   server_param1 = ${sha256:$tls_in_peercert}
28907 . .endd
28908 . to require one of a set of specific certs that define a given account
28909 . (the verification is still required, but mostly irrelevant).
28910 . This would help for per-device use.
28911 .
28912 . However, for the future we really need support for checking a
28913 . user cert in LDAP - which probably wants a base-64 DER.
28914
28915 .ecindex IIDtlsauth1
28916 .ecindex IIDtlsauth2
28917
28918
28919 Note that because authentication is traditionally an SMTP operation,
28920 the &%authenticated%& ACL condition cannot be used in
28921 a connect- or helo-ACL.
28922
28923
28924
28925 . ////////////////////////////////////////////////////////////////////////////
28926 . ////////////////////////////////////////////////////////////////////////////
28927
28928 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28929          "Encrypted SMTP connections"
28930 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28931 .scindex IIDencsmtp2 "SMTP" "encryption"
28932 .cindex "TLS" "on SMTP connection"
28933 .cindex "OpenSSL"
28934 .cindex "GnuTLS"
28935 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28936 Sockets Layer), is implemented by making use of the OpenSSL library or the
28937 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28938 cryptographic code in the Exim distribution itself for implementing TLS. In
28939 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28940 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28941 You also need to understand the basic concepts of encryption at a managerial
28942 level, and in particular, the way that public keys, private keys, and
28943 certificates are used.
28944
28945 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28946 connection is established, the client issues a STARTTLS command. If the
28947 server accepts this, the client and the server negotiate an encryption
28948 mechanism. If the negotiation succeeds, the data that subsequently passes
28949 between them is encrypted.
28950
28951 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28952 and if so, what cipher suite is in use, whether the client supplied a
28953 certificate, and whether or not that certificate was verified. This makes it
28954 possible for an Exim server to deny or accept certain commands based on the
28955 encryption state.
28956
28957 &*Warning*&: Certain types of firewall and certain anti-virus products can
28958 disrupt TLS connections. You need to turn off SMTP scanning for these products
28959 in order to get TLS to work.
28960
28961
28962
28963 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28964          "SECID284"
28965 .cindex "submissions protocol"
28966 .cindex "ssmtp protocol"
28967 .cindex "smtps protocol"
28968 .cindex "SMTP" "submissions protocol"
28969 .cindex "SMTP" "ssmtp protocol"
28970 .cindex "SMTP" "smtps protocol"
28971 The history of port numbers for TLS in SMTP is a little messy and has been
28972 contentious.  As of RFC 8314, the common practice of using the historically
28973 allocated port 465 for "email submission but with TLS immediately upon connect
28974 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28975 by them in preference to STARTTLS.
28976
28977 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28978 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28979 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28980
28981 This approach was, for a while, officially abandoned when encrypted SMTP was
28982 standardized, but many clients kept using it, even as the TCP port number was
28983 reassigned for other use.
28984 Thus you may encounter guidance claiming that you shouldn't enable use of
28985 this port.
28986 In practice, a number of mail-clients have only ever supported submissions,
28987 not submission with STARTTLS upgrade.
28988 Ideally, offer both submission (587) and submissions (465) service.
28989
28990 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28991 global option. Its value must be a list of port numbers;
28992 the most common use is expected to be:
28993 .code
28994 tls_on_connect_ports = 465
28995 .endd
28996 The port numbers specified by this option apply to all SMTP connections, both
28997 via the daemon and via &'inetd'&. You still need to specify all the ports that
28998 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28999 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
29000 an extra port &-- rather, it specifies different behaviour on a port that is
29001 defined elsewhere.
29002
29003 There is also a &%-tls-on-connect%& command line option. This overrides
29004 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
29005
29006
29007
29008
29009
29010
29011 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
29012 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
29013 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
29014 To build Exim to use OpenSSL you need to set
29015 .code
29016 USE_OPENSSL=yes
29017 .endd
29018 in Local/Makefile.
29019
29020 To build Exim to use GnuTLS, you need to set
29021 .code
29022 USE_GNUTLS=yes
29023 .endd
29024 in Local/Makefile.
29025
29026 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
29027 include files and libraries for GnuTLS can be found.
29028
29029 There are some differences in usage when using GnuTLS instead of OpenSSL:
29030
29031 .ilist
29032 The &%tls_verify_certificates%& option
29033 cannot be the path of a directory
29034 for GnuTLS versions before 3.3.6
29035 (for later versions, or OpenSSL, it can be either).
29036 .next
29037 The default value for &%tls_dhparam%& differs for historical reasons.
29038 .next
29039 .vindex "&$tls_in_peerdn$&"
29040 .vindex "&$tls_out_peerdn$&"
29041 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
29042 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
29043 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
29044 .next
29045 OpenSSL identifies cipher suites using hyphens as separators, for example:
29046 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
29047 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
29048 in a cipher list. To make life simpler, Exim changes underscores to hyphens
29049 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
29050 to handle its own older variants) when processing lists of cipher suites in the
29051 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
29052 option).
29053 .next
29054 The &%tls_require_ciphers%& options operate differently, as described in the
29055 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
29056 .next
29057 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
29058 When using OpenSSL, this option is ignored.
29059 (If an API is found to let OpenSSL be configured in this way,
29060 let the Exim Maintainers know and we'll likely use it).
29061 .next
29062 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
29063 main option, it must be ordered to match the &%tls_certificate%& list.
29064 .next
29065 Some other recently added features may only be available in one or the other.
29066 This should be documented with the feature.  If the documentation does not
29067 explicitly state that the feature is infeasible in the other TLS
29068 implementation, then patches are welcome.
29069 .next
29070 The output from "exim -bV" will show which (if any) support was included
29071 in the build.
29072 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
29073 .endlist
29074
29075
29076 .section "GnuTLS parameter computation" "SECTgnutlsparam"
29077 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
29078 an explicit path; if the latter, then the text about generation still applies,
29079 but not the chosen filename.
29080 By default, as of Exim 4.80 a hard-coded D-H prime is used.
29081 See the documentation of &%tls_dhparam%& for more information.
29082
29083 GnuTLS uses D-H parameters that may take a substantial amount of time
29084 to compute. It is unreasonable to re-compute them for every TLS session.
29085 Therefore, Exim keeps this data in a file in its spool directory, called
29086 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
29087 of bits requested.
29088 The file is owned by the Exim user and is readable only by
29089 its owner. Every Exim process that start up GnuTLS reads the D-H
29090 parameters from this file. If the file does not exist, the first Exim process
29091 that needs it computes the data and writes it to a temporary file which is
29092 renamed once it is complete. It does not matter if several Exim processes do
29093 this simultaneously (apart from wasting a few resources). Once a file is in
29094 place, new Exim processes immediately start using it.
29095
29096 For maximum security, the parameters that are stored in this file should be
29097 recalculated periodically, the frequency depending on your paranoia level.
29098 If you are avoiding using the fixed D-H primes published in RFCs, then you
29099 are concerned about some advanced attacks and will wish to do this; if you do
29100 not regenerate then you might as well stick to the standard primes.
29101
29102 Arranging this is easy in principle; just delete the file when you want new
29103 values to be computed. However, there may be a problem. The calculation of new
29104 parameters needs random numbers, and these are obtained from &_/dev/random_&.
29105 If the system is not very active, &_/dev/random_& may delay returning data
29106 until enough randomness (entropy) is available. This may cause Exim to hang for
29107 a substantial amount of time, causing timeouts on incoming connections.
29108
29109 The solution is to generate the parameters externally to Exim. They are stored
29110 in &_gnutls-params-N_& in PEM format, which means that they can be
29111 generated externally using the &(certtool)& command that is part of GnuTLS.
29112
29113 To replace the parameters with new ones, instead of deleting the file
29114 and letting Exim re-create it, you can generate new parameters using
29115 &(certtool)& and, when this has been done, replace Exim's cache file by
29116 renaming. The relevant commands are something like this:
29117 .code
29118 # ls
29119 [ look for file; assume gnutls-params-2236 is the most recent ]
29120 # rm -f new-params
29121 # touch new-params
29122 # chown exim:exim new-params
29123 # chmod 0600 new-params
29124 # certtool --generate-dh-params --bits 2236 >>new-params
29125 # openssl dhparam -noout -text -in new-params | head
29126 [ check the first line, make sure it's not more than 2236;
29127   if it is, then go back to the start ("rm") and repeat
29128   until the size generated is at most the size requested ]
29129 # chmod 0400 new-params
29130 # mv new-params gnutls-params-2236
29131 .endd
29132 If Exim never has to generate the parameters itself, the possibility of
29133 stalling is removed.
29134
29135 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
29136 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
29137 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
29138 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
29139 and Exim does so.  This attempt to remove Exim from TLS policy decisions
29140 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
29141 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
29142 which applies to all D-H usage, client or server.  If the value returned by
29143 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
29144 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
29145 limit, which is still much higher than Exim historically used.
29146
29147 The filename and bits used will change as the GnuTLS maintainers change the
29148 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
29149 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
29150 2432 bits, while NSS is limited to 2236 bits.
29151
29152 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
29153 increase the chance of the generated prime actually being within acceptable
29154 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
29155 procedure above.  There is no sane procedure available to Exim to double-check
29156 the size of the generated prime, so it might still be too large.
29157
29158
29159 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
29160 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
29161 .oindex "&%tls_require_ciphers%&" "OpenSSL"
29162 There is a function in the OpenSSL library that can be passed a list of cipher
29163 suites before the cipher negotiation takes place. This specifies which ciphers
29164 are acceptable for TLS versions prior to 1.3.
29165 The list is colon separated and may contain names like
29166 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
29167 directly to this function call.
29168 Many systems will install the OpenSSL manual-pages, so you may have
29169 &'ciphers(1)'& available to you.
29170 The following quotation from the OpenSSL
29171 documentation specifies what forms of item are allowed in the cipher string:
29172
29173 .ilist
29174 It can consist of a single cipher suite such as RC4-SHA.
29175 .next
29176 It can represent a list of cipher suites containing a certain algorithm,
29177 or cipher suites of a certain type. For example SHA1 represents all
29178 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
29179 SSL v3 algorithms.
29180 .next
29181 Lists of cipher suites can be combined in a single cipher string using
29182 the + character. This is used as a logical and operation. For example
29183 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29184 algorithms.
29185 .endlist
29186
29187 Each cipher string can be optionally preceded by one of the characters &`!`&,
29188 &`-`& or &`+`&.
29189 .ilist
29190 If &`!`& is used, the ciphers are permanently deleted from the list. The
29191 ciphers deleted can never reappear in the list even if they are explicitly
29192 stated.
29193 .next
29194 If &`-`& is used, the ciphers are deleted from the list, but some or all
29195 of the ciphers can be added again by later options.
29196 .next
29197 If &`+`& is used, the ciphers are moved to the end of the list. This
29198 option does not add any new ciphers; it just moves matching existing ones.
29199 .endlist
29200
29201 If none of these characters is present, the string is interpreted as
29202 a list of ciphers to be appended to the current preference list. If the list
29203 includes any ciphers already present they will be ignored: that is, they will
29204 not be moved to the end of the list.
29205 .endlist
29206
29207 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29208 string:
29209 .code
29210 # note single-quotes to get ! past any shell history expansion
29211 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29212 .endd
29213
29214 This example will let the library defaults be permitted on the MX port, where
29215 there's probably no identity verification anyway, but ups the ante on the
29216 submission ports where the administrator might have some influence on the
29217 choice of clients used:
29218 .code
29219 # OpenSSL variant; see man ciphers(1)
29220 tls_require_ciphers = ${if =={$received_port}{25}\
29221                            {DEFAULT}\
29222                            {HIGH:!MD5:!SHA1}}
29223 .endd
29224
29225 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29226 .code
29227 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29228 .endd
29229
29230 For TLS version 1.3 the control available is less fine-grained
29231 and Exim does not provide access to it at present.
29232 The value of the &%tls_require_ciphers%& option is ignored when
29233 TLS version 1.3 is negotiated.
29234
29235 As of writing the library default cipher suite list for TLSv1.3 is
29236 .code
29237 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29238 .endd
29239
29240
29241 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29242          "SECTreqciphgnu"
29243 .cindex "GnuTLS" "specifying parameters for"
29244 .cindex "TLS" "specifying ciphers (GnuTLS)"
29245 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29246 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29247 .cindex "TLS" "specifying protocols (GnuTLS)"
29248 .cindex "TLS" "specifying priority string (GnuTLS)"
29249 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29250 The GnuTLS library allows the caller to provide a "priority string", documented
29251 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29252 ciphersuite specification in OpenSSL.
29253
29254 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29255 and controls both protocols and ciphers.
29256
29257 The &%tls_require_ciphers%& option is available both as an global option,
29258 controlling how Exim behaves as a server, and also as an option of the
29259 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29260 the value is string expanded.  The resulting string is not an Exim list and
29261 the string is given to the GnuTLS library, so that Exim does not need to be
29262 aware of future feature enhancements of GnuTLS.
29263
29264 Documentation of the strings accepted may be found in the GnuTLS manual, under
29265 "Priority strings".  This is online as
29266 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29267 but beware that this relates to GnuTLS 3, which may be newer than the version
29268 installed on your system.  If you are using GnuTLS 3,
29269 then the example code
29270 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29271 on that site can be used to test a given string.
29272
29273 For example:
29274 .code
29275 # Disable older versions of protocols
29276 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29277 .endd
29278
29279 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29280 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29281 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29282
29283 This example will let the library defaults be permitted on the MX port, where
29284 there's probably no identity verification anyway, and lowers security further
29285 by increasing compatibility; but this ups the ante on the submission ports
29286 where the administrator might have some influence on the choice of clients
29287 used:
29288 .code
29289 # GnuTLS variant
29290 tls_require_ciphers = ${if =={$received_port}{25}\
29291                            {NORMAL:%COMPAT}\
29292                            {SECURE128}}
29293 .endd
29294
29295
29296 .section "Configuring an Exim server to use TLS" "SECID182"
29297 .cindex "TLS" "configuring an Exim server"
29298 .cindex "ESMTP extensions" STARTTLS
29299 When Exim has been built with TLS support, it advertises the availability of
29300 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29301 but not to any others. The default value of this option is *, which means
29302 that STARTTLS is always advertised.  Set it to blank to never advertise;
29303 this is reasonable for systems that want to use TLS only as a client.
29304
29305 If STARTTLS is to be used you
29306 need to set some other options in order to make TLS available.
29307
29308 If a client issues a STARTTLS command and there is some configuration
29309 problem in the server, the command is rejected with a 454 error. If the client
29310 persists in trying to issue SMTP commands, all except QUIT are rejected
29311 with the error
29312 .code
29313 554 Security failure
29314 .endd
29315 If a STARTTLS command is issued within an existing TLS session, it is
29316 rejected with a 554 error code.
29317
29318 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29319 must be set to match some hosts. The default is * which matches all hosts.
29320
29321 If this is all you do, TLS encryption will be enabled but not authentication -
29322 meaning that the peer has no assurance it is actually you he is talking to.
29323 You gain protection from a passive sniffer listening on the wire but not
29324 from someone able to intercept the communication.
29325
29326 Further protection requires some further configuration at the server end.
29327
29328 To make TLS work you need to set, in the server,
29329 .code
29330 tls_certificate = /some/file/name
29331 tls_privatekey = /some/file/name
29332 .endd
29333 These options are, in fact, expanded strings, so you can make them depend on
29334 the identity of the client that is connected if you wish. The first file
29335 contains the server's X509 certificate, and the second contains the private key
29336 that goes with it. These files need to be
29337 PEM format and readable by the Exim user, and must
29338 always be given as full path names.
29339 The key must not be password-protected.
29340 They can be the same file if both the
29341 certificate and the key are contained within it. If &%tls_privatekey%& is not
29342 set, or if its expansion is forced to fail or results in an empty string, this
29343 is assumed to be the case. The certificate file may also contain intermediate
29344 certificates that need to be sent to the client to enable it to authenticate
29345 the server's certificate.
29346
29347 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29348 colon-separated lists of file paths.  Ciphers using given authentication
29349 algorithms require the presence of a suitable certificate to supply the
29350 public-key.  The server selects among the certificates to present to the
29351 client depending on the selected cipher, hence the priority ordering for
29352 ciphers will affect which certificate is used.
29353
29354 If you do not understand about certificates and keys, please try to find a
29355 source of this background information, which is not Exim-specific. (There are a
29356 few comments below in section &<<SECTcerandall>>&.)
29357
29358 &*Note*&: These options do not apply when Exim is operating as a client &--
29359 they apply only in the case of a server. If you need to use a certificate in an
29360 Exim client, you must set the options of the same names in an &(smtp)&
29361 transport.
29362
29363 With just these options, an Exim server will be able to use TLS. It does not
29364 require the client to have a certificate (but see below for how to insist on
29365 this). There is one other option that may be needed in other situations. If
29366 .code
29367 tls_dhparam = /some/file/name
29368 .endd
29369 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29370 with the parameters contained in the file.
29371 Set this to &`none`& to disable use of DH entirely, by making no prime
29372 available:
29373 .code
29374 tls_dhparam = none
29375 .endd
29376 This may also be set to a string identifying a standard prime to be used for
29377 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29378 used is &`ike23`&.  There are a few standard primes available, see the
29379 documentation for &%tls_dhparam%& for the complete list.
29380
29381 See the command
29382 .code
29383 openssl dhparam
29384 .endd
29385 for a way of generating file data.
29386
29387 The strings supplied for these three options are expanded every time a client
29388 host connects. It is therefore possible to use different certificates and keys
29389 for different hosts, if you so wish, by making use of the client's IP address
29390 in &$sender_host_address$& to control the expansion. If a string expansion is
29391 forced to fail, Exim behaves as if the option is not set.
29392
29393 .cindex "cipher" "logging"
29394 .cindex "log" "TLS cipher"
29395 .vindex "&$tls_in_cipher$&"
29396 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29397 an incoming TLS connection. It is included in the &'Received:'& header of an
29398 incoming message (by default &-- you can, of course, change this), and it is
29399 also included in the log line that records a message's arrival, keyed by
29400 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29401 condition can be used to test for specific cipher suites in ACLs.
29402
29403 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29404 can check the name of the cipher suite and vary their actions accordingly. The
29405 cipher suite names vary, depending on which TLS library is being used. For
29406 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29407 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29408 documentation for more details.
29409
29410 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29411 (again depending on the &%tls_cipher%& log selector).
29412
29413
29414 .subsection "Requesting and verifying client certificates"
29415 .cindex "certificate" "verification of client"
29416 .cindex "TLS" "client certificate verification"
29417 If you want an Exim server to request a certificate when negotiating a TLS
29418 session with a client, you must set either &%tls_verify_hosts%& or
29419 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29420 apply to all TLS connections. For any host that matches one of these options,
29421 Exim requests a certificate as part of the setup of the TLS session. The
29422 contents of the certificate are verified by comparing it with a list of
29423 expected trust-anchors or certificates.
29424 These may be the system default set (depending on library version),
29425 an explicit file or,
29426 depending on library version, a directory, identified by
29427 &%tls_verify_certificates%&.
29428
29429 A file can contain multiple certificates, concatenated end to end. If a
29430 directory is used
29431 (OpenSSL only),
29432 each certificate must be in a separate file, with a name (or a symbolic link)
29433 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29434 certificate. You can compute the relevant hash by running the command
29435 .code
29436 openssl x509 -hash -noout -in /cert/file
29437 .endd
29438 where &_/cert/file_& contains a single certificate.
29439
29440 There is no checking of names of the client against the certificate
29441 Subject Name or Subject Alternate Names.
29442
29443 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29444 what happens if the client does not supply a certificate, or if the certificate
29445 does not match any of the certificates in the collection named by
29446 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29447 attempt to set up a TLS session is aborted, and the incoming connection is
29448 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29449 session continues. ACLs that run for subsequent SMTP commands can detect the
29450 fact that no certificate was verified, and vary their actions accordingly. For
29451 example, you can insist on a certificate before accepting a message for
29452 relaying, but not when the message is destined for local delivery.
29453
29454 .vindex "&$tls_in_peerdn$&"
29455 When a client supplies a certificate (whether it verifies or not), the value of
29456 the Distinguished Name of the certificate is made available in the variable
29457 &$tls_in_peerdn$& during subsequent processing of the message.
29458
29459 .cindex "log" "distinguished name"
29460 Because it is often a long text string, it is not included in the log line or
29461 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29462 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29463 &%received_header_text%& to change the &'Received:'& header. When no
29464 certificate is supplied, &$tls_in_peerdn$& is empty.
29465
29466
29467 .subsection "Caching of static server configuration items" "SSECTserverTLScache"
29468 .cindex certificate caching
29469 .cindex privatekey caching
29470 .cindex crl caching
29471 .cindex ocsp caching
29472 .cindex ciphers caching
29473 .cindex "CA bundle" caching
29474 .cindex "certificate authorities" caching
29475 .cindex tls_certificate caching
29476 .cindex tls_privatekey caching
29477 .cindex tls_crl caching
29478 .cindex tls_ocsp_file caching
29479 .cindex tls_require_ciphers caching
29480 .cindex tls_verify_certificate caching
29481 .cindex caching certificate
29482 .cindex caching privatekey
29483 .cindex caching crl
29484 .cindex caching ocsp
29485 .cindex caching ciphers
29486 .cindex caching "certificate authorities
29487 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29488 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29489 expandable elements,
29490 then the associated information is loaded at daemon startup.
29491 It is made available
29492 to child processes forked for handling received SMTP connections.
29493
29494 This caching is currently only supported under Linux and FreeBSD.
29495
29496 If caching is not possible, for example if an item has to be dependent
29497 on the peer host so contains a &$sender_host_name$& expansion, the load
29498 of the associated information is done at the startup of the TLS connection.
29499
29500 The cache is invalidated and reloaded after any changes to the directories
29501 containing files specified by these options.
29502
29503 The information specified by the main option &%tls_verify_certificates%&
29504 is similarly cached so long as it specifies files explicitly
29505 or (under GnuTLS) is the string &"system,cache"&.
29506 The latter case is not automatically invalidated;
29507 it is the operator's responsibility to arrange for a daemon restart
29508 any time the system certificate authority bundle is updated.
29509 A HUP signal is sufficient for this.
29510 The value &"system"& results in no caching under GnuTLS.
29511
29512 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29513 is acceptable in configurations for the Exim executavble.
29514
29515 Caching of the system Certificate Authorities bundle can
29516 save siginificant time and processing on every TLS connection
29517 accepted by Exim.
29518
29519
29520
29521
29522 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29523 .cindex "cipher" "logging"
29524 .cindex "log" "TLS cipher"
29525 .cindex "log" "distinguished name"
29526 .cindex "TLS" "configuring an Exim client"
29527 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29528 deliveries as well as to incoming, the latter one causing logging of the
29529 server certificate's DN. The remaining client configuration for TLS is all
29530 within the &(smtp)& transport.
29531
29532 .cindex "ESMTP extensions" STARTTLS
29533 It is not necessary to set any options to have TLS work in the &(smtp)&
29534 transport. If Exim is built with TLS support, and TLS is advertised by a
29535 server, the &(smtp)& transport always tries to start a TLS session. However,
29536 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29537 transport) to a list of server hosts for which TLS should not be used.
29538
29539 If you do not want Exim to attempt to send messages unencrypted when an attempt
29540 to set up an encrypted connection fails in any way, you can set
29541 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29542 those hosts, delivery is always deferred if an encrypted connection cannot be
29543 set up. If there are any other hosts for the address, they are tried in the
29544 usual way.
29545
29546 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29547 the message unencrypted. It always does this if the response to STARTTLS is
29548 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29549 session after a success response code, what happens is controlled by the
29550 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29551 delivery to this host is deferred, and other hosts (if available) are tried. If
29552 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29553 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29554 negotiation fails, Exim closes the current connection (because it is in an
29555 unknown state), opens a new one to the same host, and then tries the delivery
29556 unencrypted.
29557
29558 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29559 transport provide the client with a certificate, which is passed to the server
29560 if it requests it.
29561 This is an optional thing for TLS connections, although either end
29562 may insist on it.
29563 If the server is Exim, it will request a certificate only if
29564 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29565
29566 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29567 for client use (they are usable for server use).
29568 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29569 in failed connections.
29570
29571 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29572 specifies a collection of expected server certificates.
29573 These may be
29574 the system default set (depending on library version),
29575 a file,
29576 or (depending on library version) a directory.
29577 The client verifies the server's certificate
29578 against this collection, taking into account any revoked certificates that are
29579 in the list defined by &%tls_crl%&.
29580 Failure to verify fails the TLS connection unless either of the
29581 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29582
29583 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29584 certificate verification to the listed servers.  Verification either must
29585 or need not succeed respectively.
29586
29587 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29588 name checks are made on the server certificate.
29589 The match against this list is, as per other Exim usage, the
29590 IP for the host.  That is most closely associated with the
29591 name on the DNS A (or AAAA) record for the host.
29592 However, the name that needs to be in the certificate
29593 is the one at the head of any CNAME chain leading to the A record.
29594 The option defaults to always checking.
29595
29596 The &(smtp)& transport has two OCSP-related options:
29597 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29598 is requested and required for the connection to proceed.  The default
29599 value is empty.
29600 &%hosts_request_ocsp%&; a host-list for which (additionally)
29601 a Certificate Status is requested (but not necessarily verified).  The default
29602 value is "*" meaning that requests are made unless configured
29603 otherwise.
29604
29605 The host(s) should also be in &%hosts_require_tls%&, and
29606 &%tls_verify_certificates%& configured for the transport,
29607 for OCSP to be relevant.
29608
29609 If
29610 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29611 list of permitted cipher suites. If either of these checks fails, delivery to
29612 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29613 alternative hosts, if any.
29614
29615  &*Note*&:
29616 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29617 is operating as a client. Exim does not assume that a server certificate (set
29618 by the global options of the same name) should also be used when operating as a
29619 client.
29620
29621 .vindex "&$host$&"
29622 .vindex "&$host_address$&"
29623 All the TLS options in the &(smtp)& transport are expanded before use, with
29624 &$host$& and &$host_address$& containing the name and address of the server to
29625 which the client is connected. Forced failure of an expansion causes Exim to
29626 behave as if the relevant option were unset.
29627
29628 .vindex &$tls_out_bits$&
29629 .vindex &$tls_out_cipher$&
29630 .vindex &$tls_out_peerdn$&
29631 .vindex &$tls_out_sni$&
29632 Before an SMTP connection is established, the
29633 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29634 variables are emptied. (Until the first connection, they contain the values
29635 that were set when the message was received.) If STARTTLS is subsequently
29636 successfully obeyed, these variables are set to the relevant values for the
29637 outgoing connection.
29638
29639
29640
29641 .subsection "Caching of static client configuration items" SECTclientTLScache
29642 .cindex certificate caching
29643 .cindex privatekey caching
29644 .cindex crl caching
29645 .cindex ciphers caching
29646 .cindex "CA bundle" caching
29647 .cindex "certificate authorities" caching
29648 .cindex tls_certificate caching
29649 .cindex tls_privatekey caching
29650 .cindex tls_crl caching
29651 .cindex tls_require_ciphers caching
29652 .cindex tls_verify_certificate caching
29653 .cindex caching certificate
29654 .cindex caching privatekey
29655 .cindex caching crl
29656 .cindex caching ciphers
29657 .cindex caching "certificate authorities
29658 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29659 and &%tls_crl%& have values with no
29660 expandable elements,
29661 then the associated information is loaded per smtp transport
29662 at daemon startup, at the start of a queue run, or on a
29663 command-line specified message delivery.
29664 It is made available
29665 to child processes forked for handling making SMTP connections.
29666
29667 This caching is currently only supported under Linux.
29668
29669 If caching is not possible, the load
29670 of the associated information is done at the startup of the TLS connection.
29671
29672 The cache is invalidated in the daemon
29673 and reloaded after any changes to the directories
29674 containing files specified by these options.
29675
29676 The information specified by the main option &%tls_verify_certificates%&
29677 is similarly cached so long as it specifies files explicitly
29678 or (under GnuTLS) is the string &"system,cache"&.
29679 The latter case is not automatically invaludated;
29680 it is the operator's responsibility to arrange for a daemon restart
29681 any time the system certificate authority bundle is updated.
29682 A HUP signal is sufficient for this.
29683 The value &"system"& results in no caching under GnuTLS.
29684
29685 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29686 is acceptable in configurations for the Exim executavble.
29687
29688 Caching of the system Certificate Authorities bundle can
29689 save siginificant time and processing on every TLS connection
29690 initiated by Exim.
29691
29692
29693
29694
29695 .section "Use of TLS Server Name Indication" "SECTtlssni"
29696 .cindex "TLS" "Server Name Indication"
29697 .cindex "TLS" SNI
29698 .cindex SNI
29699 .vindex "&$tls_in_sni$&"
29700 .oindex "&%tls_in_sni%&"
29701 With TLS1.0 or above, there is an extension mechanism by which extra
29702 information can be included at various points in the protocol.  One of these
29703 extensions, documented in RFC 6066 (and before that RFC 4366) is
29704 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29705 client in the initial handshake, so that the server can examine the servername
29706 within and possibly choose to use different certificates and keys (and more)
29707 for this session.
29708
29709 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29710 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29711 address.
29712
29713 With SMTP to MX, there are the same problems here as in choosing the identity
29714 against which to validate a certificate: you can't rely on insecure DNS to
29715 provide the identity which you then cryptographically verify.  So this will
29716 be of limited use in that environment.
29717
29718 With SMTP to Submission, there is a well-defined hostname which clients are
29719 connecting to and can validate certificates against.  Thus clients &*can*&
29720 choose to include this information in the TLS negotiation.  If this becomes
29721 wide-spread, then hosters can choose to present different certificates to
29722 different clients.  Or even negotiate different cipher suites.
29723
29724 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29725 if not empty, will be sent on a TLS session as part of the handshake.  There's
29726 nothing more to it.  Choosing a sensible value not derived insecurely is the
29727 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29728 for the lifetime of the client connection (including during authentication).
29729
29730 If DANE validated the connection attempt then the value of the &%tls_sni%& option
29731 is forced to the name of the destination host, after any MX- or CNAME-following.
29732
29733 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29734 received from a client.
29735 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29736
29737 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29738 option (prior to expansion) then the following options will be re-expanded
29739 during TLS session handshake, to permit alternative values to be chosen:
29740
29741 .ilist
29742 &%tls_certificate%&
29743 .next
29744 &%tls_crl%&
29745 .next
29746 &%tls_privatekey%&
29747 .next
29748 &%tls_verify_certificates%&
29749 .next
29750 &%tls_ocsp_file%&
29751 .endlist
29752
29753 Great care should be taken to deal with matters of case, various injection
29754 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29755 can always be referenced; it is important to remember that &$tls_in_sni$& is
29756 arbitrary unverified data provided prior to authentication.
29757 Further, the initial certificate is loaded before SNI has arrived, so
29758 an expansion for &%tls_certificate%& must have a default which is used
29759 when &$tls_in_sni$& is empty.
29760
29761 The Exim developers are proceeding cautiously and so far no other TLS options
29762 are re-expanded.
29763
29764 When Exim is built against OpenSSL, OpenSSL must have been built with support
29765 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29766 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29767 see &`-servername`& in the output, then OpenSSL has support.
29768
29769 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29770 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29771 built, then you have SNI support).
29772
29773 .subsection ALPN
29774 .cindex TLS ALPN
29775 .cindex ALPN "general information"
29776 .cindex TLS "Application Layer Protocol Names"
29777 There is a TLS feature related to SNI
29778 called Application Layer Protocol Name (ALPN).
29779 This is intended to declare, or select, what protocol layer will be using a TLS
29780 connection.
29781 The client for the connection proposes a set of protocol names, and
29782 the server responds with a selected one.
29783 It is not, as of 2021, commonly used for SMTP connections.
29784 However, to guard against misdirected or malicious use of web clients
29785 (which often do use ALPN) against MTA ports, Exim by default check that
29786 there is no incompatible ALPN specified by a client for a TLS connection.
29787 If there is, the connection is rejected.
29788
29789 As a client Exim does not supply ALPN by default.
29790 The behaviour of both client and server can be configured using the options
29791 &%tls_alpn%& and &%hosts_require_alpn%&.
29792 There are no variables providing observability.
29793 Some feature-specific logging may appear on denied connections, but this
29794 depends on the behaviour of the peer
29795 (not all peers can send a feature-specific TLS Alert).
29796
29797 This feature is available when Exim is built with
29798 OpenSSL 1.1.0 or later or GnuTLS 3.2.0 or later;
29799 the macro _HAVE_TLS_ALPN will be defined when this is so.
29800
29801
29802
29803 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29804          "SECTmulmessam"
29805 .cindex "multiple SMTP deliveries with TLS"
29806 .cindex "TLS" "multiple message deliveries"
29807 Exim sends multiple messages down the same TCP/IP connection by starting up
29808 an entirely new delivery process for each message, passing the socket from
29809 one process to the next. This implementation does not fit well with the use
29810 of TLS, because there is quite a lot of state information associated with a TLS
29811 connection, not just a socket identification. Passing all the state information
29812 to a new process is not feasible. Consequently, for sending using TLS Exim
29813 starts an additional proxy process for handling the encryption, piping the
29814 unencrypted data stream from and to the delivery processes.
29815
29816 An older mode of operation can be enabled on a per-host basis by the
29817 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29818 this list the proxy process described above is not used; instead Exim
29819 shuts down an existing TLS session being run by the delivery process
29820 before passing the socket to a new process. The new process may then
29821 try to start a new TLS session, and if successful, may try to re-authenticate
29822 if AUTH is in use, before sending the next message.
29823
29824 The RFC is not clear as to whether or not an SMTP session continues in clear
29825 after TLS has been shut down, or whether TLS may be restarted again later, as
29826 just described. However, if the server is Exim, this shutdown and
29827 reinitialization works. It is not known which (if any) other servers operate
29828 successfully if the client closes a TLS session and continues with unencrypted
29829 SMTP, but there are certainly some that do not work. For such servers, Exim
29830 should not pass the socket to another process, because the failure of the
29831 subsequent attempt to use it would cause Exim to record a temporary host error,
29832 and delay other deliveries to that host.
29833
29834 To test for this case, Exim sends an EHLO command to the server after
29835 closing down the TLS session. If this fails in any way, the connection is
29836 closed instead of being passed to a new delivery process, but no retry
29837 information is recorded.
29838
29839 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29840 &(smtp)& transport to match those hosts for which Exim should not pass
29841 connections to new processes if TLS has been used.
29842
29843
29844
29845
29846 .section "Certificates and all that" "SECTcerandall"
29847 .cindex "certificate" "references to discussion"
29848 In order to understand fully how TLS works, you need to know about
29849 certificates, certificate signing, and certificate authorities.
29850 This is a large topic and an introductory guide is unsuitable for the Exim
29851 reference manual, so instead we provide pointers to existing documentation.
29852
29853 The Apache web-server was for a long time the canonical guide, so their
29854 documentation is a good place to start; their SSL module's Introduction
29855 document is currently at
29856 .display
29857 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29858 .endd
29859 and their FAQ is at
29860 .display
29861 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29862 .endd
29863
29864 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29865 0-201-61598-3) in 2001, contains both introductory and more in-depth
29866 descriptions.
29867 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29868 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29869 Ivan is the author of the popular TLS testing tools at
29870 &url(https://www.ssllabs.com/).
29871
29872
29873 .subsection "Certificate chains" SECID186
29874 A file named by &%tls_certificate%& may contain more than one
29875 certificate. This is useful in the case where the certificate that is being
29876 sent is validated by an intermediate certificate which the other end does
29877 not have. Multiple certificates must be in the correct order in the file.
29878 First the host's certificate itself, then the first intermediate
29879 certificate to validate the issuer of the host certificate, then the next
29880 intermediate certificate to validate the issuer of the first intermediate
29881 certificate, and so on, until finally (optionally) the root certificate.
29882 The root certificate must already be trusted by the recipient for
29883 validation to succeed, of course, but if it's not preinstalled, sending the
29884 root certificate along with the rest makes it available for the user to
29885 install if the receiving end is a client MUA that can interact with a user.
29886
29887 Note that certificates using MD5 are unlikely to work on today's Internet;
29888 even if your libraries allow loading them for use in Exim when acting as a
29889 server, increasingly clients will not accept such certificates.  The error
29890 diagnostics in such a case can be frustratingly vague.
29891
29892
29893
29894 .subsection "Self-signed certificates" SECID187
29895 .cindex "certificate" "self-signed"
29896 You can create a self-signed certificate using the &'req'& command provided
29897 with OpenSSL, like this:
29898 . ==== Do not shorten the duration here without reading and considering
29899 . ==== the text below.  Please leave it at 9999 days.
29900 .code
29901 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29902             -days 9999 -nodes
29903 .endd
29904 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29905 delimited and so can be identified independently. The &%-days%& option
29906 specifies a period for which the certificate is valid. The &%-nodes%& option is
29907 important: if you do not set it, the key is encrypted with a passphrase
29908 that you are prompted for, and any use that is made of the key causes more
29909 prompting for the passphrase. This is not helpful if you are going to use
29910 this certificate and key in an MTA, where prompting is not possible.
29911
29912 . ==== I expect to still be working 26 years from now.  The less technical
29913 . ==== debt I create, in terms of storing up trouble for my later years, the
29914 . ==== happier I will be then.  We really have reached the point where we
29915 . ==== should start, at the very least, provoking thought and making folks
29916 . ==== pause before proceeding, instead of leaving all the fixes until two
29917 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29918 . ==== -pdp, 2012
29919 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29920 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29921 the above command might produce a date in the past.  Think carefully about
29922 the lifetime of the systems you're deploying, and either reduce the duration
29923 of the certificate or reconsider your platform deployment.  (At time of
29924 writing, reducing the duration is the most likely choice, but the inexorable
29925 progression of time takes us steadily towards an era where this will not
29926 be a sensible resolution).
29927
29928 A self-signed certificate made in this way is sufficient for testing, and
29929 may be adequate for all your requirements if you are mainly interested in
29930 encrypting transfers, and not in secure identification.
29931
29932 However, many clients require that the certificate presented by the server be a
29933 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29934 certificate. In this situation, the self-signed certificate described above
29935 must be installed on the client host as a trusted root &'certification
29936 authority'& (CA), and the certificate used by Exim must be a user certificate
29937 signed with that self-signed certificate.
29938
29939 For information on creating self-signed CA certificates and using them to sign
29940 user certificates, see the &'General implementation overview'& chapter of the
29941 Open-source PKI book, available online at
29942 &url(https://sourceforge.net/projects/ospkibook/).
29943
29944
29945 .subsection "Revoked certificates"
29946 .cindex "TLS" "revoked certificates"
29947 .cindex "revocation list"
29948 .cindex "certificate" "revocation list"
29949 .cindex "OCSP" "stapling"
29950 There are three ways for a certificate to be made unusable
29951 before its expiry.
29952
29953 .ilist
29954 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
29955 certificates are revoked. If you have such a list, you can pass it to an Exim
29956 server using the global option called &%tls_crl%& and to an Exim client using
29957 an identically named option for the &(smtp)& transport. In each case, the value
29958 of the option is expanded and must then be the name of a file that contains a
29959 CRL in PEM format.
29960 The downside is that clients have to periodically re-download a potentially huge
29961 file from every certificate authority they know of.
29962
29963 .next
29964 The way with most moving parts at query time is Online Certificate
29965 Status Protocol (OCSP), where the client verifies the certificate
29966 against an OCSP server run by the CA.  This lets the CA track all
29967 usage of the certs.  It requires running software with access to the
29968 private key of the CA, to sign the responses to the OCSP queries.  OCSP
29969 is based on HTTP and can be proxied accordingly.
29970
29971 The only widespread OCSP server implementation (known to this writer)
29972 comes as part of OpenSSL and aborts on an invalid request, such as
29973 connecting to the port and then disconnecting.  This requires
29974 re-entering the passphrase each time some random client does this.
29975
29976 .next
29977 The third way is OCSP Stapling; in this, the server using a certificate
29978 issued by the CA periodically requests an OCSP proof of validity from
29979 the OCSP server, then serves it up inline as part of the TLS
29980 negotiation.   This approach adds no extra round trips, does not let the
29981 CA track users, scales well with number of certs issued by the CA and is
29982 resilient to temporary OCSP server failures, as long as the server
29983 starts retrying to fetch an OCSP proof some time before its current
29984 proof expires.  The downside is that it requires server support.
29985
29986 Unless Exim is built with the support disabled,
29987 or with GnuTLS earlier than version 3.3.16 / 3.4.8
29988 support for OCSP stapling is included.
29989
29990 There is a global option called &%tls_ocsp_file%&.
29991 The file specified therein is expected to be in DER format, and contain
29992 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
29993 option will be re-expanded for SNI, if the &%tls_certificate%& option
29994 contains &`tls_in_sni`&, as per other TLS options.
29995
29996 Exim does not at this time implement any support for fetching a new OCSP
29997 proof.  The burden is on the administrator to handle this, outside of
29998 Exim.  The file specified should be replaced atomically, so that the
29999 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
30000 on each connection, so a new file will be handled transparently on the
30001 next connection.
30002
30003 When built with OpenSSL Exim will check for a valid next update timestamp
30004 in the OCSP proof; if not present, or if the proof has expired, it will be
30005 ignored.
30006
30007 For the client to be able to verify the stapled OCSP the server must
30008 also supply, in its stapled information, any intermediate
30009 certificates for the chain leading to the OCSP proof from the signer
30010 of the server certificate.  There may be zero or one such. These
30011 intermediate certificates should be added to the server OCSP stapling
30012 file named by &%tls_ocsp_file%&.
30013
30014 Note that the proof only covers the terminal server certificate,
30015 not any of the chain from CA to it.
30016
30017 There is no current way to staple a proof for a client certificate.
30018
30019 .code
30020   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
30021   OCSP server is supplied.  The server URL may be included in the
30022   server certificate, if the CA is helpful.
30023
30024   One failure mode seen was the OCSP Signer cert expiring before the end
30025   of validity of the OCSP proof. The checking done by Exim/OpenSSL
30026   noted this as invalid overall, but the re-fetch script did not.
30027 .endd
30028 .endlist
30029
30030
30031 .ecindex IIDencsmtp1
30032 .ecindex IIDencsmtp2
30033
30034
30035 .section "TLS Resumption" "SECTresumption"
30036 .cindex TLS resumption
30037 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
30038 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
30039 (or later).
30040
30041 Session resumption (this is the "stateless" variant) involves the server sending
30042 a "session ticket" to the client on one connection, which can be stored by the
30043 client and used for a later session.  The ticket contains sufficient state for
30044 the server to reconstruct the TLS session, avoiding some expensive crypto
30045 calculation and (on TLS1.2) one full packet roundtrip time.
30046
30047 .ilist
30048 Operational cost/benefit:
30049
30050  The extra data being transmitted costs a minor amount, and the client has
30051  extra costs in storing and retrieving the data.
30052
30053  In the Exim/Gnutls implementation the extra cost on an initial connection
30054  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
30055  The saved cost on a subsequent connection is about 4ms; three or more
30056  connections become a net win.  On longer network paths, two or more
30057  connections will have an average lower startup time thanks to the one
30058  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
30059  packet roundtrips.
30060
30061 .cindex "hints database" tls
30062  Since a new hints DB is used on the TLS client,
30063  the hints DB maintenance should be updated to additionally handle "tls".
30064
30065 .next
30066 Security aspects:
30067
30068  The session ticket is encrypted, but is obviously an additional security
30069  vulnarability surface.  An attacker able to decrypt it would have access
30070  all connections using the resumed session.
30071  The session ticket encryption key is not committed to storage by the server
30072  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
30073  overlap; GnuTLS 6hr but does not specify any overlap).
30074  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
30075  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
30076
30077  There is a question-mark over the security of the Diffie-Helman parameters
30078  used for session negotiation.
30079
30080 .next
30081 Observability:
30082
30083  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
30084  element.
30085
30086  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
30087  have bits 0-4 indicating respectively
30088  support built, client requested ticket, client offered session,
30089  server issued ticket, resume used.  A suitable decode list is provided
30090  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
30091
30092 .next
30093 Control:
30094
30095 The &%tls_resumption_hosts%& main option specifies a hostlist for which
30096 exim, operating as a server, will offer resumption to clients.
30097 Current best practice is to not offer the feature to MUA connection.
30098 Commonly this can be done like this:
30099 .code
30100 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
30101 .endd
30102 If the peer host matches the list after expansion then resumption
30103 is offered and/or accepted.
30104
30105 The &%tls_resumption_hosts%& smtp transport option performs the
30106 equivalent function for operation as a client.
30107 If the peer host matches the list after expansion then resumption
30108 is attempted (if a stored session is available) or the information
30109 stored (if supplied by the peer).
30110
30111
30112 .next
30113 Issues:
30114
30115  In a resumed session:
30116 .ilist
30117   The variables &$tls_{in,out}_cipher$& will have values different
30118  to the original (under GnuTLS).
30119 .next
30120   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
30121  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
30122 . XXX need to do something with that hosts_require_ocsp
30123 .endlist
30124
30125 .endlist
30126
30127
30128 .section DANE "SECDANE"
30129 .cindex DANE
30130 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
30131 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
30132 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
30133 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
30134 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
30135 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
30136
30137 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
30138 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
30139 by (a) is thought to be smaller than that of the set of root CAs.
30140
30141 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
30142 fail to pass on a server's STARTTLS.
30143
30144 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
30145 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
30146 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
30147
30148 DANE requires a server operator to do three things:
30149 .olist
30150 Run DNSSEC.  This provides assurance to clients
30151 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
30152 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
30153 DNSSEC.
30154 .next
30155 Add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
30156 .next
30157 Offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
30158 .endlist
30159
30160 There are no changes to Exim specific to server-side operation of DANE.
30161 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
30162 in &_Local/Makefile_&.
30163 If it has been included, the macro "_HAVE_DANE" will be defined.
30164
30165 .subsection "DNS records"
30166 A TLSA record consist of 4 fields, the "Certificate Usage", the
30167 "Selector", the "Matching type", and the "Certificate Association Data".
30168 For a detailed description of the TLSA record see
30169 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
30170
30171 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
30172 These are the "Trust Anchor" and "End Entity" variants.
30173 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
30174 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
30175 this is appropriate for a single system, using a self-signed certificate.
30176 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
30177 well-known one.
30178 A private CA at simplest is just a self-signed certificate (with certain
30179 attributes) which is used to sign server certificates, but running one securely
30180 does require careful arrangement.
30181 With DANE-TA, as implemented in Exim and commonly in other MTAs,
30182 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
30183 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
30184 all of which point to a single TLSA record.
30185 DANE-TA and DANE-EE can both be used together.
30186
30187 Our recommendation is to use DANE with a certificate from a public CA,
30188 because this enables a variety of strategies for remote clients to verify
30189 your certificate.
30190 You can then publish information both via DANE and another technology,
30191 "MTA-STS", described below.
30192
30193 When you use DANE-TA to publish trust anchor information, you ask entities
30194 outside your administrative control to trust the Certificate Authority for
30195 connections to you.
30196 If using a private CA then you should expect others to still apply the
30197 technical criteria they'd use for a public CA to your certificates.
30198 In particular, you should probably try to follow current best practices for CA
30199 operation around hash algorithms and key sizes.
30200 Do not expect other organizations to lower their security expectations just
30201 because a particular profile might be reasonable for your own internal use.
30202
30203 When this text was last updated, this in practice means to avoid use of SHA-1
30204 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
30205 than 4096, for interoperability); to use keyUsage fields correctly; to use
30206 random serial numbers.
30207 The list of requirements is subject to change as best practices evolve.
30208 If you're not already using a private CA, or it doesn't meet these
30209 requirements, then we encourage you to avoid all these issues and use a public
30210 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
30211
30212 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
30213 a "Matching Type" (3rd) field of SHA2-512(2).
30214
30215 For the "Certificate Authority Data" (4th) field, commands like
30216
30217 .code
30218   openssl x509 -pubkey -noout <certificate.pem \
30219   | openssl rsa -outform der -pubin 2>/dev/null \
30220   | openssl sha512 \
30221   | awk '{print $2}'
30222 .endd
30223
30224 are workable to create a hash of the certificate's public key.
30225
30226 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30227
30228 .code
30229   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30230 .endd
30231
30232 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30233 is useful for quickly generating TLSA records.
30234
30235
30236 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30237
30238 The Certificate issued by the CA published in the DANE-TA model should be
30239 issued using a strong hash algorithm.
30240 Exim, and importantly various other MTAs sending to you, will not
30241 re-enable hash algorithms which have been disabled by default in TLS
30242 libraries.
30243 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30244 interoperability (and probably the maximum too, in 2018).
30245
30246 .subsection "Interaction with OCSP"
30247 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30248 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30249 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30250
30251 .code
30252   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30253                                  {= {4}{$tls_out_tlsa_usage}} } \
30254                          {*}{}}
30255 .endd
30256
30257 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30258 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30259 found. If the definition of &%hosts_request_ocsp%& includes the
30260 string "tls_out_tlsa_usage", they are re-expanded in time to
30261 control the OCSP request.
30262
30263 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30264 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30265
30266
30267 .subsection "Client configuration"
30268 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30269 and &%dane_require_tls_ciphers%&.
30270 The &"require"& variant will result in failure if the target host is not
30271 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30272 the &%dnssec_request_domains%& router or transport option.
30273
30274 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30275
30276 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using DNSSEC.
30277 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30278 will be required for the host.  If it does not, the host will not
30279 be used; there is no fallback to non-DANE or non-TLS.
30280
30281 If DANE is requested and usable, then the TLS cipher list configuration
30282 prefers to use the option &%dane_require_tls_ciphers%& and falls
30283 back to &%tls_require_ciphers%& only if that is unset.
30284 This lets you configure "decent crypto" for DANE and "better than nothing
30285 crypto" as the default.  Note though that while GnuTLS lets the string control
30286 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30287 limited to ciphersuite constraints.
30288
30289 If DANE is requested and useable (see above) the following transport options are ignored:
30290 .code
30291   hosts_require_tls
30292   tls_verify_hosts
30293   tls_try_verify_hosts
30294   tls_verify_certificates
30295   tls_crl
30296   tls_verify_cert_hostnames
30297   tls_sni
30298 .endd
30299
30300 If DANE is not usable, whether requested or not, and CA-anchored
30301 verification evaluation is wanted, the above variables should be set appropriately.
30302
30303 The router and transport option &%dnssec_request_domains%& must not be
30304 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30305
30306 .subsection Observability
30307 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30308
30309 There is a new variable &$tls_out_dane$& which will have "yes" if
30310 verification succeeded using DANE and "no" otherwise (only useful
30311 in combination with events; see &<<CHAPevents>>&),
30312 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30313
30314 .cindex DANE reporting
30315 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30316 to achieve DANE-verified connection, if one was either requested and offered, or
30317 required.  This is intended to support TLS-reporting as defined in
30318 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30319 The &$event_data$& will be one of the Result Types defined in
30320 Section 4.3 of that document.
30321
30322 .subsection General
30323 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30324
30325 DANE is specified in published RFCs and decouples certificate authority trust
30326 selection from a "race to the bottom" of "you must trust everything for mail
30327 to get through".
30328 There is an alternative technology called MTA-STS, which
30329 instead publishes MX trust anchor information on an HTTPS website.  At the
30330 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
30331 Exim has no support for MTA-STS as a client, but Exim mail server operators
30332 can choose to publish information describing their TLS configuration using
30333 MTA-STS to let those clients who do use that protocol derive trust
30334 information.
30335
30336 The MTA-STS design requires a certificate from a public Certificate Authority
30337 which is recognized by clients sending to you.
30338 That selection of which CAs are trusted by others is outside your control.
30339
30340 The most interoperable course of action is probably to use
30341 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30342 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30343 records for DANE clients (such as Exim and Postfix) and to publish anchor
30344 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30345 domain itself (with caveats around occasionally broken MTA-STS because of
30346 incompatible specification changes prior to reaching RFC status).
30347
30348
30349
30350 . ////////////////////////////////////////////////////////////////////////////
30351 . ////////////////////////////////////////////////////////////////////////////
30352
30353 .chapter "Access control lists" "CHAPACL"
30354 .scindex IIDacl "&ACL;" "description"
30355 .cindex "control of incoming mail"
30356 .cindex "message" "controlling incoming"
30357 .cindex "policy control" "access control lists"
30358 Access Control Lists (ACLs) are defined in a separate section of the runtime
30359 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30360 name, terminated by a colon. Here is a complete ACL section that contains just
30361 one very small ACL:
30362 .code
30363 begin acl
30364 small_acl:
30365   accept   hosts = one.host.only
30366 .endd
30367 You can have as many lists as you like in the ACL section, and the order in
30368 which they appear does not matter. The lists are self-terminating.
30369
30370 The majority of ACLs are used to control Exim's behaviour when it receives
30371 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30372 when a local process submits a message using SMTP by specifying the &%-bs%&
30373 option. The most common use is for controlling which recipients are accepted
30374 in incoming messages. In addition, you can define an ACL that is used to check
30375 local non-SMTP messages. The default configuration file contains an example of
30376 a realistic ACL for checking RCPT commands. This is discussed in chapter
30377 &<<CHAPdefconfil>>&.
30378
30379
30380 .section "Testing ACLs" "SECID188"
30381 The &%-bh%& command line option provides a way of testing your ACL
30382 configuration locally by running a fake SMTP session with which you interact.
30383
30384
30385 .section "Specifying when ACLs are used" "SECID189"
30386 .cindex "&ACL;" "options for specifying"
30387 In order to cause an ACL to be used, you have to name it in one of the relevant
30388 options in the main part of the configuration. These options are:
30389 .cindex "AUTH" "ACL for"
30390 .cindex "DATA" "ACLs for"
30391 .cindex "ETRN" "ACL for"
30392 .cindex "EXPN" "ACL for"
30393 .cindex "HELO" "ACL for"
30394 .cindex "EHLO" "ACL for"
30395 .cindex "DKIM" "ACL for"
30396 .cindex "MAIL" "ACL for"
30397 .cindex "QUIT, ACL for"
30398 .cindex "RCPT" "ACL for"
30399 .cindex "STARTTLS, ACL for"
30400 .cindex "VRFY" "ACL for"
30401 .cindex "SMTP" "connection, ACL for"
30402 .cindex "non-SMTP messages" "ACLs for"
30403 .cindex "MIME content scanning" "ACL for"
30404 .cindex "PRDR" "ACL for"
30405
30406 .table2 140pt
30407 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30408 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30409 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30410 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30411 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30412 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30413 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30414 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30415 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30416 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30417 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30418 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30419 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30420 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30421 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30422 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30423 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30424 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30425 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30426 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30427 .endtable
30428
30429 For example, if you set
30430 .code
30431 acl_smtp_rcpt = small_acl
30432 .endd
30433 the little ACL defined above is used whenever Exim receives a RCPT command
30434 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30435 done when RCPT commands arrive. A rejection of RCPT should cause the
30436 sending MTA to give up on the recipient address contained in the RCPT
30437 command, whereas rejection at other times may cause the client MTA to keep on
30438 trying to deliver the message. It is therefore recommended that you do as much
30439 testing as possible at RCPT time.
30440
30441
30442 .subsection "The non-SMTP ACLs" SECID190
30443 .cindex "non-SMTP messages" "ACLs for"
30444 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30445 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30446 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30447 the state of the SMTP connection such as encryption and authentication) are not
30448 relevant and are forbidden in these ACLs. However, the sender and recipients
30449 are known, so the &%senders%& and &%sender_domains%& conditions and the
30450 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30451 &$authenticated_sender$& are also available. You can specify added header lines
30452 in any of these ACLs.
30453
30454 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30455 non-SMTP message, before any of the message has been read. (This is the
30456 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30457 batched SMTP input, it runs after the DATA command has been reached. The
30458 result of this ACL is ignored; it cannot be used to reject a message. If you
30459 really need to, you could set a value in an ACL variable here and reject based
30460 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30461 controls, and in particular, it can be used to set
30462 .code
30463 control = suppress_local_fixups
30464 .endd
30465 This cannot be used in the other non-SMTP ACLs because by the time they are
30466 run, it is too late.
30467
30468 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30469 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30470
30471 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30472 kind of rejection is treated as permanent, because there is no way of sending a
30473 temporary error for these kinds of message.
30474
30475
30476 .subsection "The SMTP connect ACL" SECID191
30477 .cindex "SMTP" "connection, ACL for"
30478 .oindex &%smtp_banner%&
30479 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30480 session, after the test specified by &%host_reject_connection%& (which is now
30481 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30482 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30483 the message override the banner message that is otherwise specified by the
30484 &%smtp_banner%& option.
30485
30486 For tls-on-connect connections, the ACL is run after the TLS connection
30487 is accepted (however, &%host_reject_connection%& is tested before).
30488
30489
30490 .subsection "The EHLO/HELO ACL" SECID192
30491 .cindex "EHLO" "ACL for"
30492 .cindex "HELO" "ACL for"
30493 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30494 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30495 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30496 Note that a client may issue more than one EHLO or HELO command in an SMTP
30497 session, and indeed is required to issue a new EHLO or HELO after successfully
30498 setting up encryption following a STARTTLS command.
30499
30500 Note also that a deny neither forces the client to go away nor means that
30501 mail will be refused on the connection.  Consider checking for
30502 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30503
30504 If the command is accepted by an &%accept%& verb that has a &%message%&
30505 modifier, the message may not contain more than one line (it will be truncated
30506 at the first newline and a panic logged if it does). Such a message cannot
30507 affect the EHLO options that are listed on the second and subsequent lines of
30508 an EHLO response.
30509
30510
30511 .subsection "The DATA ACLs" SECID193
30512 .cindex "DATA" "ACLs for"
30513 Two ACLs are associated with the DATA command, because it is two-stage
30514 command, with two responses being sent to the client.
30515 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30516 is obeyed. This gives you control after all the RCPT commands, but before
30517 the message itself is received. It offers the opportunity to give a negative
30518 response to the DATA command before the data is transmitted. Header lines
30519 added by MAIL or RCPT ACLs are not visible at this time, but any that
30520 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30521
30522 You cannot test the contents of the message, for example, to verify addresses
30523 in the headers, at RCPT time or when the DATA command is received. Such
30524 tests have to appear in the ACL that is run after the message itself has been
30525 received, before the final response to the DATA command is sent. This is
30526 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30527 associated with the DATA command.
30528
30529 .cindex CHUNKING "BDAT command"
30530 .cindex BDAT "SMTP command"
30531 .cindex "RFC 3030" CHUNKING
30532 If CHUNKING was advertised and a BDAT command sequence is received,
30533 the &%acl_smtp_predata%& ACL is not run.
30534 . XXX why not?  It should be possible, for the first BDAT.
30535 The &%acl_smtp_data%& is run after the last BDAT command and all of
30536 the data specified is received.
30537
30538 For both of these ACLs, it is not possible to reject individual recipients. An
30539 error response rejects the entire message. Unfortunately, it is known that some
30540 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30541 before or after the data) correctly &-- they keep the message on their queues
30542 and try again later, but that is their problem, though it does waste some of
30543 your resources.
30544
30545 The &%acl_smtp_data%& ACL is run after
30546 the &%acl_smtp_data_prdr%&,
30547 the &%acl_smtp_dkim%&
30548 and the &%acl_smtp_mime%& ACLs.
30549
30550 .subsection "The SMTP DKIM ACL" SECTDKIMACL
30551 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30552 enabled (which is the default).
30553
30554 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30555 received, and is executed for each DKIM signature found in a message.  If not
30556 otherwise specified, the default action is to accept.
30557
30558 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30559
30560 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30561
30562
30563 .subsection "The SMTP MIME ACL" SECID194
30564 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30565 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30566
30567 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30568
30569
30570 .subsection "The SMTP PRDR ACL" SECTPRDRACL
30571 .cindex "PRDR" "ACL for"
30572 .oindex "&%prdr_enable%&"
30573 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30574 with PRDR support enabled (which is the default).
30575 It becomes active only when the PRDR feature is negotiated between
30576 client and server for a message, and more than one recipient
30577 has been accepted.
30578
30579 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30580 has been received, and is executed once for each recipient of the message
30581 with &$local_part$& and &$domain$& valid.
30582 The test may accept, defer or deny for individual recipients.
30583 The &%acl_smtp_data%& will still be called after this ACL and
30584 can reject the message overall, even if this ACL has accepted it
30585 for some or all recipients.
30586
30587 PRDR may be used to support per-user content filtering.  Without it
30588 one must defer any recipient after the first that has a different
30589 content-filter configuration.  With PRDR, the RCPT-time check
30590 .cindex "PRDR" "variable for"
30591 for this can be disabled when the variable &$prdr_requested$&
30592 is &"yes"&.
30593 Any required difference in behaviour of the main DATA-time
30594 ACL should however depend on the PRDR-time ACL having run, as Exim
30595 will avoid doing so in some situations (e.g. single-recipient mails).
30596
30597 See also the &%prdr_enable%& global option
30598 and the &%hosts_try_prdr%& smtp transport option.
30599
30600 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30601 If the ACL is not defined, processing completes as if
30602 the feature was not requested by the client.
30603
30604 .subsection "The QUIT ACL" SECTQUITACL
30605 .cindex "QUIT, ACL for"
30606 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30607 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30608 does not in fact control any access.
30609 For this reason, it may only accept
30610 or warn as its final result.
30611
30612 This ACL can be used for tasks such as custom logging at the end of an SMTP
30613 session. For example, you can use ACL variables in other ACLs to count
30614 messages, recipients, etc., and log the totals at QUIT time using one or
30615 more &%logwrite%& modifiers on a &%warn%& verb.
30616
30617 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30618 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30619
30620 You do not need to have a final &%accept%&, but if you do, you can use a
30621 &%message%& modifier to specify custom text that is sent as part of the 221
30622 response to QUIT.
30623
30624 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30625 failure (for example, failure to open a log file, or when Exim is bombing out
30626 because it has detected an unrecoverable error), all SMTP commands from the
30627 client are given temporary error responses until QUIT is received or the
30628 connection is closed. In these special cases, the QUIT ACL does not run.
30629
30630
30631 .subsection "The not-QUIT ACL" SECTNOTQUITACL
30632 .vindex &$acl_smtp_notquit$&
30633 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30634 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30635 trouble, such as being unable to write to its log files, this ACL is not run,
30636 because it might try to do things (such as write to log files) that make the
30637 situation even worse.
30638
30639 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30640 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30641 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30642 and &%warn%&.
30643
30644 .vindex &$smtp_notquit_reason$&
30645 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30646 to a string that indicates the reason for the termination of the SMTP
30647 connection. The possible values are:
30648 .table2
30649 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30650 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30651 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30652 .irow &`connection-lost`&          "The SMTP connection has been lost"
30653 .irow &`data-timeout`&             "Timeout while reading message data"
30654 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30655 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30656 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30657 .irow &`synchronization-error`&    "SMTP synchronization error"
30658 .irow &`tls-failed`&               "TLS failed to start"
30659 .endtable
30660 In most cases when an SMTP connection is closed without having received QUIT,
30661 Exim sends an SMTP response message before actually closing the connection.
30662 With the exception of the &`acl-drop`& case, the default message can be
30663 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30664 &%drop%& verb in another ACL, it is the message from the other ACL that is
30665 used.
30666
30667
30668 .section "Finding an ACL to use" "SECID195"
30669 .cindex "&ACL;" "finding which to use"
30670 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30671 you can use different ACLs in different circumstances. For example,
30672 .code
30673 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30674                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30675 .endd
30676 In the default configuration file there are some example settings for
30677 providing an RFC 4409 message &"submission"& service on port 587 and
30678 an RFC 8314 &"submissions"& service on port 465. You can use a string
30679 expansion like this to choose an ACL for MUAs on these ports which is
30680 more appropriate for this purpose than the default ACL on port 25.
30681
30682 The expanded string does not have to be the name of an ACL in the
30683 configuration file; there are other possibilities. Having expanded the
30684 string, Exim searches for an ACL as follows:
30685
30686 .ilist
30687 If the string begins with a slash, Exim uses it as a filename, and reads its
30688 contents as an ACL. The lines are processed in the same way as lines in the
30689 Exim configuration file. In particular, continuation lines are supported, blank
30690 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30691 If the file does not exist or cannot be read, an error occurs (typically
30692 causing a temporary failure of whatever caused the ACL to be run). For example:
30693 .code
30694 acl_smtp_data = /etc/acls/\
30695   ${lookup{$sender_host_address}lsearch\
30696   {/etc/acllist}{$value}{default}}
30697 .endd
30698 This looks up an ACL file to use on the basis of the host's IP address, falling
30699 back to a default if the lookup fails. If an ACL is successfully read from a
30700 file, it is retained in memory for the duration of the Exim process, so that it
30701 can be re-used without having to re-read the file.
30702 .next
30703 If the string does not start with a slash, and does not contain any spaces,
30704 Exim searches the ACL section of the configuration for an ACL whose name
30705 matches the string.
30706 .next
30707 If no named ACL is found, or if the string contains spaces, Exim parses
30708 the string as an inline ACL. This can save typing in cases where you just
30709 want to have something like
30710 .code
30711 acl_smtp_vrfy = accept
30712 .endd
30713 in order to allow free use of the VRFY command. Such a string may contain
30714 newlines; it is processed in the same way as an ACL that is read from a file.
30715 .endlist
30716
30717
30718
30719
30720 .section "ACL return codes" "SECID196"
30721 .cindex "&ACL;" "return codes"
30722 Except for the QUIT ACL, which does not affect the SMTP return code (see
30723 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30724 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30725 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30726 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30727 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30728 This also causes a 4&'xx'& return code.
30729
30730 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30731 &"deny"&, because there is no mechanism for passing temporary errors to the
30732 submitters of non-SMTP messages.
30733
30734
30735 ACLs that are relevant to message reception may also return &"discard"&. This
30736 has the effect of &"accept"&, but causes either the entire message or an
30737 individual recipient address to be discarded. In other words, it is a
30738 blackholing facility. Use it with care.
30739
30740 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30741 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30742 RCPT ACL is to discard just the one recipient address. If there are no
30743 recipients left when the message's data is received, the DATA ACL is not
30744 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30745 remaining recipients. The &"discard"& return is not permitted for the
30746 &%acl_smtp_predata%& ACL.
30747
30748 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30749 is done on the address and the result determines the SMTP response.
30750
30751
30752 .cindex "&[local_scan()]& function" "when all recipients discarded"
30753 The &[local_scan()]& function is always run, even if there are no remaining
30754 recipients; it may create new recipients.
30755
30756
30757
30758 .section "Unset ACL options" "SECID197"
30759 .cindex "&ACL;" "unset options"
30760 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30761 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30762 not defined at all. For any defined ACL, the default action when control
30763 reaches the end of the ACL statements is &"deny"&.
30764
30765 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30766 these two are ACLs that are used only for their side effects. They cannot be
30767 used to accept or reject anything.
30768
30769 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30770 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30771 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30772 when the ACL is not defined is &"accept"&.
30773
30774 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30775 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30776 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30777 messages over an SMTP connection. For an example, see the ACL in the default
30778 configuration file.
30779
30780
30781
30782
30783 .section "Data for message ACLs" "SECID198"
30784 .cindex "&ACL;" "data for message ACL"
30785 .vindex &$domain$&
30786 .vindex &$local_part$&
30787 .vindex &$sender_address$&
30788 .vindex &$sender_host_address$&
30789 .vindex &$smtp_command$&
30790 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30791 that contain information about the host and the message's sender (for example,
30792 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30793 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30794 &$local_part$& are set from the argument address. The entire SMTP command
30795 is available in &$smtp_command$&.
30796
30797 When an ACL for the AUTH parameter of MAIL is running, the variables that
30798 contain information about the host are set, but &$sender_address$& is not yet
30799 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30800 how it is used.
30801
30802 .vindex "&$message_size$&"
30803 The &$message_size$& variable is set to the value of the SIZE parameter on
30804 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30805 that parameter is not given. The value is updated to the true message size by
30806 the time the final DATA ACL is run (after the message data has been
30807 received).
30808
30809 .vindex "&$rcpt_count$&"
30810 .vindex "&$recipients_count$&"
30811 The &$rcpt_count$& variable increases by one for each RCPT command received.
30812 The &$recipients_count$& variable increases by one each time a RCPT command is
30813 accepted, so while an ACL for RCPT is being processed, it contains the number
30814 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30815 &$rcpt_count$& contains the total number of RCPT commands, and
30816 &$recipients_count$& contains the total number of accepted recipients.
30817
30818
30819
30820
30821
30822 .section "Data for non-message ACLs" "SECTdatfornon"
30823 .cindex "&ACL;" "data for non-message ACL"
30824 .vindex &$smtp_command_argument$&
30825 .vindex &$smtp_command$&
30826 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30827 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30828 and the entire SMTP command is available in &$smtp_command$&.
30829 These variables can be tested using a &%condition%& condition. For example,
30830 here is an ACL for use with AUTH, which insists that either the session is
30831 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30832 does not permit authentication methods that use cleartext passwords on
30833 unencrypted connections.
30834 .code
30835 acl_check_auth:
30836   accept encrypted = *
30837   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30838                      {CRAM-MD5}}
30839   deny   message   = TLS encryption or CRAM-MD5 required
30840 .endd
30841 (Another way of applying this restriction is to arrange for the authenticators
30842 that use cleartext passwords not to be advertised when the connection is not
30843 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30844 option to do this.)
30845
30846
30847
30848 .section "Format of an ACL" "SECID199"
30849 .cindex "&ACL;" "format of"
30850 .cindex "&ACL;" "verbs, definition of"
30851 An individual ACL consists of a number of statements. Each statement starts
30852 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30853 Modifiers can change the way the verb operates, define error and log messages,
30854 set variables, insert delays, and vary the processing of accepted messages.
30855
30856 If all the conditions are met, the verb is obeyed. The same condition may be
30857 used (with different arguments) more than once in the same statement. This
30858 provides a means of specifying an &"and"& conjunction between conditions. For
30859 example:
30860 .code
30861 deny  dnslists = list1.example
30862       dnslists = list2.example
30863 .endd
30864 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30865 the conditions and modifiers when it reaches a condition that fails. What
30866 happens then depends on the verb (and in one case, on a special modifier). Not
30867 all the conditions make sense at every testing point. For example, you cannot
30868 test a sender address in the ACL that is run for a VRFY command.
30869
30870
30871 .section "ACL verbs" "SECID200"
30872 The ACL verbs are as follows:
30873
30874 .ilist
30875 .cindex "&%accept%& ACL verb"
30876 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
30877 of the conditions are not met, what happens depends on whether &%endpass%&
30878 appears among the conditions (for syntax see below). If the failing condition
30879 is before &%endpass%&, control is passed to the next ACL statement; if it is
30880 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
30881 check a RCPT command:
30882 .code
30883 accept domains = +local_domains
30884        endpass
30885        verify = recipient
30886 .endd
30887 If the recipient domain does not match the &%domains%& condition, control
30888 passes to the next statement. If it does match, the recipient is verified, and
30889 the command is accepted if verification succeeds. However, if verification
30890 fails, the ACL yields &"deny"&, because the failing condition is after
30891 &%endpass%&.
30892
30893 The &%endpass%& feature has turned out to be confusing to many people, so its
30894 use is not recommended nowadays. It is always possible to rewrite an ACL so
30895 that &%endpass%& is not needed, and it is no longer used in the default
30896 configuration.
30897
30898 .cindex "&%message%& ACL modifier" "with &%accept%&"
30899 If a &%message%& modifier appears on an &%accept%& statement, its action
30900 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
30901 (when an &%accept%& verb either accepts or passes control to the next
30902 statement), &%message%& can be used to vary the message that is sent when an
30903 SMTP command is accepted. For example, in a RCPT ACL you could have:
30904 .display
30905 &`accept  `&<&'some conditions'&>
30906 &`        message = OK, I will allow you through today`&
30907 .endd
30908 You can specify an SMTP response code, optionally followed by an &"extended
30909 response code"& at the start of the message, but the first digit must be the
30910 same as would be sent by default, which is 2 for an &%accept%& verb.
30911
30912 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
30913 an error message that is used when access is denied. This behaviour is retained
30914 for backward compatibility, but current &"best practice"& is to avoid the use
30915 of &%endpass%&.
30916
30917
30918 .next
30919 .cindex "&%defer%& ACL verb"
30920 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
30921 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
30922 &%defer%& is the same as &%deny%&, because there is no way of sending a
30923 temporary error. For a RCPT command, &%defer%& is much the same as using a
30924 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
30925 be used in any ACL, and even for a recipient it might be a simpler approach.
30926
30927
30928 .next
30929 .cindex "&%deny%& ACL verb"
30930 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
30931 the conditions are not met, control is passed to the next ACL statement. For
30932 example,
30933 .code
30934 deny dnslists = blackholes.mail-abuse.org
30935 .endd
30936 rejects commands from hosts that are on a DNS black list.
30937
30938
30939 .next
30940 .cindex "&%discard%& ACL verb"
30941 &%discard%&: This verb behaves like &%accept%&, except that it returns
30942 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
30943 that are concerned with receiving messages. When all the conditions are true,
30944 the sending entity receives a &"success"& response. However, &%discard%& causes
30945 recipients to be discarded. If it is used in an ACL for RCPT, just the one
30946 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
30947 message's recipients are discarded. Recipients that are discarded before DATA
30948 do not appear in the log line when the &%received_recipients%& log selector is set.
30949
30950 If the &%log_message%& modifier is set when &%discard%& operates,
30951 its contents are added to the line that is automatically written to the log.
30952 The &%message%& modifier operates exactly as it does for &%accept%&.
30953
30954
30955 .next
30956 .cindex "&%drop%& ACL verb"
30957 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
30958 forcibly closed after the 5&'xx'& error message has been sent. For example:
30959 .code
30960 drop   condition = ${if > {$rcpt_count}{20}}
30961        message   = I don't take more than 20 RCPTs
30962 .endd
30963 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
30964 The connection is always dropped after sending a 550 response.
30965
30966 .next
30967 .cindex "&%require%& ACL verb"
30968 &%require%&: If all the conditions are met, control is passed to the next ACL
30969 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
30970 example, when checking a RCPT command,
30971 .code
30972 require message = Sender did not verify
30973         verify  = sender
30974 .endd
30975 passes control to subsequent statements only if the message's sender can be
30976 verified. Otherwise, it rejects the command. Note the positioning of the
30977 &%message%& modifier, before the &%verify%& condition. The reason for this is
30978 discussed in section &<<SECTcondmodproc>>&.
30979
30980 .next
30981 .cindex "&%warn%& ACL verb"
30982 &%warn%&: If all the conditions are true, a line specified by the
30983 &%log_message%& modifier is written to Exim's main log. Control always passes
30984 to the next ACL statement. If any condition is false, the log line is not
30985 written. If an identical log line is requested several times in the same
30986 message, only one copy is actually written to the log. If you want to force
30987 duplicates to be written, use the &%logwrite%& modifier instead.
30988
30989 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
30990 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
30991 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
30992 first failing condition. There is more about adding header lines in section
30993 &<<SECTaddheadacl>>&.
30994
30995 If any condition on a &%warn%& statement cannot be completed (that is, there is
30996 some sort of defer), the log line specified by &%log_message%& is not written.
30997 This does not include the case of a forced failure from a lookup, which
30998 is considered to be a successful completion. After a defer, no further
30999 conditions or modifiers in the &%warn%& statement are processed. The incident
31000 is logged, and the ACL continues to be processed, from the next statement
31001 onwards.
31002
31003
31004 .vindex "&$acl_verify_message$&"
31005 When one of the &%warn%& conditions is an address verification that fails, the
31006 text of the verification failure message is in &$acl_verify_message$&. If you
31007 want this logged, you must set it up explicitly. For example:
31008 .code
31009 warn   !verify = sender
31010        log_message = sender verify failed: $acl_verify_message
31011 .endd
31012 .endlist
31013
31014 At the end of each ACL there is an implicit unconditional &%deny%&.
31015
31016 As you can see from the examples above, the conditions and modifiers are
31017 written one to a line, with the first one on the same line as the verb, and
31018 subsequent ones on following lines. If you have a very long condition, you can
31019 continue it onto several physical lines by the usual backslash continuation
31020 mechanism. It is conventional to align the conditions vertically.
31021
31022
31023
31024 .section "ACL variables" "SECTaclvariables"
31025 .cindex "&ACL;" "variables"
31026 There are some special variables that can be set during ACL processing. They
31027 can be used to pass information between different ACLs, different invocations
31028 of the same ACL in the same SMTP connection, and between ACLs and the routers,
31029 transports, and filters that are used to deliver a message. The names of these
31030 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
31031 an underscore, but the remainder of the name can be any sequence of
31032 alphanumeric characters and underscores that you choose. There is no limit on
31033 the number of ACL variables. The two sets act as follows:
31034 .ilist
31035 The values of those variables whose names begin with &$acl_c$& persist
31036 throughout an SMTP connection. They are never reset. Thus, a value that is set
31037 while receiving one message is still available when receiving the next message
31038 on the same SMTP connection.
31039 .next
31040 The values of those variables whose names begin with &$acl_m$& persist only
31041 while a message is being received. They are reset afterwards. They are also
31042 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
31043 .endlist
31044
31045 When a message is accepted, the current values of all the ACL variables are
31046 preserved with the message and are subsequently made available at delivery
31047 time. The ACL variables are set by a modifier called &%set%&. For example:
31048 .code
31049 accept hosts = whatever
31050        set acl_m4 = some value
31051 accept authenticated = *
31052        set acl_c_auth = yes
31053 .endd
31054 &*Note*&: A leading dollar sign is not used when naming a variable that is to
31055 be set. If you want to set a variable without taking any action, you can use a
31056 &%warn%& verb without any other modifiers or conditions.
31057
31058 .oindex &%strict_acl_vars%&
31059 What happens if a syntactically valid but undefined ACL variable is
31060 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
31061 false (the default), an empty string is substituted; if it is true, an
31062 error is generated.
31063
31064 Versions of Exim before 4.64 have a limited set of numbered variables, but
31065 their names are compatible, so there is no problem with upgrading.
31066
31067
31068 .section "Condition and modifier processing" "SECTcondmodproc"
31069 .cindex "&ACL;" "conditions; processing"
31070 .cindex "&ACL;" "modifiers; processing"
31071 An exclamation mark preceding a condition negates its result. For example:
31072 .code
31073 deny   domains = *.dom.example
31074       !verify  = recipient
31075 .endd
31076 causes the ACL to return &"deny"& if the recipient domain ends in
31077 &'dom.example'& and the recipient address cannot be verified. Sometimes
31078 negation can be used on the right-hand side of a condition. For example, these
31079 two statements are equivalent:
31080 .code
31081 deny  hosts = !192.168.3.4
31082 deny !hosts =  192.168.3.4
31083 .endd
31084 However, for many conditions (&%verify%& being a good example), only left-hand
31085 side negation of the whole condition is possible.
31086
31087 The arguments of conditions and modifiers are expanded. A forced failure
31088 of an expansion causes a condition to be ignored, that is, it behaves as if the
31089 condition is true. Consider these two statements:
31090 .code
31091 accept  senders = ${lookup{$host_name}lsearch\
31092                   {/some/file}{$value}fail}
31093 accept  senders = ${lookup{$host_name}lsearch\
31094                   {/some/file}{$value}{}}
31095 .endd
31096 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
31097 the returned list is searched, but if the lookup fails the behaviour is
31098 different in the two cases. The &%fail%& in the first statement causes the
31099 condition to be ignored, leaving no further conditions. The &%accept%& verb
31100 therefore succeeds. The second statement, however, generates an empty list when
31101 the lookup fails. No sender can match an empty list, so the condition fails,
31102 and therefore the &%accept%& also fails.
31103
31104 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
31105 specify actions that are taken as the conditions for a statement are checked;
31106 others specify text for messages that are used when access is denied or a
31107 warning is generated. The &%control%& modifier affects the way an incoming
31108 message is handled.
31109
31110 The positioning of the modifiers in an ACL statement is important, because the
31111 processing of a verb ceases as soon as its outcome is known. Only those
31112 modifiers that have already been encountered will take effect. For example,
31113 consider this use of the &%message%& modifier:
31114 .code
31115 require message = Can't verify sender
31116         verify  = sender
31117         message = Can't verify recipient
31118         verify  = recipient
31119         message = This message cannot be used
31120 .endd
31121 If sender verification fails, Exim knows that the result of the statement is
31122 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
31123 so its text is used as the error message. If sender verification succeeds, but
31124 recipient verification fails, the second message is used. If recipient
31125 verification succeeds, the third message becomes &"current"&, but is never used
31126 because there are no more conditions to cause failure.
31127
31128 For the &%deny%& verb, on the other hand, it is always the last &%message%&
31129 modifier that is used, because all the conditions must be true for rejection to
31130 happen. Specifying more than one &%message%& modifier does not make sense, and
31131 the message can even be specified after all the conditions. For example:
31132 .code
31133 deny   hosts = ...
31134       !senders = *@my.domain.example
31135        message = Invalid sender from client host
31136 .endd
31137 The &"deny"& result does not happen until the end of the statement is reached,
31138 by which time Exim has set up the message.
31139
31140
31141
31142 .section "ACL modifiers" "SECTACLmodi"
31143 .cindex "&ACL;" "modifiers; list of"
31144 The ACL modifiers are as follows:
31145
31146 .vlist
31147 .vitem &*add_header*&&~=&~<&'text'&>
31148 This modifier specifies one or more header lines that are to be added to an
31149 incoming message, assuming, of course, that the message is ultimately
31150 accepted. For details, see section &<<SECTaddheadacl>>&.
31151
31152 .vitem &*continue*&&~=&~<&'text'&>
31153 .cindex "&%continue%& ACL modifier"
31154 .cindex "database" "updating in ACL"
31155 This modifier does nothing of itself, and processing of the ACL always
31156 continues with the next condition or modifier. The value of &%continue%& is in
31157 the side effects of expanding its argument. Typically this could be used to
31158 update a database. It is really just a syntactic tidiness, to avoid having to
31159 write rather ugly lines like this:
31160 .display
31161 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
31162 .endd
31163 Instead, all you need is
31164 .display
31165 &`continue = `&<&'some expansion'&>
31166 .endd
31167
31168 .vitem &*control*&&~=&~<&'text'&>
31169 .cindex "&%control%& ACL modifier"
31170 This modifier affects the subsequent processing of the SMTP connection or of an
31171 incoming message that is accepted. The effect of the first type of control
31172 lasts for the duration of the connection, whereas the effect of the second type
31173 lasts only until the current message has been received. The message-specific
31174 controls always apply to the whole message, not to individual recipients,
31175 even if the &%control%& modifier appears in a RCPT ACL.
31176
31177 As there are now quite a few controls that can be applied, they are described
31178 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
31179 in several different ways. For example:
31180
31181 . ==== As this is a nested list, any displays it contains must be indented
31182 . ==== as otherwise they are too far to the left. That comment applies only
31183 . ==== when xmlto and fop are used; formatting with sdop gets it right either
31184 . ==== way.
31185
31186 .ilist
31187 It can be at the end of an &%accept%& statement:
31188 .code
31189     accept  ...some conditions
31190             control = queue
31191 .endd
31192 In this case, the control is applied when this statement yields &"accept"&, in
31193 other words, when the conditions are all true.
31194
31195 .next
31196 It can be in the middle of an &%accept%& statement:
31197 .code
31198     accept  ...some conditions...
31199             control = queue
31200             ...some more conditions...
31201 .endd
31202 If the first set of conditions are true, the control is applied, even if the
31203 statement does not accept because one of the second set of conditions is false.
31204 In this case, some subsequent statement must yield &"accept"& for the control
31205 to be relevant.
31206
31207 .next
31208 It can be used with &%warn%& to apply the control, leaving the
31209 decision about accepting or denying to a subsequent verb. For
31210 example:
31211 .code
31212     warn    ...some conditions...
31213             control = freeze
31214     accept  ...
31215 .endd
31216 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
31217 &%logwrite%&, so it does not add anything to the message and does not write a
31218 log entry.
31219
31220 .next
31221 If you want to apply a control unconditionally, you can use it with a
31222 &%require%& verb. For example:
31223 .code
31224     require  control = no_multiline_responses
31225 .endd
31226 .endlist
31227
31228 .vitem &*delay*&&~=&~<&'time'&>
31229 .cindex "&%delay%& ACL modifier"
31230 .oindex "&%-bh%&"
31231 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31232 the time interval before proceeding. However, when testing Exim using the
31233 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31234 output instead). The time is given in the usual Exim notation, and the delay
31235 happens as soon as the modifier is processed. In an SMTP session, pending
31236 output is flushed before the delay is imposed.
31237
31238 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31239 example:
31240 .code
31241 deny    ...some conditions...
31242         delay = 30s
31243 .endd
31244 The delay happens if all the conditions are true, before the statement returns
31245 &"deny"&. Compare this with:
31246 .code
31247 deny    delay = 30s
31248         ...some conditions...
31249 .endd
31250 which waits for 30s before processing the conditions. The &%delay%& modifier
31251 can also be used with &%warn%& and together with &%control%&:
31252 .code
31253 warn    ...some conditions...
31254         delay = 2m
31255         control = freeze
31256 accept  ...
31257 .endd
31258
31259 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31260 responses to several commands are no longer buffered and sent in one packet (as
31261 they would normally be) because all output is flushed before imposing the
31262 delay. This optimization is disabled so that a number of small delays do not
31263 appear to the client as one large aggregated delay that might provoke an
31264 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31265 using a &%control%& modifier to set &%no_delay_flush%&.
31266
31267
31268 .vitem &*endpass*&
31269 .cindex "&%endpass%& ACL modifier"
31270 This modifier, which has no argument, is recognized only in &%accept%& and
31271 &%discard%& statements. It marks the boundary between the conditions whose
31272 failure causes control to pass to the next statement, and the conditions whose
31273 failure causes the ACL to return &"deny"&. This concept has proved to be
31274 confusing to some people, so the use of &%endpass%& is no longer recommended as
31275 &"best practice"&. See the description of &%accept%& above for more details.
31276
31277
31278 .vitem &*log_message*&&~=&~<&'text'&>
31279 .cindex "&%log_message%& ACL modifier"
31280 This modifier sets up a message that is used as part of the log message if the
31281 ACL denies access or a &%warn%& statement's conditions are true. For example:
31282 .code
31283 require log_message = wrong cipher suite $tls_in_cipher
31284         encrypted   = DES-CBC3-SHA
31285 .endd
31286 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31287 example:
31288 .display
31289 &`discard `&<&'some conditions'&>
31290 &`        log_message = Discarded $local_part@$domain because...`&
31291 .endd
31292 When access is denied, &%log_message%& adds to any underlying error message
31293 that may exist because of a condition failure. For example, while verifying a
31294 recipient address, a &':fail:'& redirection might have already set up a
31295 message.
31296
31297 The message may be defined before the conditions to which it applies, because
31298 the string expansion does not happen until Exim decides that access is to be
31299 denied. This means that any variables that are set by the condition are
31300 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31301 variables are set after a DNS black list lookup succeeds. If the expansion of
31302 &%log_message%& fails, or if the result is an empty string, the modifier is
31303 ignored.
31304
31305 .vindex "&$acl_verify_message$&"
31306 If you want to use a &%warn%& statement to log the result of an address
31307 verification, you can use &$acl_verify_message$& to include the verification
31308 error message.
31309
31310 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31311 the start of the logged message. If the same warning log message is requested
31312 more than once while receiving  a single email message, only one copy is
31313 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31314 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31315 is logged for a successful &%warn%& statement.
31316
31317 If &%log_message%& is not present and there is no underlying error message (for
31318 example, from the failure of address verification), but &%message%& is present,
31319 the &%message%& text is used for logging rejections. However, if any text for
31320 logging contains newlines, only the first line is logged. In the absence of
31321 both &%log_message%& and &%message%&, a default built-in message is used for
31322 logging rejections.
31323
31324
31325 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31326 .cindex "&%log_reject_target%& ACL modifier"
31327 .cindex "logging in ACL" "specifying which log"
31328 This modifier makes it possible to specify which logs are used for messages
31329 about ACL rejections. Its argument is a colon-separated list of words that can
31330 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31331 may be empty, in which case a rejection is not logged at all. For example, this
31332 ACL fragment writes no logging information when access is denied:
31333 .display
31334 &`deny `&<&'some conditions'&>
31335 &`     log_reject_target =`&
31336 .endd
31337 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31338 permanent and temporary rejections. Its effect lasts for the rest of the
31339 current ACL.
31340
31341
31342 .vitem &*logwrite*&&~=&~<&'text'&>
31343 .cindex "&%logwrite%& ACL modifier"
31344 .cindex "logging in ACL" "immediate"
31345 This modifier writes a message to a log file as soon as it is encountered when
31346 processing an ACL. (Compare &%log_message%&, which, except in the case of
31347 &%warn%& and &%discard%&, is used only if the ACL statement denies
31348 access.) The &%logwrite%& modifier can be used to log special incidents in
31349 ACLs. For example:
31350 .display
31351 &`accept `&<&'some special conditions'&>
31352 &`       control  = freeze`&
31353 &`       logwrite = froze message because ...`&
31354 .endd
31355 By default, the message is written to the main log. However, it may begin
31356 with a colon, followed by a comma-separated list of log names, and then
31357 another colon, to specify exactly which logs are to be written. For
31358 example:
31359 .code
31360 logwrite = :main,reject: text for main and reject logs
31361 logwrite = :panic: text for panic log only
31362 .endd
31363
31364
31365 .vitem &*message*&&~=&~<&'text'&>
31366 .cindex "&%message%& ACL modifier"
31367 This modifier sets up a text string that is expanded and used as a response
31368 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31369 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31370 there is some complication if &%endpass%& is involved; see the description of
31371 &%accept%& for details.)
31372
31373 The expansion of the message happens at the time Exim decides that the ACL is
31374 to end, not at the time it processes &%message%&. If the expansion fails, or
31375 generates an empty string, the modifier is ignored. Here is an example where
31376 &%message%& must be specified first, because the ACL ends with a rejection if
31377 the &%hosts%& condition fails:
31378 .code
31379 require  message = Host not recognized
31380          hosts = 10.0.0.0/8
31381 .endd
31382 (Once a condition has failed, no further conditions or modifiers are
31383 processed.)
31384
31385 .cindex "SMTP" "error codes"
31386 .oindex "&%smtp_banner%&
31387 For ACLs that are triggered by SMTP commands, the message is returned as part
31388 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31389 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31390 is accepted. In the case of the connect ACL, accepting with a message modifier
31391 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31392 accept message may not contain more than one line (otherwise it will be
31393 truncated at the first newline and a panic logged), and it cannot affect the
31394 EHLO options.
31395
31396 When SMTP is involved, the message may begin with an overriding response code,
31397 consisting of three digits optionally followed by an &"extended response code"&
31398 of the form &'n.n.n'&, each code being followed by a space. For example:
31399 .code
31400 deny  message = 599 1.2.3 Host not welcome
31401       hosts = 192.168.34.0/24
31402 .endd
31403 The first digit of the supplied response code must be the same as would be sent
31404 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31405 access, but for the predata ACL, note that the default success code is 354, not
31406 2&'xx'&.
31407
31408 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31409 the message modifier cannot override the 221 response code.
31410
31411 The text in a &%message%& modifier is literal; any quotes are taken as
31412 literals, but because the string is expanded, backslash escapes are processed
31413 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
31414 response.
31415
31416 .vindex "&$acl_verify_message$&"
31417 While the text is being expanded, the &$acl_verify_message$& variable
31418 contains any message previously set.
31419 Afterwards, &$acl_verify_message$& is cleared.
31420
31421 If &%message%& is used on a statement that verifies an address, the message
31422 specified overrides any message that is generated by the verification process.
31423 However, the original message is available in the variable
31424 &$acl_verify_message$&, so you can incorporate it into your message if you
31425 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31426 routers to be passed back as part of the SMTP response, you should either not
31427 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31428
31429 For compatibility with previous releases of Exim, a &%message%& modifier that
31430 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31431 modifier, but this usage is now deprecated. However, &%message%& acts only when
31432 all the conditions are true, wherever it appears in an ACL command, whereas
31433 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31434 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31435 effect.
31436
31437
31438 .vitem &*queue*&&~=&~<&'text'&>
31439 .cindex "&%queue%& ACL modifier"
31440 .cindex "named queues" "selecting in ACL"
31441 This modifier specifies the use of a named queue for spool files
31442 for the message.
31443 It can only be used before the message is received (i.e. not in
31444 the DATA ACL).
31445 This could be used, for example, for known high-volume burst sources
31446 of traffic, or for quarantine of messages.
31447 Separate queue-runner processes will be needed for named queues.
31448 If the text after expansion is empty, the default queue is used.
31449
31450
31451 .vitem &*remove_header*&&~=&~<&'text'&>
31452 This modifier specifies one or more header names in a colon-separated list
31453  that are to be removed from an incoming message, assuming, of course, that
31454 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31455
31456
31457 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31458 .cindex "&%set%& ACL modifier"
31459 This modifier puts a value into one of the ACL variables (see section
31460 &<<SECTaclvariables>>&).
31461
31462
31463 .vitem &*udpsend*&&~=&~<&'parameters'&>
31464 .cindex "UDP communications"
31465 This modifier sends a UDP packet, for purposes such as statistics
31466 collection or behaviour monitoring. The parameters are expanded, and
31467 the result of the expansion must be a colon-separated list consisting
31468 of a destination server, port number, and the packet contents. The
31469 server can be specified as a host name or IPv4 or IPv6 address. The
31470 separator can be changed with the usual angle bracket syntax. For
31471 example, you might want to collect information on which hosts connect
31472 when:
31473 .code
31474 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31475              $tod_zulu $sender_host_address
31476 .endd
31477 .endlist
31478
31479
31480
31481
31482 .section "Use of the control modifier" "SECTcontrols"
31483 .cindex "&%control%& ACL modifier"
31484 The &%control%& modifier supports the following settings:
31485
31486 .vlist
31487 .vitem &*control&~=&~allow_auth_unadvertised*&
31488 This modifier allows a client host to use the SMTP AUTH command even when it
31489 has not been advertised in response to EHLO. Furthermore, because there are
31490 apparently some really broken clients that do this, Exim will accept AUTH after
31491 HELO (rather than EHLO) when this control is set. It should be used only if you
31492 really need it, and you should limit its use to those broken clients that do
31493 not work without it. For example:
31494 .code
31495 warn hosts   = 192.168.34.25
31496      control = allow_auth_unadvertised
31497 .endd
31498 Normally, when an Exim server receives an AUTH command, it checks the name of
31499 the authentication mechanism that is given in the command to ensure that it
31500 matches an advertised mechanism. When this control is set, the check that a
31501 mechanism has been advertised is bypassed. Any configured mechanism can be used
31502 by the client. This control is permitted only in the connection and HELO ACLs.
31503
31504
31505 .vitem &*control&~=&~caseful_local_part*& &&&
31506        &*control&~=&~caselower_local_part*&
31507 .cindex "&ACL;" "case of local part in"
31508 .cindex "case of local parts"
31509 .vindex "&$local_part$&"
31510 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31511 (that is, during RCPT processing). By default, the contents of &$local_part$&
31512 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31513 any uppercase letters in the original local part are restored in &$local_part$&
31514 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31515 is encountered.
31516
31517 These controls affect only the current recipient. Moreover, they apply only to
31518 local part handling that takes place directly in the ACL (for example, as a key
31519 in lookups). If a test to verify the recipient is obeyed, the case-related
31520 handling of the local part during the verification is controlled by the router
31521 configuration (see the &%caseful_local_part%& generic router option).
31522
31523 This facility could be used, for example, to add a spam score to local parts
31524 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31525 spam score:
31526 .code
31527 warn  control = caseful_local_part
31528       set acl_m4 = ${eval:\
31529                      $acl_m4 + \
31530                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31531                     }
31532       control = caselower_local_part
31533 .endd
31534 Notice that we put back the lower cased version afterwards, assuming that
31535 is what is wanted for subsequent tests.
31536
31537
31538 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31539 .cindex "&ACL;" "cutthrough routing"
31540 .cindex "cutthrough" "requesting"
31541 This option requests delivery be attempted while the item is being received.
31542
31543 The option is usable in the RCPT ACL.
31544 If enabled for a message received via smtp and routed to an smtp transport,
31545 and only one transport, interface, destination host and port combination
31546 is used for all recipients of the message,
31547 then the delivery connection is made while the receiving connection is open
31548 and data is copied from one to the other.
31549
31550 An attempt to set this option for any recipient but the first
31551 for a mail will be quietly ignored.
31552 If a recipient-verify callout
31553 (with use_sender)
31554 connection is subsequently
31555 requested in the same ACL it is held open and used for
31556 any subsequent recipients and the data,
31557 otherwise one is made after the initial RCPT ACL completes.
31558
31559 Note that routers are used in verify mode,
31560 and cannot depend on content of received headers.
31561 Note also that headers cannot be
31562 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31563 Headers may be modified by routers (subject to the above) and transports.
31564 The &'Received-By:'& header is generated as soon as the body reception starts,
31565 rather than the traditional time after the full message is received;
31566 this will affect the timestamp.
31567
31568 All the usual ACLs are called; if one results in the message being
31569 rejected, all effort spent in delivery (including the costs on
31570 the ultimate destination) will be wasted.
31571 Note that in the case of data-time ACLs this includes the entire
31572 message body.
31573
31574 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31575 of outgoing messages is done, because it sends data to the ultimate destination
31576 before the entire message has been received from the source.
31577 It is not supported for messages received with the SMTP PRDR
31578 or CHUNKING
31579 options in use.
31580
31581 Should the ultimate destination system positively accept or reject the mail,
31582 a corresponding indication is given to the source system and nothing is queued.
31583 If the item is successfully delivered in cutthrough mode
31584 the delivery log lines are tagged with ">>" rather than "=>" and appear
31585 before the acceptance "<=" line.
31586
31587 If there is a temporary error the item is queued for later delivery in the
31588 usual fashion.
31589 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31590 to the control; the default value is &"spool"& and the alternate value
31591 &"pass"& copies an SMTP defer response from the target back to the initiator
31592 and does not queue the message.
31593 Note that this is independent of any recipient verify conditions in the ACL.
31594
31595 Delivery in this mode avoids the generation of a bounce mail to a
31596 (possibly faked)
31597 sender when the destination system is doing content-scan based rejection.
31598
31599
31600 .vitem &*control&~=&~debug/*&<&'options'&>
31601 .cindex "&ACL;" "enabling debug logging"
31602 .cindex "debugging" "enabling from an ACL"
31603 This control turns on debug logging, almost as though Exim had been invoked
31604 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31605 by default called &'debuglog'&.
31606
31607 Logging set up by the control will be maintained across spool residency.
31608
31609 Options are a slash-separated list.
31610 If an option takes an argument, the option name and argument are separated by
31611 an equals character.
31612 Several options are supported:
31613 .display
31614 tag=<&'suffix'&>         The filename can be adjusted with thise option.
31615                      The argument, which may access any variables already defined,
31616                      is appended to the default name.
31617
31618 opts=<&'debug&~options'&> The argument specififes what is to be logged,
31619                      using the same values as the &`-d`& command-line option.
31620
31621 stop                 Logging started with this control may be
31622                      stopped by using this option.
31623
31624 kill                 Logging started with this control may be
31625                      stopped by using this option.
31626                      Additionally the debug file will be removed,
31627                      providing one means for speculative debug tracing.
31628
31629 pretrigger=<&'size'&>    This option specifies a memory buffuer to be used
31630                      for pre-trigger debug capture.
31631                      Debug lines are recorded in the buffer until
31632                      and if) a trigger occurs; at which time they are
31633                      dumped to the debug file.  Newer lines displace the
31634                      oldest if the buffer is full.  After a trigger,
31635                      immediate writes to file are done as normal.
31636
31637 trigger=<&'reason'&>     This option selects cause for the pretrigger buffer
31638                      see above) to be copied to file.  A reason of $*now*
31639                      take effect immediately; one of &*paniclog*& triggers
31640                      on a write to the panic log.
31641 .endd
31642
31643 Some examples (which depend on variables that don't exist in all
31644 contexts):
31645 .code
31646       control = debug
31647       control = debug/tag=.$sender_host_address
31648       control = debug/opts=+expand+acl
31649       control = debug/tag=.$message_exim_id/opts=+expand
31650       control = debug/kill
31651       control = debug/opts=+all/pretrigger=1024/trigger=paniclog
31652       control = debug/trigger=now
31653 .endd
31654
31655
31656 .vitem &*control&~=&~dkim_disable_verify*&
31657 .cindex "disable DKIM verify"
31658 .cindex "DKIM" "disable verify"
31659 This control turns off DKIM verification processing entirely.  For details on
31660 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31661
31662
31663 .vitem &*control&~=&~dmarc_disable_verify*&
31664 .cindex "disable DMARC verify"
31665 .cindex "DMARC" "disable verify"
31666 This control turns off DMARC verification processing entirely.  For details on
31667 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31668
31669
31670 .vitem &*control&~=&~dscp/*&<&'value'&>
31671 .cindex "&ACL;" "setting DSCP value"
31672 .cindex "DSCP" "inbound"
31673 This option causes the DSCP value associated with the socket for the inbound
31674 connection to be adjusted to a given value, given as one of a number of fixed
31675 strings or to numeric value.
31676 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31677 Common values include &`throughput`&, &`mincost`&, and on newer systems
31678 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31679
31680 The outbound packets from Exim will be marked with this value in the header
31681 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31682 that these values will have any effect, not be stripped by networking
31683 equipment, or do much of anything without cooperation with your Network
31684 Engineer and those of all network operators between the source and destination.
31685
31686
31687 .vitem &*control&~=&~enforce_sync*& &&&
31688        &*control&~=&~no_enforce_sync*&
31689 .cindex "SMTP" "synchronization checking"
31690 .cindex "synchronization checking in SMTP"
31691 These controls make it possible to be selective about when SMTP synchronization
31692 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31693 state of the switch (it is true by default). See the description of this option
31694 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31695
31696 The effect of these two controls lasts for the remainder of the SMTP
31697 connection. They can appear in any ACL except the one for the non-SMTP
31698 messages. The most straightforward place to put them is in the ACL defined by
31699 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31700 before the first synchronization check. The expected use is to turn off the
31701 synchronization checks for badly-behaved hosts that you nevertheless need to
31702 work with.
31703
31704
31705 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31706 .cindex "fake defer"
31707 .cindex "defer, fake"
31708 This control works in exactly the same way as &%fakereject%& (described below)
31709 except that it causes an SMTP 450 response after the message data instead of a
31710 550 response. You must take care when using &%fakedefer%& because it causes the
31711 messages to be duplicated when the sender retries. Therefore, you should not
31712 use &%fakedefer%& if the message is to be delivered normally.
31713
31714 .vitem &*control&~=&~fakereject/*&<&'message'&>
31715 .cindex "fake rejection"
31716 .cindex "rejection, fake"
31717 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31718 words, only when an SMTP message is being received. If Exim accepts the
31719 message, instead the final 250 response, a 550 rejection message is sent.
31720 However, Exim proceeds to deliver the message as normal. The control applies
31721 only to the current message, not to any subsequent ones that may be received in
31722 the same SMTP connection.
31723
31724 The text for the 550 response is taken from the &%control%& modifier. If no
31725 message is supplied, the following is used:
31726 .code
31727 550-Your message has been rejected but is being
31728 550-kept for evaluation.
31729 550-If it was a legitimate message, it may still be
31730 550 delivered to the target recipient(s).
31731 .endd
31732 This facility should be used with extreme caution.
31733
31734 .vitem &*control&~=&~freeze*&
31735 .cindex "frozen messages" "forcing in ACL"
31736 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31737 other words, only when a message is being received. If the message is accepted,
31738 it is placed on Exim's queue and frozen. The control applies only to the
31739 current message, not to any subsequent ones that may be received in the same
31740 SMTP connection.
31741
31742 This modifier can optionally be followed by &`/no_tell`&. If the global option
31743 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31744 is told about the freezing), provided all the &*control=freeze*& modifiers that
31745 are obeyed for the current message have the &`/no_tell`& option.
31746
31747 .vitem &*control&~=&~no_delay_flush*&
31748 .cindex "SMTP" "output flushing, disabling for delay"
31749 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31750 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31751 use. This control, as long as it is encountered before the &%delay%& modifier,
31752 disables such output flushing.
31753
31754 .vitem &*control&~=&~no_callout_flush*&
31755 .cindex "SMTP" "output flushing, disabling for callout"
31756 Exim normally flushes SMTP output before performing a callout in an ACL, to
31757 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31758 use. This control, as long as it is encountered before the &%verify%& condition
31759 that causes the callout, disables such output flushing.
31760
31761 .vitem &*control&~=&~no_mbox_unspool*&
31762 This control is available when Exim is compiled with the content scanning
31763 extension. Content scanning may require a copy of the current message, or parts
31764 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31765 or spam scanner. Normally, such copies are deleted when they are no longer
31766 needed. If this control is set, the copies are not deleted. The control applies
31767 only to the current message, not to any subsequent ones that may be received in
31768 the same SMTP connection. It is provided for debugging purposes and is unlikely
31769 to be useful in production.
31770
31771 .vitem &*control&~=&~no_multiline_responses*&
31772 .cindex "multiline responses, suppressing"
31773 This control is permitted for any ACL except the one for non-SMTP messages.
31774 It seems that there are broken clients in use that cannot handle multiline
31775 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31776
31777 If this control is set, multiline SMTP responses from ACL rejections are
31778 suppressed. One way of doing this would have been to put out these responses as
31779 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31780 (&"use multiline responses for more"& it says &-- ha!), and some of the
31781 responses might get close to that. So this facility, which is after all only a
31782 sop to broken clients, is implemented by doing two very easy things:
31783
31784 .ilist
31785 Extra information that is normally output as part of a rejection caused by
31786 sender verification failure is omitted. Only the final line (typically &"sender
31787 verification failed"&) is sent.
31788 .next
31789 If a &%message%& modifier supplies a multiline response, only the first
31790 line is output.
31791 .endlist
31792
31793 The setting of the switch can, of course, be made conditional on the
31794 calling host. Its effect lasts until the end of the SMTP connection.
31795
31796 .vitem &*control&~=&~no_pipelining*&
31797 .cindex "PIPELINING" "suppressing advertising"
31798 .cindex "ESMTP extensions" PIPELINING
31799 This control turns off the advertising of the PIPELINING extension to SMTP in
31800 the current session. To be useful, it must be obeyed before Exim sends its
31801 response to an EHLO command. Therefore, it should normally appear in an ACL
31802 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31803 &%pipelining_advertise_hosts%&.
31804
31805 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31806        &*control&~=&~queue_only*&
31807 .oindex "&%queue%&"
31808 .oindex "&%queue_only%&"
31809 .cindex "queueing incoming messages"
31810 .cindex queueing "forcing in ACL"
31811 .cindex "first pass routing"
31812 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31813 other words, only when a message is being received. If the message is accepted,
31814 it is placed on Exim's queue and left there for delivery by a subsequent queue
31815 runner.
31816 If used with no options set,
31817 no immediate delivery process is started. In other words, it has the
31818 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31819
31820 If the &'first_pass_route'& option is given then
31821 the behaviour is like the command-line &'-oqds'& option;
31822 a delivery process is started which stops short of making
31823 any SMTP delivery.  The benefit is that the hints database will be updated for
31824 the message being waiting for a specific host, and a later queue run will be
31825 able to send all such messages on a single connection.
31826
31827 The control only applies to the current message, not to any subsequent ones that
31828  may be received in the same SMTP connection.
31829
31830 .vitem &*control&~=&~submission/*&<&'options'&>
31831 .cindex "message" "submission"
31832 .cindex "submission mode"
31833 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31834 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31835 the current message is a submission from a local MUA. In this case, Exim
31836 operates in &"submission mode"&, and applies certain fixups to the message if
31837 necessary. For example, it adds a &'Date:'& header line if one is not present.
31838 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31839 late (the message has already been created).
31840
31841 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31842 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31843 submission mode; the available options for this control are described there.
31844 The control applies only to the current message, not to any subsequent ones
31845 that may be received in the same SMTP connection.
31846
31847 .vitem &*control&~=&~suppress_local_fixups*&
31848 .cindex "submission fixups, suppressing"
31849 This control applies to locally submitted (non TCP/IP) messages, and is the
31850 complement of &`control = submission`&. It disables the fixups that are
31851 normally applied to locally-submitted messages. Specifically:
31852
31853 .ilist
31854 Any &'Sender:'& header line is left alone (in this respect, it is a
31855 dynamic version of &%local_sender_retain%&).
31856 .next
31857 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
31858 .next
31859 There is no check that &'From:'& corresponds to the actual sender.
31860 .endlist ilist
31861
31862 This control may be useful when a remotely-originated message is accepted,
31863 passed to some scanning program, and then re-submitted for delivery. It can be
31864 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31865 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
31866 data is read.
31867
31868 &*Note:*& This control applies only to the current message, not to any others
31869 that are being submitted at the same time using &%-bs%& or &%-bS%&.
31870
31871 .vitem &*control&~=&~utf8_downconvert*&
31872 This control enables conversion of UTF-8 in message envelope addresses
31873 to a-label form.
31874 For details see section &<<SECTi18nMTA>>&.
31875 .endlist vlist
31876
31877
31878 .section "Summary of message fixup control" "SECTsummesfix"
31879 All four possibilities for message fixups can be specified:
31880
31881 .ilist
31882 Locally submitted, fixups applied: the default.
31883 .next
31884 Locally submitted, no fixups applied: use
31885 &`control = suppress_local_fixups`&.
31886 .next
31887 Remotely submitted, no fixups applied: the default.
31888 .next
31889 Remotely submitted, fixups applied: use &`control = submission`&.
31890 .endlist
31891
31892
31893
31894 .section "Adding header lines in ACLs" "SECTaddheadacl"
31895 .cindex "header lines" "adding in an ACL"
31896 .cindex "header lines" "position of added lines"
31897 .cindex "&%add_header%& ACL modifier"
31898 The &%add_header%& modifier can be used to add one or more extra header lines
31899 to an incoming message, as in this example:
31900 .code
31901 warn dnslists = sbl.spamhaus.org : \
31902                 dialup.mail-abuse.org
31903      add_header = X-blacklisted-at: $dnslist_domain
31904 .endd
31905 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31906 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31907 receiving a message). The message must ultimately be accepted for
31908 &%add_header%& to have any significant effect. You can use &%add_header%& with
31909 any ACL verb, including &%deny%& (though this is potentially useful only in a
31910 RCPT ACL).
31911
31912 Headers will not be added to the message if the modifier is used in
31913 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31914
31915 Leading and trailing newlines are removed from
31916 the data for the &%add_header%& modifier; if it then
31917 contains one or more newlines that
31918 are not followed by a space or a tab, it is assumed to contain multiple header
31919 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
31920 front of any line that is not a valid header line.
31921
31922 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
31923 They are added to the message before processing the DATA and MIME ACLs.
31924 However, if an identical header line is requested more than once, only one copy
31925 is actually added to the message. Further header lines may be accumulated
31926 during the DATA and MIME ACLs, after which they are added to the message, again
31927 with duplicates suppressed. Thus, it is possible to add two identical header
31928 lines to an SMTP message, but only if one is added before DATA and one after.
31929 In the case of non-SMTP messages, new headers are accumulated during the
31930 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
31931 message is rejected after DATA or by the non-SMTP ACL, all added header lines
31932 are included in the entry that is written to the reject log.
31933
31934 .cindex "header lines" "added; visibility of"
31935 Header lines are not visible in string expansions
31936 of message headers
31937 until they are added to the
31938 message. It follows that header lines defined in the MAIL, RCPT, and predata
31939 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
31940 header lines that are added by the DATA or MIME ACLs are not visible in those
31941 ACLs. Because of this restriction, you cannot use header lines as a way of
31942 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
31943 this, you can use ACL variables, as described in section
31944 &<<SECTaclvariables>>&.
31945
31946 The list of headers yet to be added is given by the &%$headers_added%& variable.
31947
31948 The &%add_header%& modifier acts immediately as it is encountered during the
31949 processing of an ACL. Notice the difference between these two cases:
31950 .display
31951 &`accept add_header = ADDED: some text`&
31952 &`       `&<&'some condition'&>
31953
31954 &`accept `&<&'some condition'&>
31955 &`       add_header = ADDED: some text`&
31956 .endd
31957 In the first case, the header line is always added, whether or not the
31958 condition is true. In the second case, the header line is added only if the
31959 condition is true. Multiple occurrences of &%add_header%& may occur in the same
31960 ACL statement. All those that are encountered before a condition fails are
31961 honoured.
31962
31963 .cindex "&%warn%& ACL verb"
31964 For compatibility with previous versions of Exim, a &%message%& modifier for a
31965 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
31966 effect only if all the conditions are true, even if it appears before some of
31967 them. Furthermore, only the last occurrence of &%message%& is honoured. This
31968 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
31969 are present on a &%warn%& verb, both are processed according to their
31970 specifications.
31971
31972 By default, new header lines are added to a message at the end of the existing
31973 header lines. However, you can specify that any particular header line should
31974 be added right at the start (before all the &'Received:'& lines), immediately
31975 after the first block of &'Received:'& lines, or immediately before any line
31976 that is not a &'Received:'& or &'Resent-something:'& header.
31977
31978 This is done by specifying &":at_start:"&, &":after_received:"&, or
31979 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
31980 header line, respectively. (Header text cannot start with a colon, as there has
31981 to be a header name first.) For example:
31982 .code
31983 warn add_header = \
31984        :after_received:X-My-Header: something or other...
31985 .endd
31986 If more than one header line is supplied in a single &%add_header%& modifier,
31987 each one is treated independently and can therefore be placed differently. If
31988 you add more than one line at the start, or after the Received: block, they end
31989 up in reverse order.
31990
31991 &*Warning*&: This facility currently applies only to header lines that are
31992 added in an ACL. It does NOT work for header lines that are added in a
31993 system filter or in a router or transport.
31994
31995
31996
31997 .section "Removing header lines in ACLs" "SECTremoveheadacl"
31998 .cindex "header lines" "removing in an ACL"
31999 .cindex "header lines" "position of removed lines"
32000 .cindex "&%remove_header%& ACL modifier"
32001 The &%remove_header%& modifier can be used to remove one or more header lines
32002 from an incoming message, as in this example:
32003 .code
32004 warn   message        = Remove internal headers
32005        remove_header  = x-route-mail1 : x-route-mail2
32006 .endd
32007 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32008 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32009 receiving a message). The message must ultimately be accepted for
32010 &%remove_header%& to have any significant effect. You can use &%remove_header%&
32011 with any ACL verb, including &%deny%&, though this is really not useful for
32012 any verb that doesn't result in a delivered message.
32013
32014 Headers will not be removed from the message if the modifier is used in
32015 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32016
32017 More than one header can be removed at the same time by using a colon separated
32018 list of header names. The header matching is case insensitive. Wildcards are
32019 not permitted, nor is list expansion performed, so you cannot use hostlists to
32020 create a list of headers, however both connection and message variable expansion
32021 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
32022 .code
32023 warn   hosts           = +internal_hosts
32024        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
32025 warn   message         = Remove internal headers
32026        remove_header   = $acl_c_ihdrs
32027 .endd
32028 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
32029 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
32030 If multiple header lines match, all are removed.
32031 There is no harm in attempting to remove the same header twice nor in removing
32032 a non-existent header. Further header lines to be removed may be accumulated
32033 during the DATA and MIME ACLs, after which they are removed from the message,
32034 if present. In the case of non-SMTP messages, headers to be removed are
32035 accumulated during the non-SMTP ACLs, and are removed from the message after
32036 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
32037 ACL, there really is no effect because there is no logging of what headers
32038 would have been removed.
32039
32040 .cindex "header lines" "removed; visibility of"
32041 Header lines are not visible in string expansions until the DATA phase when it
32042 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
32043 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
32044 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
32045 this restriction, you cannot use header lines as a way of controlling data
32046 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
32047 you should instead use ACL variables, as described in section
32048 &<<SECTaclvariables>>&.
32049
32050 The &%remove_header%& modifier acts immediately as it is encountered during the
32051 processing of an ACL. Notice the difference between these two cases:
32052 .display
32053 &`accept remove_header = X-Internal`&
32054 &`       `&<&'some condition'&>
32055
32056 &`accept `&<&'some condition'&>
32057 &`       remove_header = X-Internal`&
32058 .endd
32059 In the first case, the header line is always removed, whether or not the
32060 condition is true. In the second case, the header line is removed only if the
32061 condition is true. Multiple occurrences of &%remove_header%& may occur in the
32062 same ACL statement. All those that are encountered before a condition fails
32063 are honoured.
32064
32065 &*Warning*&: This facility currently applies only to header lines that are
32066 present during ACL processing. It does NOT remove header lines that are added
32067 in a system filter or in a router or transport.
32068
32069
32070
32071
32072 .section "ACL conditions" "SECTaclconditions"
32073 .cindex "&ACL;" "conditions; list of"
32074 Some of the conditions listed in this section are available only when Exim is
32075 compiled with the content-scanning extension. They are included here briefly
32076 for completeness. More detailed descriptions can be found in the discussion on
32077 content scanning in chapter &<<CHAPexiscan>>&.
32078
32079 Not all conditions are relevant in all circumstances. For example, testing
32080 senders and recipients does not make sense in an ACL that is being run as the
32081 result of the arrival of an ETRN command, and checks on message headers can be
32082 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
32083 can use the same condition (with different parameters) more than once in the
32084 same ACL statement. This provides a way of specifying an &"and"& conjunction.
32085 The conditions are as follows:
32086
32087
32088 .vlist
32089 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
32090 .cindex "&ACL;" "nested"
32091 .cindex "&ACL;" "indirect"
32092 .cindex "&ACL;" "arguments"
32093 .cindex "&%acl%& ACL condition"
32094 The possible values of the argument are the same as for the
32095 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
32096 &"accept"& the condition is true; if it returns &"deny"& the condition is
32097 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
32098 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
32099 condition false. This means that further processing of the &%warn%& verb
32100 ceases, but processing of the ACL continues.
32101
32102 If the argument is a named ACL, up to nine space-separated optional values
32103 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
32104 and $acl_narg is set to the count of values.
32105 Previous values of these variables are restored after the call returns.
32106 The name and values are expanded separately.
32107 Note that spaces in complex expansions which are used as arguments
32108 will act as argument separators.
32109
32110 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
32111 the connection is dropped. If it returns &"discard"&, the verb must be
32112 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
32113 conditions are tested.
32114
32115 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
32116 loops. This condition allows you to use different ACLs in different
32117 circumstances. For example, different ACLs can be used to handle RCPT commands
32118 for different local users or different local domains.
32119
32120 .vitem &*authenticated&~=&~*&<&'string&~list'&>
32121 .cindex "&%authenticated%& ACL condition"
32122 .cindex "authentication" "ACL checking"
32123 .cindex "&ACL;" "testing for authentication"
32124 If the SMTP connection is not authenticated, the condition is false. Otherwise,
32125 the name of the authenticator is tested against the list. To test for
32126 authentication by any authenticator, you can set
32127 .code
32128 authenticated = *
32129 .endd
32130
32131 .vitem &*condition&~=&~*&<&'string'&>
32132 .cindex "&%condition%& ACL condition"
32133 .cindex "customizing" "ACL condition"
32134 .cindex "&ACL;" "customized test"
32135 .cindex "&ACL;" "testing, customized"
32136 This feature allows you to make up custom conditions. If the result of
32137 expanding the string is an empty string, the number zero, or one of the strings
32138 &"no"& or &"false"&, the condition is false. If the result is any non-zero
32139 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
32140 any other value, some error is assumed to have occurred, and the ACL returns
32141 &"defer"&. However, if the expansion is forced to fail, the condition is
32142 ignored. The effect is to treat it as true, whether it is positive or
32143 negative.
32144
32145 .vitem &*decode&~=&~*&<&'location'&>
32146 .cindex "&%decode%& ACL condition"
32147 This condition is available only when Exim is compiled with the
32148 content-scanning extension, and it is allowed only in the ACL defined by
32149 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
32150 If all goes well, the condition is true. It is false only if there are
32151 problems such as a syntax error or a memory shortage. For more details, see
32152 chapter &<<CHAPexiscan>>&.
32153
32154 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
32155 .cindex "&%dnslists%& ACL condition"
32156 .cindex "DNS list" "in ACL"
32157 .cindex "black list (DNS)"
32158 .cindex "&ACL;" "testing a DNS list"
32159 This condition checks for entries in DNS black lists. These are also known as
32160 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
32161 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
32162 different variants of this condition to describe briefly here. See sections
32163 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
32164
32165 .vitem &*domains&~=&~*&<&'domain&~list'&>
32166 .cindex "&%domains%& ACL condition"
32167 .cindex "domain" "ACL checking"
32168 .cindex "&ACL;" "testing a recipient domain"
32169 .vindex "&$domain_data$&"
32170 This condition is relevant only in a RCPT ACL. It checks that the domain
32171 of the recipient address is in the domain list. If percent-hack processing is
32172 enabled, it is done before this test is done. If the check succeeds with a
32173 lookup, the result of the lookup is placed in &$domain_data$& until the next
32174 &%domains%& test.
32175
32176 &*Note carefully*& (because many people seem to fall foul of this): you cannot
32177 use &%domains%& in a DATA ACL.
32178
32179
32180 .vitem &*encrypted&~=&~*&<&'string&~list'&>
32181 .cindex "&%encrypted%& ACL condition"
32182 .cindex "encryption" "checking in an ACL"
32183 .cindex "&ACL;" "testing for encryption"
32184 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
32185 name of the cipher suite in use is tested against the list. To test for
32186 encryption without testing for any specific cipher suite(s), set
32187 .code
32188 encrypted = *
32189 .endd
32190
32191
32192 .vitem &*hosts&~=&~*&<&'host&~list'&>
32193 .cindex "&%hosts%& ACL condition"
32194 .cindex "host" "ACL checking"
32195 .cindex "&ACL;" "testing the client host"
32196 This condition tests that the calling host matches the host list. If you have
32197 name lookups or wildcarded host names and IP addresses in the same host list,
32198 you should normally put the IP addresses first. For example, you could have:
32199 .code
32200 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
32201 .endd
32202 The lookup in this example uses the host name for its key. This is implied by
32203 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
32204 and it wouldn't matter which way round you had these two items.)
32205
32206 The reason for the problem with host names lies in the left-to-right way that
32207 Exim processes lists. It can test IP addresses without doing any DNS lookups,
32208 but when it reaches an item that requires a host name, it fails if it cannot
32209 find a host name to compare with the pattern. If the above list is given in the
32210 opposite order, the &%accept%& statement fails for a host whose name cannot be
32211 found, even if its IP address is 10.9.8.7.
32212
32213 If you really do want to do the name check first, and still recognize the IP
32214 address even if the name lookup fails, you can rewrite the ACL like this:
32215 .code
32216 accept hosts = dbm;/etc/friendly/hosts
32217 accept hosts = 10.9.8.7
32218 .endd
32219 The default action on failing to find the host name is to assume that the host
32220 is not in the list, so the first &%accept%& statement fails. The second
32221 statement can then check the IP address.
32222
32223 .vindex "&$host_data$&"
32224 If a &%hosts%& condition is satisfied by means of a lookup, the result
32225 of the lookup is made available in the &$host_data$& variable. This
32226 allows you, for example, to set up a statement like this:
32227 .code
32228 deny  hosts = net-lsearch;/some/file
32229       message = $host_data
32230 .endd
32231 which gives a custom error message for each denied host.
32232
32233 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
32234 .cindex "&%local_parts%& ACL condition"
32235 .cindex "local part" "ACL checking"
32236 .cindex "&ACL;" "testing a local part"
32237 .vindex "&$local_part_data$&"
32238 This condition is relevant only in a RCPT ACL. It checks that the local
32239 part of the recipient address is in the list. If percent-hack processing is
32240 enabled, it is done before this test. If the check succeeds with a lookup, the
32241 result of the lookup is placed in &$local_part_data$&, which remains set until
32242 the next &%local_parts%& test.
32243
32244 .vitem &*malware&~=&~*&<&'option'&>
32245 .cindex "&%malware%& ACL condition"
32246 .cindex "&ACL;" "virus scanning"
32247 .cindex "&ACL;" "scanning for viruses"
32248 This condition is available only when Exim is compiled with the
32249 content-scanning extension
32250 and only after a DATA command.
32251 It causes the incoming message to be scanned for
32252 viruses. For details, see chapter &<<CHAPexiscan>>&.
32253
32254 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32255 .cindex "&%mime_regex%& ACL condition"
32256 .cindex "&ACL;" "testing by regex matching"
32257 This condition is available only when Exim is compiled with the
32258 content-scanning extension, and it is allowed only in the ACL defined by
32259 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32260 with any of the regular expressions. For details, see chapter
32261 &<<CHAPexiscan>>&.
32262
32263 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32264 .cindex "rate limiting"
32265 This condition can be used to limit the rate at which a user or host submits
32266 messages. Details are given in section &<<SECTratelimiting>>&.
32267
32268 .vitem &*recipients&~=&~*&<&'address&~list'&>
32269 .cindex "&%recipients%& ACL condition"
32270 .cindex "recipient" "ACL checking"
32271 .cindex "&ACL;" "testing a recipient"
32272 This condition is relevant only in a RCPT ACL. It checks the entire
32273 recipient address against a list of recipients.
32274
32275 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32276 .cindex "&%regex%& ACL condition"
32277 .cindex "&ACL;" "testing by regex matching"
32278 This condition is available only when Exim is compiled with the
32279 content-scanning extension, and is available only in the DATA, MIME, and
32280 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32281 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32282
32283 .vitem &*seen&~=&~*&<&'parameters'&>
32284 .cindex "&%seen%& ACL condition"
32285 This condition can be used to test if a situation has been previously met,
32286 for example for greylisting.
32287 Details are given in section &<<SECTseen>>&.
32288
32289 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32290 .cindex "&%sender_domains%& ACL condition"
32291 .cindex "sender" "ACL checking"
32292 .cindex "&ACL;" "testing a sender domain"
32293 .vindex "&$domain$&"
32294 .vindex "&$sender_address_domain$&"
32295 This condition tests the domain of the sender of the message against the given
32296 domain list. &*Note*&: The domain of the sender address is in
32297 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32298 of this condition. This is an exception to the general rule for testing domain
32299 lists. It is done this way so that, if this condition is used in an ACL for a
32300 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32301 influence the sender checking.
32302
32303 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32304 relaying, because sender addresses are easily, and commonly, forged.
32305
32306 .vitem &*senders&~=&~*&<&'address&~list'&>
32307 .cindex "&%senders%& ACL condition"
32308 .cindex "sender" "ACL checking"
32309 .cindex "&ACL;" "testing a sender"
32310 This condition tests the sender of the message against the given list. To test
32311 for a bounce message, which has an empty sender, set
32312 .code
32313 senders = :
32314 .endd
32315 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32316 relaying, because sender addresses are easily, and commonly, forged.
32317
32318 .vitem &*spam&~=&~*&<&'username'&>
32319 .cindex "&%spam%& ACL condition"
32320 .cindex "&ACL;" "scanning for spam"
32321 This condition is available only when Exim is compiled with the
32322 content-scanning extension. It causes the incoming message to be scanned by
32323 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32324
32325 .vitem &*verify&~=&~certificate*&
32326 .cindex "&%verify%& ACL condition"
32327 .cindex "TLS" "client certificate verification"
32328 .cindex "certificate" "verification of client"
32329 .cindex "&ACL;" "certificate verification"
32330 .cindex "&ACL;" "testing a TLS certificate"
32331 This condition is true in an SMTP session if the session is encrypted, and a
32332 certificate was received from the client, and the certificate was verified. The
32333 server requests a certificate only if the client matches &%tls_verify_hosts%&
32334 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32335
32336 .vitem &*verify&~=&~csa*&
32337 .cindex "CSA verification"
32338 This condition checks whether the sending host (the client) is authorized to
32339 send email. Details of how this works are given in section
32340 &<<SECTverifyCSA>>&.
32341
32342 .vitem &*verify&~=&~header_names_ascii*&
32343 .cindex "&%verify%& ACL condition"
32344 .cindex "&ACL;" "verifying header names only ASCII"
32345 .cindex "header lines" "verifying header names only ASCII"
32346 .cindex "verifying" "header names only ASCII"
32347 This condition is relevant only in an ACL that is run after a message has been
32348 received.
32349 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32350 It checks all header names (not the content) to make sure
32351 there are no non-ASCII characters, also excluding control characters.  The
32352 allowable characters are decimal ASCII values 33 through 126.
32353
32354 Exim itself will handle headers with non-ASCII characters, but it can cause
32355 problems for downstream applications, so this option will allow their
32356 detection and rejection in the DATA ACL's.
32357
32358 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32359 .cindex "&%verify%& ACL condition"
32360 .cindex "&ACL;" "verifying sender in the header"
32361 .cindex "header lines" "verifying the sender in"
32362 .cindex "sender" "verifying in header"
32363 .cindex "verifying" "sender in header"
32364 This condition is relevant only in an ACL that is run after a message has been
32365 received, that is, in an ACL specified by &%acl_smtp_data%& or
32366 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32367 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32368 is loosely thought of as a &"sender"& address (hence the name of the test).
32369 However, an address that appears in one of these headers need not be an address
32370 that accepts bounce messages; only sender addresses in envelopes are required
32371 to accept bounces. Therefore, if you use the callout option on this check, you
32372 might want to arrange for a non-empty address in the MAIL command.
32373
32374 Details of address verification and the options are given later, starting at
32375 section &<<SECTaddressverification>>& (callouts are described in section
32376 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32377 condition to restrict it to bounce messages only:
32378 .code
32379 deny    senders = :
32380        !verify  = header_sender
32381         message = A valid sender header is required for bounces
32382 .endd
32383
32384 .vitem &*verify&~=&~header_syntax*&
32385 .cindex "&%verify%& ACL condition"
32386 .cindex "&ACL;" "verifying header syntax"
32387 .cindex "header lines" "verifying syntax"
32388 .cindex "verifying" "header syntax"
32389 This condition is relevant only in an ACL that is run after a message has been
32390 received, that is, in an ACL specified by &%acl_smtp_data%& or
32391 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32392 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32393 and &'Bcc:'&), returning true if there are no problems.
32394 Unqualified addresses (local parts without domains) are
32395 permitted only in locally generated messages and from hosts that match
32396 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32397 appropriate.
32398
32399 Note that this condition is a syntax check only. However, a common spamming
32400 ploy used to be to send syntactically invalid headers such as
32401 .code
32402 To: @
32403 .endd
32404 and this condition can be used to reject such messages, though they are not as
32405 common as they used to be.
32406
32407 .vitem &*verify&~=&~helo*&
32408 .cindex "&%verify%& ACL condition"
32409 .cindex "&ACL;" "verifying HELO/EHLO"
32410 .cindex "HELO" "verifying"
32411 .cindex "EHLO" "verifying"
32412 .cindex "verifying" "EHLO"
32413 .cindex "verifying" "HELO"
32414 This condition is true if a HELO or EHLO command has been received from the
32415 client host, and its contents have been verified. If there has been no previous
32416 attempt to verify the HELO/EHLO contents, it is carried out when this
32417 condition is encountered. See the description of the &%helo_verify_hosts%& and
32418 &%helo_try_verify_hosts%& options for details of how to request verification
32419 independently of this condition, and for detail of the verification.
32420
32421 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32422 option), this condition is always true.
32423
32424
32425 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32426 .cindex "verifying" "not blind"
32427 .cindex "bcc recipients, verifying none"
32428 This condition checks that there are no blind (bcc) recipients in the message.
32429 Every envelope recipient must appear either in a &'To:'& header line or in a
32430 &'Cc:'& header line for this condition to be true. Local parts are checked
32431 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32432 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32433 used only in a DATA or non-SMTP ACL.
32434
32435 There is one possible option, &`case_insensitive`&.  If this is present then
32436 local parts are checked case-insensitively.
32437
32438 There are, of course, many legitimate messages that make use of blind (bcc)
32439 recipients. This check should not be used on its own for blocking messages.
32440
32441
32442 .vitem &*verify&~=&~recipient/*&<&'options'&>
32443 .cindex "&%verify%& ACL condition"
32444 .cindex "&ACL;" "verifying recipient"
32445 .cindex "recipient" "verifying"
32446 .cindex "verifying" "recipient"
32447 .vindex "&$address_data$&"
32448 This condition is relevant only after a RCPT command. It verifies the current
32449 recipient. Details of address verification are given later, starting at section
32450 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32451 of &$address_data$& is the last value that was set while routing the address.
32452 This applies even if the verification fails. When an address that is being
32453 verified is redirected to a single address, verification continues with the new
32454 address, and in that case, the subsequent value of &$address_data$& is the
32455 value for the child address.
32456
32457 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32458 .cindex "&%verify%& ACL condition"
32459 .cindex "&ACL;" "verifying host reverse lookup"
32460 .cindex "host" "verifying reverse lookup"
32461 This condition ensures that a verified host name has been looked up from the IP
32462 address of the client host. (This may have happened already if the host name
32463 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32464 Verification ensures that the host name obtained from a reverse DNS lookup, or
32465 one of its aliases, does, when it is itself looked up in the DNS, yield the
32466 original IP address.
32467
32468 There is one possible option, &`defer_ok`&.  If this is present and a
32469 DNS operation returns a temporary error, the verify condition succeeds.
32470
32471 If this condition is used for a locally generated message (that is, when there
32472 is no client host involved), it always succeeds.
32473
32474 .vitem &*verify&~=&~sender/*&<&'options'&>
32475 .cindex "&%verify%& ACL condition"
32476 .cindex "&ACL;" "verifying sender"
32477 .cindex "sender" "verifying"
32478 .cindex "verifying" "sender"
32479 This condition is relevant only after a MAIL or RCPT command, or after a
32480 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32481 the message's sender is empty (that is, this is a bounce message), the
32482 condition is true. Otherwise, the sender address is verified.
32483
32484 .vindex "&$address_data$&"
32485 .vindex "&$sender_address_data$&"
32486 If there is data in the &$address_data$& variable at the end of routing, its
32487 value is placed in &$sender_address_data$& at the end of verification. This
32488 value can be used in subsequent conditions and modifiers in the same ACL
32489 statement. It does not persist after the end of the current statement. If you
32490 want to preserve the value for longer, you can save it in an ACL variable.
32491
32492 Details of verification are given later, starting at section
32493 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32494 to avoid doing it more than once per message.
32495
32496 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32497 .cindex "&%verify%& ACL condition"
32498 This is a variation of the previous option, in which a modified address is
32499 verified as a sender.
32500
32501 Note that '/' is legal in local-parts; if the address may have such
32502 (eg. is generated from the received message)
32503 they must be protected from the options parsing by doubling:
32504 .code
32505 verify = sender=${listquote{/}{${address:$h_sender:}}}
32506 .endd
32507 .endlist
32508
32509
32510
32511 .section "Using DNS lists" "SECTmorednslists"
32512 .cindex "DNS list" "in ACL"
32513 .cindex "black list (DNS)"
32514 .cindex "&ACL;" "testing a DNS list"
32515 In its simplest form, the &%dnslists%& condition tests whether the calling host
32516 is on at least one of a number of DNS lists by looking up the inverted IP
32517 address in one or more DNS domains. (Note that DNS list domains are not mail
32518 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32519 special options instead.) For example, if the calling host's IP
32520 address is 192.168.62.43, and the ACL statement is
32521 .code
32522 deny dnslists = blackholes.mail-abuse.org : \
32523                 dialups.mail-abuse.org
32524 .endd
32525 the following records are looked up:
32526 .code
32527 43.62.168.192.blackholes.mail-abuse.org
32528 43.62.168.192.dialups.mail-abuse.org
32529 .endd
32530 As soon as Exim finds an existing DNS record, processing of the list stops.
32531 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32532 to test that a host is on more than one list (an &"and"& conjunction), you can
32533 use two separate conditions:
32534 .code
32535 deny dnslists = blackholes.mail-abuse.org
32536      dnslists = dialups.mail-abuse.org
32537 .endd
32538 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32539 behaves as if the host does not match the list item, that is, as if the DNS
32540 record does not exist. If there are further items in the DNS list, they are
32541 processed.
32542
32543 This is usually the required action when &%dnslists%& is used with &%deny%&
32544 (which is the most common usage), because it prevents a DNS failure from
32545 blocking mail. However, you can change this behaviour by putting one of the
32546 following special items in the list:
32547 .itable none 0 0 2 25* left 75* left
32548 .irow "+include_unknown"   "behave as if the item is on the list"
32549 .irow "+exclude_unknown"   "behave as if the item is not on the list (default)"
32550 .irow "+defer_unknown  "   "give a temporary error"
32551 .endtable
32552 .cindex "&`+include_unknown`&"
32553 .cindex "&`+exclude_unknown`&"
32554 .cindex "&`+defer_unknown`&"
32555 Each of these applies to any subsequent items on the list. For example:
32556 .code
32557 deny dnslists = +defer_unknown : foo.bar.example
32558 .endd
32559 Testing the list of domains stops as soon as a match is found. If you want to
32560 warn for one list and block for another, you can use two different statements:
32561 .code
32562 deny  dnslists = blackholes.mail-abuse.org
32563 warn  dnslists = dialups.mail-abuse.org
32564       message  = X-Warn: sending host is on dialups list
32565 .endd
32566 .cindex caching "of dns lookup"
32567 .cindex DNS TTL
32568 DNS list lookups are cached by Exim for the duration of the SMTP session
32569 (but limited by the DNS return TTL value),
32570 so a lookup based on the IP address is done at most once for any incoming
32571 connection (assuming long-enough TTL).
32572 Exim does not share information between multiple incoming
32573 connections (but your local name server cache should be active).
32574
32575 There are a number of DNS lists to choose from, some commercial, some free,
32576 or free for small deployments.  An overview can be found at
32577 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32578
32579
32580
32581 .subsection "Specifying the IP address for a DNS list lookup" SECID201
32582 .cindex "DNS list" "keyed by explicit IP address"
32583 By default, the IP address that is used in a DNS list lookup is the IP address
32584 of the calling host. However, you can specify another IP address by listing it
32585 after the domain name, introduced by a slash. For example:
32586 .code
32587 deny dnslists = black.list.tld/192.168.1.2
32588 .endd
32589 This feature is not very helpful with explicit IP addresses; it is intended for
32590 use with IP addresses that are looked up, for example, the IP addresses of the
32591 MX hosts or nameservers of an email sender address. For an example, see section
32592 &<<SECTmulkeyfor>>& below.
32593
32594
32595
32596
32597 .subsection "DNS lists keyed on domain names" SECID202
32598 .cindex "DNS list" "keyed by domain name"
32599 There are some lists that are keyed on domain names rather than inverted IP
32600 addresses (see, e.g., the &'domain based zones'& link at
32601 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32602 with these lists. You can change the name that is looked up in a DNS list by
32603 listing it after the domain name, introduced by a slash. For example,
32604 .code
32605 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32606       message  = Sender's domain is listed at $dnslist_domain
32607 .endd
32608 This particular example is useful only in ACLs that are obeyed after the
32609 RCPT or DATA commands, when a sender address is available. If (for
32610 example) the message's sender is &'user@tld.example'& the name that is looked
32611 up by this example is
32612 .code
32613 tld.example.dsn.rfc-ignorant.org
32614 .endd
32615 A single &%dnslists%& condition can contain entries for both names and IP
32616 addresses. For example:
32617 .code
32618 deny dnslists = sbl.spamhaus.org : \
32619                 dsn.rfc-ignorant.org/$sender_address_domain
32620 .endd
32621 The first item checks the sending host's IP address; the second checks a domain
32622 name. The whole condition is true if either of the DNS lookups succeeds.
32623
32624
32625
32626
32627 .subsection "Multiple explicit keys for a DNS list" SECTmulkeyfor
32628 .cindex "DNS list" "multiple keys for"
32629 The syntax described above for looking up explicitly-defined values (either
32630 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32631 name for the DNS list, what follows the slash can in fact be a list of items.
32632 As with all lists in Exim, the default separator is a colon. However, because
32633 this is a sublist within the list of DNS blacklist domains, it is necessary
32634 either to double the separators like this:
32635 .code
32636 dnslists = black.list.tld/name.1::name.2
32637 .endd
32638 or to change the separator character, like this:
32639 .code
32640 dnslists = black.list.tld/<;name.1;name.2
32641 .endd
32642 If an item in the list is an IP address, it is inverted before the DNS
32643 blacklist domain is appended. If it is not an IP address, no inversion
32644 occurs. Consider this condition:
32645 .code
32646 dnslists = black.list.tld/<;192.168.1.2;a.domain
32647 .endd
32648 The DNS lookups that occur are:
32649 .code
32650 2.1.168.192.black.list.tld
32651 a.domain.black.list.tld
32652 .endd
32653 Once a DNS record has been found (that matches a specific IP return
32654 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32655 are done. If there is a temporary DNS error, the rest of the sublist of domains
32656 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32657 only if no other DNS lookup in this sublist succeeds. In other words, a
32658 successful lookup for any of the items in the sublist overrides a temporary
32659 error for a previous item.
32660
32661 The ability to supply a list of items after the slash is in some sense just a
32662 syntactic convenience. These two examples have the same effect:
32663 .code
32664 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32665 dnslists = black.list.tld/a.domain::b.domain
32666 .endd
32667 However, when the data for the list is obtained from a lookup, the second form
32668 is usually much more convenient. Consider this example:
32669 .code
32670 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32671                                    ${lookup dnsdb {>|mxh=\
32672                                    $sender_address_domain} }} }
32673      message  = The mail servers for the domain \
32674                 $sender_address_domain \
32675                 are listed at $dnslist_domain ($dnslist_value); \
32676                 see $dnslist_text.
32677 .endd
32678 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32679 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32680 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32681 of expanding the condition might be something like this:
32682 .code
32683 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32684 .endd
32685 Thus, this example checks whether or not the IP addresses of the sender
32686 domain's mail servers are on the Spamhaus black list.
32687
32688 The key that was used for a successful DNS list lookup is put into the variable
32689 &$dnslist_matched$& (see section &<<SECID204>>&).
32690
32691
32692
32693
32694 .subsection "Data returned by DNS lists" SECID203
32695 .cindex "DNS list" "data returned from"
32696 DNS lists are constructed using address records in the DNS. The original RBL
32697 just used the address 127.0.0.1 on the right hand side of each record, but the
32698 RBL+ list and some other lists use a number of values with different meanings.
32699 The values used on the RBL+ list are:
32700 .itable none 0 0 2 20* left 80* left
32701 .irow 127.1.0.1  "RBL"
32702 .irow 127.1.0.2  "DUL"
32703 .irow 127.1.0.3  "DUL and RBL"
32704 .irow 127.1.0.4  "RSS"
32705 .irow 127.1.0.5  "RSS and RBL"
32706 .irow 127.1.0.6  "RSS and DUL"
32707 .irow 127.1.0.7  "RSS and DUL and RBL"
32708 .endtable
32709 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32710 different values. Some DNS lists may return more than one address record;
32711 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32712
32713 Values returned by a properly running DBSBL should be in the 127.0.0.0/8
32714 range. If a DNSBL operator loses control of the domain, lookups on it
32715 may start returning other addresses.  Because of this, Exim now ignores
32716 returned values outside the 127/8 region.
32717
32718
32719 .subsection "Variables set from DNS lists" SECID204
32720 .cindex "expansion" "variables, set from DNS list"
32721 .cindex "DNS list" "variables set from"
32722 .vindex "&$dnslist_domain$&"
32723 .vindex "&$dnslist_matched$&"
32724 .vindex "&$dnslist_text$&"
32725 .vindex "&$dnslist_value$&"
32726 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32727 the name of the overall domain that matched (for example,
32728 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32729 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32730 the DNS record. When the key is an IP address, it is not reversed in
32731 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32732 cases, for example:
32733 .code
32734 deny dnslists = spamhaus.example
32735 .endd
32736 the key is also available in another variable (in this case,
32737 &$sender_host_address$&). In more complicated cases, however, this is not true.
32738 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32739 might generate a dnslists lookup like this:
32740 .code
32741 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32742 .endd
32743 If this condition succeeds, the value in &$dnslist_matched$& might be
32744 &`192.168.6.7`& (for example).
32745
32746 If more than one address record is returned by the DNS lookup, all the IP
32747 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32748 The variable &$dnslist_text$& contains the contents of any associated TXT
32749 record. For lists such as RBL+ the TXT record for a merged entry is often not
32750 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32751 information.
32752
32753 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32754 &-- even if these appear before the condition in the ACL, they are not
32755 expanded until after it has failed. For example:
32756 .code
32757 deny    hosts = !+local_networks
32758         message = $sender_host_address is listed \
32759                   at $dnslist_domain
32760         dnslists = rbl-plus.mail-abuse.example
32761 .endd
32762
32763
32764
32765 .subsection "Additional matching conditions for DNS lists" SECTaddmatcon
32766 .cindex "DNS list" "matching specific returned data"
32767 You can add an equals sign and an IP address after a &%dnslists%& domain name
32768 in order to restrict its action to DNS records with a matching right hand side.
32769 For example,
32770 .code
32771 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32772 .endd
32773 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32774 any address record is considered to be a match. For the moment, we assume
32775 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32776 describes how multiple records are handled.
32777
32778 More than one IP address may be given for checking, using a comma as a
32779 separator. These are alternatives &-- if any one of them matches, the
32780 &%dnslists%& condition is true. For example:
32781 .code
32782 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32783 .endd
32784 If you want to specify a constraining address list and also specify names or IP
32785 addresses to be looked up, the constraining address list must be specified
32786 first. For example:
32787 .code
32788 deny dnslists = dsn.rfc-ignorant.org\
32789                 =127.0.0.2/$sender_address_domain
32790 .endd
32791
32792 If the character &`&&`& is used instead of &`=`&, the comparison for each
32793 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32794 In other words, the listed addresses are used as bit masks. The comparison is
32795 true if all the bits in the mask are present in the address that is being
32796 tested. For example:
32797 .code
32798 dnslists = a.b.c&0.0.0.3
32799 .endd
32800 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32801 want to test whether one bit or another bit is present (as opposed to both
32802 being present), you must use multiple values. For example:
32803 .code
32804 dnslists = a.b.c&0.0.0.1,0.0.0.2
32805 .endd
32806 matches if the final component of the address is an odd number or two times
32807 an odd number.
32808
32809
32810
32811 .subsection "Negated DNS matching conditions" SECID205
32812 You can supply a negative list of IP addresses as part of a &%dnslists%&
32813 condition. Whereas
32814 .code
32815 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32816 .endd
32817 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32818 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32819 .code
32820 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32821 .endd
32822 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32823 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32824 words, the result of the test is inverted if an exclamation mark appears before
32825 the &`=`& (or the &`&&`&) sign.
32826
32827 &*Note*&: This kind of negation is not the same as negation in a domain,
32828 host, or address list (which is why the syntax is different).
32829
32830 If you are using just one list, the negation syntax does not gain you much. The
32831 previous example is precisely equivalent to
32832 .code
32833 deny  dnslists = a.b.c
32834      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32835 .endd
32836 However, if you are using multiple lists, the negation syntax is clearer.
32837 Consider this example:
32838 .code
32839 deny  dnslists = sbl.spamhaus.org : \
32840                  list.dsbl.org : \
32841                  dnsbl.njabl.org!=127.0.0.3 : \
32842                  relays.ordb.org
32843 .endd
32844 Using only positive lists, this would have to be:
32845 .code
32846 deny  dnslists = sbl.spamhaus.org : \
32847                  list.dsbl.org
32848 deny  dnslists = dnsbl.njabl.org
32849      !dnslists = dnsbl.njabl.org=127.0.0.3
32850 deny  dnslists = relays.ordb.org
32851 .endd
32852 which is less clear, and harder to maintain.
32853
32854 Negation can also be used with a bitwise-and restriction.
32855 The dnslists condition with only be trus if a result is returned
32856 by the lookup which, anded with the restriction, is all zeroes.
32857 For example:
32858 .code
32859 deny dnslists = zen.spamhaus.org!&0.255.255.0
32860 .endd
32861
32862
32863
32864
32865 .subsection "Handling multiple DNS records from a DNS list" SECThanmuldnsrec
32866 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
32867 thereby providing more than one IP address. When an item in a &%dnslists%& list
32868 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
32869 the match to specific results from the DNS lookup, there are two ways in which
32870 the checking can be handled. For example, consider the condition:
32871 .code
32872 dnslists = a.b.c=127.0.0.1
32873 .endd
32874 What happens if the DNS lookup for the incoming IP address yields both
32875 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
32876 condition true because at least one given value was found, or is it false
32877 because at least one of the found values was not listed? And how does this
32878 affect negated conditions? Both possibilities are provided for with the help of
32879 additional separators &`==`& and &`=&&`&.
32880
32881 .ilist
32882 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
32883 IP addresses matches one of the listed addresses. For the example above, the
32884 condition is true because 127.0.0.1 matches.
32885 .next
32886 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
32887 looked up IP addresses matches one of the listed addresses. If the condition is
32888 changed to:
32889 .code
32890 dnslists = a.b.c==127.0.0.1
32891 .endd
32892 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32893 false because 127.0.0.2 is not listed. You would need to have:
32894 .code
32895 dnslists = a.b.c==127.0.0.1,127.0.0.2
32896 .endd
32897 for the condition to be true.
32898 .endlist
32899
32900 When &`!`& is used to negate IP address matching, it inverts the result, giving
32901 the precise opposite of the behaviour above. Thus:
32902 .ilist
32903 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
32904 addresses matches one of the listed addresses. Consider:
32905 .code
32906 dnslists = a.b.c!&0.0.0.1
32907 .endd
32908 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32909 false because 127.0.0.1 matches.
32910 .next
32911 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
32912 looked up IP address that does not match. Consider:
32913 .code
32914 dnslists = a.b.c!=&0.0.0.1
32915 .endd
32916 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32917 true, because 127.0.0.2 does not match. You would need to have:
32918 .code
32919 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
32920 .endd
32921 for the condition to be false.
32922 .endlist
32923 When the DNS lookup yields only a single IP address, there is no difference
32924 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
32925
32926
32927
32928
32929 .subsection "Detailed information from merged DNS lists" SECTmordetinf
32930 .cindex "DNS list" "information from merged"
32931 When the facility for restricting the matching IP values in a DNS list is used,
32932 the text from the TXT record that is set in &$dnslist_text$& may not reflect
32933 the true reason for rejection. This happens when lists are merged and the IP
32934 address in the A record is used to distinguish them; unfortunately there is
32935 only one TXT record. One way round this is not to use merged lists, but that
32936 can be inefficient because it requires multiple DNS lookups where one would do
32937 in the vast majority of cases when the host of interest is not on any of the
32938 lists.
32939
32940 A less inefficient way of solving this problem is available. If
32941 two domain names, comma-separated, are given, the second is used first to
32942 do an initial check, making use of any IP value restrictions that are set.
32943 If there is a match, the first domain is used, without any IP value
32944 restrictions, to get the TXT record. As a byproduct of this, there is also
32945 a check that the IP being tested is indeed on the first list. The first
32946 domain is the one that is put in &$dnslist_domain$&. For example:
32947 .code
32948 deny   dnslists = \
32949          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
32950          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32951        message  = \
32952          rejected because $sender_host_address is blacklisted \
32953          at $dnslist_domain\n$dnslist_text
32954 .endd
32955 For the first blacklist item, this starts by doing a lookup in
32956 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
32957 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
32958 value, and as long as something is found, it looks for the corresponding TXT
32959 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
32960 The second blacklist item is processed similarly.
32961
32962 If you are interested in more than one merged list, the same list must be
32963 given several times, but because the results of the DNS lookups are cached,
32964 the DNS calls themselves are not repeated. For example:
32965 .code
32966 deny dnslists = \
32967          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
32968          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
32969          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
32970          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32971 .endd
32972 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
32973 values matches (or if no record is found), this is the only lookup that is
32974 done. Only if there is a match is one of the more specific lists consulted.
32975
32976
32977
32978 .subsection "DNS lists and IPv6" SECTmorednslistslast
32979 .cindex "IPv6" "DNS black lists"
32980 .cindex "DNS list" "IPv6 usage"
32981 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
32982 nibble by nibble. For example, if the calling host's IP address is
32983 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
32984 .code
32985 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
32986   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
32987 .endd
32988 (split over two lines here to fit on the page). Unfortunately, some of the DNS
32989 lists contain wildcard records, intended for IPv4, that interact badly with
32990 IPv6. For example, the DNS entry
32991 .code
32992 *.3.some.list.example.    A    127.0.0.1
32993 .endd
32994 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
32995 Unfortunately, it also matches the entire 3::/4 IPv6 network.
32996
32997 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
32998 &%condition%& condition, as in this example:
32999 .code
33000 deny   condition = ${if isip4{$sender_host_address}}
33001        dnslists  = some.list.example
33002 .endd
33003
33004 If an explicit key is being used for a DNS lookup and it may be an IPv6
33005 address you should specify alternate list separators for both the outer
33006 (DNS list name) list and inner (lookup keys) list:
33007 .code
33008        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
33009 .endd
33010
33011
33012 .section "Previously seen user and hosts" "SECTseen"
33013 .cindex "&%seen%& ACL condition"
33014 .cindex greylisting
33015 The &%seen%& ACL condition can be used to test whether a
33016 situation has been previously met.
33017 It uses a hints database to record a timestamp against a key.
33018 The syntax of the condition is:
33019 .display
33020 &`seen =`& <&'optional flag'&><&'time interval'&> &`/`& <&'options'&>
33021 .endd
33022
33023 For example,
33024 .code
33025 defer   seen = -5m / key=${sender_host_address}_$local_part@$domain
33026 .endd
33027 in a RCPT ACL will implement simple greylisting.
33028
33029 The parameters for the condition are
33030 a possible minus sign,
33031 then an interval,
33032 then, slash-separated, a list of options.
33033 The interval is taken as an offset before the current time,
33034 and used for the test.
33035 If the interval is preceded by a minus sign then the condition returns
33036 whether a record is found which is before the test time.
33037 Otherwise, the condition returns whether one is found which is since the
33038 test time.
33039
33040 Options are read in order with later ones overriding earlier ones.
33041
33042 The default key is &$sender_host_address$&.
33043 An explicit key can be set using a &%key=value%& option.
33044
33045 If a &%readonly%& option is given then
33046 no record create or update is done.
33047 If a &%write%& option is given then
33048 a record create or update is always done.
33049 An update is done if the test is for &"since"&.
33050 If none of those hold and there was no existing record,
33051 a record is created.
33052
33053 Creates and updates are marked with the current time.
33054
33055 Finally, a &"before"& test which succeeds, and for which the record
33056 is old enough, will be refreshed with a timestamp of the test time.
33057 This can prevent tidying of the database from removing the entry.
33058 The interval for this is, by default, 10 days.
33059 An explicit interval can be set using a
33060 &%refresh=value%& option.
33061
33062 Note that &"seen"& should be added to the list of hints databases
33063 for maintenance if this ACL condition is used.
33064
33065
33066 .section "Rate limiting incoming messages" "SECTratelimiting"
33067 .cindex "rate limiting" "client sending"
33068 .cindex "limiting client sending rates"
33069 .oindex "&%smtp_ratelimit_*%&"
33070 The &%ratelimit%& ACL condition can be used to measure and control the rate at
33071 which clients can send email. This is more powerful than the
33072 &%smtp_ratelimit_*%& options, because those options control the rate of
33073 commands in a single SMTP session only, whereas the &%ratelimit%& condition
33074 works across all connections (concurrent and sequential) from the same client
33075 host. The syntax of the &%ratelimit%& condition is:
33076 .display
33077 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
33078 .endd
33079 If the average client sending rate is less than &'m'& messages per time
33080 period &'p'& then the condition is false; otherwise it is true.
33081
33082 As a side-effect, the &%ratelimit%& condition sets the expansion variable
33083 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
33084 configured value of &'m'&, and &$sender_rate_period$& to the configured value
33085 of &'p'&.
33086
33087 The parameter &'p'& is the smoothing time constant, in the form of an Exim
33088 time interval, for example, &`8h`& for eight hours. A larger time constant
33089 means that it takes Exim longer to forget a client's past behaviour. The
33090 parameter &'m'& is the maximum number of messages that a client is permitted to
33091 send in each time interval. It also specifies the number of messages permitted
33092 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
33093 constant, you can allow a client to send more messages in a burst without
33094 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
33095 both small, messages must be sent at an even rate.
33096
33097 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
33098 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
33099 when deploying the &%ratelimit%& ACL condition. The script prints usage
33100 instructions when it is run with no arguments.
33101
33102 The key is used to look up the data for calculating the client's average
33103 sending rate. This data is stored in Exim's spool directory, alongside the
33104 retry and other hints databases. The default key is &$sender_host_address$&,
33105 which means Exim computes the sending rate of each client host IP address.
33106 By changing the key you can change how Exim identifies clients for the purpose
33107 of ratelimiting. For example, to limit the sending rate of each authenticated
33108 user, independent of the computer they are sending from, set the key to
33109 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
33110 example, &$authenticated_id$& is only meaningful if the client has
33111 authenticated (which you can check with the &%authenticated%& ACL condition).
33112
33113 The lookup key does not have to identify clients: If you want to limit the
33114 rate at which a recipient receives messages, you can use the key
33115 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
33116 ACL.
33117
33118 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
33119 specifies what Exim measures the rate of, for example, messages or recipients
33120 or bytes. You can adjust the measurement using the &%unique=%& and/or
33121 &%count=%& options. You can also control when Exim updates the recorded rate
33122 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
33123 separated by a slash, like the other parameters. They may appear in any order.
33124
33125 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
33126 any options that alter the meaning of the stored data. The limit &'m'& is not
33127 stored, so you can alter the configured maximum rate and Exim will still
33128 remember clients' past behaviour. If you change the &%per_*%& mode or add or
33129 remove the &%unique=%& option, the lookup key changes so Exim will forget past
33130 behaviour. The lookup key is not affected by changes to the update mode and
33131 the &%count=%& option.
33132
33133
33134 .subsection "Ratelimit options for what is being measured" ratoptmea
33135 .cindex "rate limiting" "per_* options"
33136 .vlist
33137 .vitem per_conn
33138 .cindex "rate limiting" per_conn
33139 This option limits the client's connection rate. It is not
33140 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
33141 &%acl_not_smtp_start%& ACLs.
33142
33143 .vitem per_mail
33144 .cindex "rate limiting" per_conn
33145 This option limits the client's rate of sending messages. This is
33146 the default if none of the &%per_*%& options is specified. It can be used in
33147 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
33148 &%acl_smtp_data%&, or &%acl_not_smtp%&.
33149
33150 .vitem per_byte
33151 .cindex "rate limiting" per_conn
33152 This option limits the sender's email bandwidth. It can be used in
33153 the same ACLs as the &%per_mail%& option, though it is best to use this option
33154 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
33155 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
33156 in its MAIL command, which may be inaccurate or completely missing. You can
33157 follow the limit &'m'& in the configuration with K, M, or G to specify limits
33158 in kilobytes, megabytes, or gigabytes, respectively.
33159
33160 .vitem per_rcpt
33161 .cindex "rate limiting" per_rcpt
33162 This option causes Exim to limit the rate at which recipients are
33163 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
33164 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
33165 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
33166 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
33167 in either case the rate limiting engine will see a message with many
33168 recipients as a large high-speed burst.
33169
33170 .vitem per_addr
33171 .cindex "rate limiting" per_addr
33172 This option is like the &%per_rcpt%& option, except it counts the
33173 number of different recipients that the client has sent messages to in the
33174 last time period. That is, if the client repeatedly sends messages to the same
33175 recipient, its measured rate is not increased. This option can only be used in
33176 &%acl_smtp_rcpt%&.
33177
33178 .vitem per_cmd
33179 .cindex "rate limiting" per_cmd
33180 This option causes Exim to recompute the rate every time the
33181 condition is processed. This can be used to limit the rate of any SMTP
33182 command. If it is used in multiple ACLs it can limit the aggregate rate of
33183 multiple different commands.
33184
33185 .vitem count
33186 .cindex "rate limiting" count
33187 This option can be used to alter how much Exim adds to the client's
33188 measured rate.
33189 A value is required, after an equals sign.
33190 For example, the &%per_byte%& option is equivalent to
33191 &`per_mail/count=$message_size`&.
33192 If there is no &%count=%& option, Exim
33193 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
33194 other than &%acl_smtp_rcpt%&).
33195 The count does not have to be an integer.
33196
33197 .vitem unique
33198 .cindex "rate limiting" unique
33199 This option is described in section &<<ratoptuniq>>& below.
33200 .endlist
33201
33202
33203 .subsection "Ratelimit update modes" ratoptupd
33204 .cindex "rate limiting" "reading data without updating"
33205 You can specify one of three options with the &%ratelimit%& condition to
33206 control when its database is updated. This section describes the &%readonly%&
33207 mode, and the next section describes the &%strict%& and &%leaky%& modes.
33208
33209 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
33210 previously-computed rate to check against the limit.
33211
33212 For example, you can test the client's sending rate and deny it access (when
33213 it is too fast) in the connect ACL. If the client passes this check then it
33214 can go on to send a message, in which case its recorded rate will be updated
33215 in the MAIL ACL. Subsequent connections from the same client will check this
33216 new rate.
33217 .code
33218 acl_check_connect:
33219  deny ratelimit = 100 / 5m / readonly
33220       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
33221                   (max $sender_rate_limit)
33222 # ...
33223 acl_check_mail:
33224  warn ratelimit = 100 / 5m / strict
33225       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
33226                   (max $sender_rate_limit)
33227 .endd
33228
33229 If Exim encounters multiple &%ratelimit%& conditions with the same key when
33230 processing a message then it may increase the client's measured rate more than
33231 it should. For example, this will happen if you check the &%per_rcpt%& option
33232 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
33233 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
33234 multiple update problems by using the &%readonly%& option on later ratelimit
33235 checks.
33236
33237 The &%per_*%& options described above do not make sense in some ACLs. If you
33238 use a &%per_*%& option in an ACL where it is not normally permitted then the
33239 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
33240 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
33241 next section) so you must specify the &%readonly%& option explicitly.
33242
33243
33244 .subsection "Ratelimit options for handling fast clients" ratoptfast
33245 .cindex "rate limiting" "strict and leaky modes"
33246 If a client's average rate is greater than the maximum, the rate limiting
33247 engine can react in two possible ways, depending on the presence of the
33248 &%strict%& or &%leaky%& update modes. This is independent of the other
33249 counter-measures (such as rejecting the message) that may be specified by the
33250 rest of the ACL.
33251
33252 The &%leaky%& (default) option means that the client's recorded rate is not
33253 updated if it is above the limit. The effect of this is that Exim measures the
33254 client's average rate of successfully sent email,
33255 up to the given limit.
33256 This is appropriate if the countermeasure when the condition is true
33257 consists of refusing the message, and
33258 is generally the better choice if you have clients that retry automatically.
33259 If the action when true is anything more complex then this option is
33260 likely not what is wanted.
33261
33262 The &%strict%& option means that the client's recorded rate is always
33263 updated. The effect of this is that Exim measures the client's average rate
33264 of attempts to send email, which can be much higher than the maximum it is
33265 actually allowed. If the client is over the limit it may be subjected to
33266 counter-measures by the ACL. It must slow down and allow sufficient time to
33267 pass that its computed rate falls below the maximum before it can send email
33268 again. The time (the number of smoothing periods) it must wait and not
33269 attempt to send mail can be calculated with this formula:
33270 .code
33271         ln(peakrate/maxrate)
33272 .endd
33273
33274
33275 .subsection "Limiting the rate of different events" ratoptuniq
33276 .cindex "rate limiting" "counting unique events"
33277 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
33278 rate of different events. For example, the &%per_addr%& option uses this
33279 mechanism to count the number of different recipients that the client has
33280 sent messages to in the last time period; it is equivalent to
33281 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
33282 measure the rate that a client uses different sender addresses with the
33283 options &`per_mail/unique=$sender_address`&.
33284
33285 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
33286 has seen for that key. The whole set is thrown away when it is older than the
33287 rate smoothing period &'p'&, so each different event is counted at most once
33288 per period. In the &%leaky%& update mode, an event that causes the client to
33289 go over the limit is not added to the set, in the same way that the client's
33290 recorded rate is not updated in the same situation.
33291
33292 When you combine the &%unique=%& and &%readonly%& options, the specific
33293 &%unique=%& value is ignored, and Exim just retrieves the client's stored
33294 rate.
33295
33296 The &%unique=%& mechanism needs more space in the ratelimit database than the
33297 other &%ratelimit%& options in order to store the event set. The number of
33298 unique values is potentially as large as the rate limit, so the extra space
33299 required increases with larger limits.
33300
33301 The uniqueification is not perfect: there is a small probability that Exim
33302 will think a new event has happened before. If the sender's rate is less than
33303 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
33304 the measured rate can go above the limit, in which case Exim may under-count
33305 events by a significant margin. Fortunately, if the rate is high enough (2.7
33306 times the limit) that the false positive rate goes above 9%, then Exim will
33307 throw away the over-full event set before the measured rate falls below the
33308 limit. Therefore the only harm should be that exceptionally high sending rates
33309 are logged incorrectly; any countermeasures you configure will be as effective
33310 as intended.
33311
33312
33313 .subsection "Using rate limiting" useratlim
33314 Exim's other ACL facilities are used to define what counter-measures are taken
33315 when the rate limit is exceeded. This might be anything from logging a warning
33316 (for example, while measuring existing sending rates in order to define
33317 policy), through time delays to slow down fast senders, up to rejecting the
33318 message. For example:
33319 .code
33320 # Log all senders' rates
33321 warn ratelimit = 0 / 1h / strict
33322      log_message = Sender rate $sender_rate / $sender_rate_period
33323
33324 # Slow down fast senders; note the need to truncate $sender_rate
33325 # at the decimal point.
33326 warn ratelimit = 100 / 1h / per_rcpt / strict
33327      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
33328                    $sender_rate_limit }s
33329
33330 # Keep authenticated users under control
33331 deny authenticated = *
33332      ratelimit = 100 / 1d / strict / $authenticated_id
33333
33334 # System-wide rate limit
33335 defer ratelimit = 10 / 1s / $primary_hostname
33336       message = Sorry, too busy. Try again later.
33337
33338 # Restrict incoming rate from each host, with a default
33339 # set using a macro and special cases looked up in a table.
33340 defer ratelimit = ${lookup {$sender_host_address} \
33341                    cdb {DB/ratelimits.cdb} \
33342                    {$value} {RATELIMIT} }
33343       message = Sender rate exceeds $sender_rate_limit \
33344                messages per $sender_rate_period
33345 .endd
33346 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
33347 especially with the &%per_rcpt%& option, you may suffer from a performance
33348 bottleneck caused by locking on the ratelimit hints database. Apart from
33349 making your ACLs less complicated, you can reduce the problem by using a
33350 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
33351 this means that Exim will lose its hints data after a reboot (including retry
33352 hints, the callout cache, and ratelimit data).
33353
33354
33355
33356 .section "Address verification" "SECTaddressverification"
33357 .cindex "verifying address" "options for"
33358 .cindex "policy control" "address verification"
33359 Several of the &%verify%& conditions described in section
33360 &<<SECTaclconditions>>& cause addresses to be verified. Section
33361 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33362 The verification conditions can be followed by options that modify the
33363 verification process. The options are separated from the keyword and from each
33364 other by slashes, and some of them contain parameters. For example:
33365 .code
33366 verify = sender/callout
33367 verify = recipient/defer_ok/callout=10s,defer_ok
33368 .endd
33369 The first stage of address verification, which always happens, is to run the
33370 address through the routers, in &"verify mode"&. Routers can detect the
33371 difference between verification and routing for delivery, and their actions can
33372 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33373 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33374 The available options are as follows:
33375
33376 .ilist
33377 If the &%callout%& option is specified, successful routing to one or more
33378 remote hosts is followed by a &"callout"& to those hosts as an additional
33379 check. Callouts and their sub-options are discussed in the next section.
33380 .next
33381 If there is a defer error while doing verification routing, the ACL
33382 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33383 options, the condition is forced to be true instead. Note that this is a main
33384 verification option as well as a suboption for callouts.
33385 .next
33386 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33387 discusses the reporting of sender address verification failures.
33388 .next
33389 The &%success_on_redirect%& option causes verification always to succeed
33390 immediately after a successful redirection. By default, if a redirection
33391 generates just one address, that address is also verified. See further
33392 discussion in section &<<SECTredirwhilveri>>&.
33393 .next
33394 If the &%quota%& option is specified for recipient verify,
33395 successful routing to an appendfile transport is followed by a call into
33396 the transport to evaluate the quota status for the recipient.
33397 No actual delivery is done, but verification will succeed if the quota
33398 is sufficient for the message (if the sender gave a message size) or
33399 not already exceeded (otherwise).
33400 .endlist
33401
33402 .cindex "verifying address" "differentiating failures"
33403 .vindex "&$recipient_verify_failure$&"
33404 .vindex "&$sender_verify_failure$&"
33405 .vindex "&$acl_verify_message$&"
33406 After an address verification failure, &$acl_verify_message$& contains the
33407 error message that is associated with the failure. It can be preserved by
33408 coding like this:
33409 .code
33410 warn  !verify = sender
33411        set acl_m0 = $acl_verify_message
33412 .endd
33413 If you are writing your own custom rejection message or log message when
33414 denying access, you can use this variable to include information about the
33415 verification failure.
33416 This variable is cleared at the end of processing the ACL verb.
33417
33418 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33419 appropriate) contains one of the following words:
33420
33421 .ilist
33422 &%qualify%&: The address was unqualified (no domain), and the message
33423 was neither local nor came from an exempted host.
33424 .next
33425 &%route%&: Routing failed.
33426 .next
33427 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33428 occurred at or before the MAIL command (that is, on initial
33429 connection, HELO, or MAIL).
33430 .next
33431 &%recipient%&: The RCPT command in a callout was rejected.
33432 .next
33433 &%postmaster%&: The postmaster check in a callout was rejected.
33434 .next
33435 &%quota%&: The quota check for a local recipient did non pass.
33436 .endlist
33437
33438 The main use of these variables is expected to be to distinguish between
33439 rejections of MAIL and rejections of RCPT in callouts.
33440
33441 The above variables may also be set after a &*successful*&
33442 address verification to:
33443
33444 .ilist
33445 &%random%&: A random local-part callout succeeded
33446 .endlist
33447
33448
33449
33450
33451 .section "Callout verification" "SECTcallver"
33452 .cindex "verifying address" "by callout"
33453 .cindex "callout" "verification"
33454 .cindex "SMTP" "callout verification"
33455 For non-local addresses, routing verifies the domain, but is unable to do any
33456 checking of the local part. There are situations where some means of verifying
33457 the local part is desirable. One way this can be done is to make an SMTP
33458 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33459 a subsequent host for a recipient address, to see if the host accepts the
33460 address. We use the term &'callout'& to cover both cases. Note that for a
33461 sender address, the callback is not to the client host that is trying to
33462 deliver the message, but to one of the hosts that accepts incoming mail for the
33463 sender's domain.
33464
33465 Exim does not do callouts by default. If you want them to happen, you must
33466 request them by setting appropriate options on the &%verify%& condition, as
33467 described below. This facility should be used with care, because it can add a
33468 lot of resource usage to the cost of verifying an address. However, Exim does
33469 cache the results of callouts, which helps to reduce the cost. Details of
33470 caching are in section &<<SECTcallvercache>>&.
33471
33472 Recipient callouts are usually used only between hosts that are controlled by
33473 the same administration. For example, a corporate gateway host could use
33474 callouts to check for valid recipients on an internal mailserver. A successful
33475 callout does not guarantee that a real delivery to the address would succeed;
33476 on the other hand, a failing callout does guarantee that a delivery would fail.
33477
33478 If the &%callout%& option is present on a condition that verifies an address, a
33479 second stage of verification occurs if the address is successfully routed to
33480 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33481 &(manualroute)& router, where the router specifies the hosts. However, if a
33482 router that does not set up hosts routes to an &(smtp)& transport with a
33483 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33484 &%hosts_override%& set, its hosts are always used, whether or not the router
33485 supplies a host list.
33486 Callouts are only supported on &(smtp)& transports.
33487
33488 The port that is used is taken from the transport, if it is specified and is a
33489 remote transport. (For routers that do verification only, no transport need be
33490 specified.) Otherwise, the default SMTP port is used. If a remote transport
33491 specifies an outgoing interface, this is used; otherwise the interface is not
33492 specified. Likewise, the text that is used for the HELO command is taken from
33493 the transport's &%helo_data%& option; if there is no transport, the value of
33494 &$smtp_active_hostname$& is used.
33495
33496 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33497 test whether a bounce message could be delivered to the sender address. The
33498 following SMTP commands are sent:
33499 .display
33500 &`HELO `&<&'local host name'&>
33501 &`MAIL FROM:<>`&
33502 &`RCPT TO:`&<&'the address to be tested'&>
33503 &`QUIT`&
33504 .endd
33505 LHLO is used instead of HELO if the transport's &%protocol%& option is
33506 set to &"lmtp"&.
33507
33508 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33509 settings.
33510
33511 A recipient callout check is similar. By default, it also uses an empty address
33512 for the sender. This default is chosen because most hosts do not make use of
33513 the sender address when verifying a recipient. Using the same address means
33514 that a single cache entry can be used for each recipient. Some sites, however,
33515 do make use of the sender address when verifying. These are catered for by the
33516 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33517
33518 If the response to the RCPT command is a 2&'xx'& code, the verification
33519 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33520 Exim tries the next host, if any. If there is a problem with all the remote
33521 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33522 &%callout%& option is given, in which case the condition is forced to succeed.
33523
33524 .cindex "SMTP" "output flushing, disabling for callout"
33525 A callout may take a little time. For this reason, Exim normally flushes SMTP
33526 output before performing a callout in an ACL, to avoid unexpected timeouts in
33527 clients when the SMTP PIPELINING extension is in use. The flushing can be
33528 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33529
33530 .cindex "tainted data" "de-tainting"
33531 .cindex "de-tainting" "using recipient verify"
33532 A recipient callout which gets a 2&'xx'& code
33533 will assign untainted values to the
33534 &$domain_data$& and &$local_part_data$& variables,
33535 corresponding to the domain and local parts of the recipient address.
33536
33537
33538
33539
33540 .subsection "Additional parameters for callouts" CALLaddparcall
33541 .cindex "callout" "additional parameters for"
33542 The &%callout%& option can be followed by an equals sign and a number of
33543 optional parameters, separated by commas. For example:
33544 .code
33545 verify = recipient/callout=10s,defer_ok
33546 .endd
33547 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33548 separate verify options, is retained for backwards compatibility, but is now
33549 deprecated. The additional parameters for &%callout%& are as follows:
33550
33551
33552 .vlist
33553 .vitem <&'a&~time&~interval'&>
33554 .cindex "callout" "timeout, specifying"
33555 This specifies the timeout that applies for the callout attempt to each host.
33556 For example:
33557 .code
33558 verify = sender/callout=5s
33559 .endd
33560 The default is 30 seconds. The timeout is used for each response from the
33561 remote host. It is also used for the initial connection, unless overridden by
33562 the &%connect%& parameter.
33563
33564
33565 .vitem &*connect&~=&~*&<&'time&~interval'&>
33566 .cindex "callout" "connection timeout, specifying"
33567 This parameter makes it possible to set a different (usually smaller) timeout
33568 for making the SMTP connection. For example:
33569 .code
33570 verify = sender/callout=5s,connect=1s
33571 .endd
33572 If not specified, this timeout defaults to the general timeout value.
33573
33574 .vitem &*defer_ok*&
33575 .cindex "callout" "defer, action on"
33576 When this parameter is present, failure to contact any host, or any other kind
33577 of temporary error, is treated as success by the ACL. However, the cache is not
33578 updated in this circumstance.
33579
33580 .vitem &*fullpostmaster*&
33581 .cindex "callout" "full postmaster check"
33582 This operates like the &%postmaster%& option (see below), but if the check for
33583 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33584 accordance with the specification in RFC 2821. The RFC states that the
33585 unqualified address &'postmaster'& should be accepted.
33586
33587
33588 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
33589 .cindex "callout" "sender when verifying header"
33590 When verifying addresses in header lines using the &%header_sender%&
33591 verification option, Exim behaves by default as if the addresses are envelope
33592 sender addresses from a message. Callout verification therefore tests to see
33593 whether a bounce message could be delivered, by using an empty address in the
33594 MAIL command. However, it is arguable that these addresses might never be used
33595 as envelope senders, and could therefore justifiably reject bounce messages
33596 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
33597 address to use in the MAIL command. For example:
33598 .code
33599 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
33600 .endd
33601 This parameter is available only for the &%header_sender%& verification option.
33602
33603
33604 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33605 .cindex "callout" "overall timeout, specifying"
33606 This parameter sets an overall timeout for performing a callout verification.
33607 For example:
33608 .code
33609 verify = sender/callout=5s,maxwait=30s
33610 .endd
33611 This timeout defaults to four times the callout timeout for individual SMTP
33612 commands. The overall timeout applies when there is more than one host that can
33613 be tried. The timeout is checked before trying the next host. This prevents
33614 very long delays if there are a large number of hosts and all are timing out
33615 (for example, when network connections are timing out).
33616
33617
33618 .vitem &*no_cache*&
33619 .cindex "callout" "cache, suppressing"
33620 .cindex "caching callout, suppressing"
33621 When this parameter is given, the callout cache is neither read nor updated.
33622
33623 .vitem &*postmaster*&
33624 .cindex "callout" "postmaster; checking"
33625 When this parameter is set, a successful callout check is followed by a similar
33626 check for the local part &'postmaster'& at the same domain. If this address is
33627 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33628 the postmaster check is recorded in a cache record; if it is a failure, this is
33629 used to fail subsequent callouts for the domain without a connection being
33630 made, until the cache record expires.
33631
33632 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
33633 The postmaster check uses an empty sender in the MAIL command by default.
33634 You can use this parameter to do a postmaster check using a different address.
33635 For example:
33636 .code
33637 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33638 .endd
33639 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33640 one overrides. The &%postmaster%& parameter is equivalent to this example:
33641 .code
33642 require  verify = sender/callout=postmaster_mailfrom=
33643 .endd
33644 &*Warning*&: The caching arrangements for postmaster checking do not take
33645 account of the sender address. It is assumed that either the empty address or
33646 a fixed non-empty address will be used. All that Exim remembers is that the
33647 postmaster check for the domain succeeded or failed.
33648
33649
33650 .vitem &*random*&
33651 .cindex "callout" "&""random""& check"
33652 When this parameter is set, before doing the normal callout check, Exim does a
33653 check for a &"random"& local part at the same domain. The local part is not
33654 really random &-- it is defined by the expansion of the option
33655 &%callout_random_local_part%&, which defaults to
33656 .code
33657 $primary_hostname-$tod_epoch-testing
33658 .endd
33659 The idea here is to try to determine whether the remote host accepts all local
33660 parts without checking. If it does, there is no point in doing callouts for
33661 specific local parts. If the &"random"& check succeeds, the result is saved in
33662 a cache record, and used to force the current and subsequent callout checks to
33663 succeed without a connection being made, until the cache record expires.
33664
33665 .vitem &*use_postmaster*&
33666 .cindex "callout" "sender for recipient check"
33667 This parameter applies to recipient callouts only. For example:
33668 .code
33669 deny  !verify = recipient/callout=use_postmaster
33670 .endd
33671 .vindex "&$qualify_domain$&"
33672 It causes a non-empty postmaster address to be used in the MAIL command when
33673 performing the callout for the recipient, and also for a &"random"& check if
33674 that is configured. The local part of the address is &`postmaster`& and the
33675 domain is the contents of &$qualify_domain$&.
33676
33677 .vitem &*use_sender*&
33678 This option applies to recipient callouts only. For example:
33679 .code
33680 require  verify = recipient/callout=use_sender
33681 .endd
33682 It causes the message's actual sender address to be used in the MAIL
33683 command when performing the callout, instead of an empty address. There is no
33684 need to use this option unless you know that the called hosts make use of the
33685 sender when checking recipients. If used indiscriminately, it reduces the
33686 usefulness of callout caching.
33687
33688 .vitem &*hold*&
33689 This option applies to recipient callouts only. For example:
33690 .code
33691 require  verify = recipient/callout=use_sender,hold
33692 .endd
33693 It causes the connection to be held open and used for any further recipients
33694 and for eventual delivery (should that be done quickly).
33695 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33696 when that is used for the connections.
33697 The advantage is only gained if there are no callout cache hits
33698 (which could be enforced by the no_cache option),
33699 if the use_sender option is used,
33700 if neither the random nor the use_postmaster option is used,
33701 and if no other callouts intervene.
33702 .endlist
33703
33704 If you use any of the parameters that set a non-empty sender for the MAIL
33705 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33706 &%use_sender%&), you should think about possible loops. Recipient checking is
33707 usually done between two hosts that are under the same management, and the host
33708 that receives the callouts is not normally configured to do callouts itself.
33709 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33710 these circumstances.
33711
33712 However, if you use a non-empty sender address for a callout to an arbitrary
33713 host, there is the likelihood that the remote host will itself initiate a
33714 callout check back to your host. As it is checking what appears to be a message
33715 sender, it is likely to use an empty address in MAIL, thus avoiding a
33716 callout loop. However, to be on the safe side it would be best to set up your
33717 own ACLs so that they do not do sender verification checks when the recipient
33718 is the address you use for header sender or postmaster callout checking.
33719
33720 Another issue to think about when using non-empty senders for callouts is
33721 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33722 by the sender/recipient combination; thus, for any given recipient, many more
33723 actual callouts are performed than when an empty sender or postmaster is used.
33724
33725
33726
33727
33728 .subsection "Callout caching" SECTcallvercache
33729 .cindex "hints database" "callout cache"
33730 .cindex "callout" "cache, description of"
33731 .cindex "caching" "callout"
33732 Exim caches the results of callouts in order to reduce the amount of resources
33733 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33734 option. A hints database called &"callout"& is used for the cache. Two
33735 different record types are used: one records the result of a callout check for
33736 a specific address, and the other records information that applies to the
33737 entire domain (for example, that it accepts the local part &'postmaster'&).
33738
33739 When an original callout fails, a detailed SMTP error message is given about
33740 the failure. However, for subsequent failures that use the cache data, this message
33741 is not available.
33742
33743 The expiry times for negative and positive address cache records are
33744 independent, and can be set by the global options &%callout_negative_expire%&
33745 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33746
33747 If a host gives a negative response to an SMTP connection, or rejects any
33748 commands up to and including
33749 .code
33750 MAIL FROM:<>
33751 .endd
33752 (but not including the MAIL command with a non-empty address),
33753 any callout attempt is bound to fail. Exim remembers such failures in a
33754 domain cache record, which it uses to fail callouts for the domain without
33755 making new connections, until the domain record times out. There are two
33756 separate expiry times for domain cache records:
33757 &%callout_domain_negative_expire%& (default 3h) and
33758 &%callout_domain_positive_expire%& (default 7d).
33759
33760 Domain records expire when the negative expiry time is reached if callouts
33761 cannot be made for the domain, or if the postmaster check failed.
33762 Otherwise, they expire when the positive expiry time is reached. This
33763 ensures that, for example, a host that stops accepting &"random"& local parts
33764 will eventually be noticed.
33765
33766 The callout caching mechanism is based on the domain of the address that is
33767 being tested. If the domain routes to several hosts, it is assumed that their
33768 behaviour will be the same.
33769
33770
33771
33772 .section "Quota caching" "SECTquotacache"
33773 .cindex "hints database" "quota cache"
33774 .cindex "quota" "cache, description of"
33775 .cindex "caching" "quota"
33776 Exim caches the results of quota verification
33777 in order to reduce the amount of resources used.
33778 The &"callout"& hints database is used.
33779
33780 The default cache periods are five minutes for a positive (good) result
33781 and one hour for a negative result.
33782 To change the periods the &%quota%& option can be followed by an equals sign
33783 and a number of optional paramemters, separated by commas.
33784 For example:
33785 .code
33786 verify = recipient/quota=cachepos=1h,cacheneg=1d
33787 .endd
33788 Possible parameters are:
33789 .vlist
33790 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33791 .cindex "quota cache" "positive entry expiry, specifying"
33792 Set the lifetime for a positive cache entry.
33793 A value of zero seconds is legitimate.
33794
33795 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33796 .cindex "quota cache" "negative entry expiry, specifying"
33797 As above, for a negative entry.
33798
33799 .vitem &*no_cache*&
33800 Set both positive and negative lifetimes to zero.
33801
33802 .section "Sender address verification reporting" "SECTsenaddver"
33803 .cindex "verifying" "suppressing error details"
33804 See section &<<SECTaddressverification>>& for a general discussion of
33805 verification. When sender verification fails in an ACL, the details of the
33806 failure are given as additional output lines before the 550 response to the
33807 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33808 you might see:
33809 .code
33810 MAIL FROM:<xyz@abc.example>
33811 250 OK
33812 RCPT TO:<pqr@def.example>
33813 550-Verification failed for <xyz@abc.example>
33814 550-Called:   192.168.34.43
33815 550-Sent:     RCPT TO:<xyz@abc.example>
33816 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33817 550 Sender verification failed
33818 .endd
33819 If more than one RCPT command fails in the same way, the details are given
33820 only for the first of them. However, some administrators do not want to send
33821 out this much information. You can suppress the details by adding
33822 &`/no_details`& to the ACL statement that requests sender verification. For
33823 example:
33824 .code
33825 verify = sender/no_details
33826 .endd
33827
33828 .section "Redirection while verifying" "SECTredirwhilveri"
33829 .cindex "verifying" "redirection while"
33830 .cindex "address redirection" "while verifying"
33831 A dilemma arises when a local address is redirected by aliasing or forwarding
33832 during verification: should the generated addresses themselves be verified,
33833 or should the successful expansion of the original address be enough to verify
33834 it? By default, Exim takes the following pragmatic approach:
33835
33836 .ilist
33837 When an incoming address is redirected to just one child address, verification
33838 continues with the child address, and if that fails to verify, the original
33839 verification also fails.
33840 .next
33841 When an incoming address is redirected to more than one child address,
33842 verification does not continue. A success result is returned.
33843 .endlist
33844
33845 This seems the most reasonable behaviour for the common use of aliasing as a
33846 way of redirecting different local parts to the same mailbox. It means, for
33847 example, that a pair of alias entries of the form
33848 .code
33849 A.Wol:   aw123
33850 aw123:   :fail: Gone away, no forwarding address
33851 .endd
33852 work as expected, with both local parts causing verification failure. When a
33853 redirection generates more than one address, the behaviour is more like a
33854 mailing list, where the existence of the alias itself is sufficient for
33855 verification to succeed.
33856
33857 It is possible, however, to change the default behaviour so that all successful
33858 redirections count as successful verifications, however many new addresses are
33859 generated. This is specified by the &%success_on_redirect%& verification
33860 option. For example:
33861 .code
33862 require verify = recipient/success_on_redirect/callout=10s
33863 .endd
33864 In this example, verification succeeds if a router generates a new address, and
33865 the callout does not occur, because no address was routed to a remote host.
33866
33867 When verification is being tested via the &%-bv%& option, the treatment of
33868 redirections is as just described, unless the &%-v%& or any debugging option is
33869 also specified. In that case, full verification is done for every generated
33870 address and a report is output for each of them.
33871
33872
33873
33874 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
33875 .cindex "CSA" "verifying"
33876 Client SMTP Authorization is a system that allows a site to advertise
33877 which machines are and are not permitted to send email. This is done by placing
33878 special SRV records in the DNS; these are looked up using the client's HELO
33879 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
33880 Authorization checks in Exim are performed by the ACL condition:
33881 .code
33882 verify = csa
33883 .endd
33884 This fails if the client is not authorized. If there is a DNS problem, or if no
33885 valid CSA SRV record is found, or if the client is authorized, the condition
33886 succeeds. These three cases can be distinguished using the expansion variable
33887 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
33888 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
33889 be likely to cause problems for legitimate email.
33890
33891 The error messages produced by the CSA code include slightly more
33892 detail. If &$csa_status$& is &"defer"&, this may be because of problems
33893 looking up the CSA SRV record, or problems looking up the CSA target
33894 address record. There are four reasons for &$csa_status$& being &"fail"&:
33895
33896 .ilist
33897 The client's host name is explicitly not authorized.
33898 .next
33899 The client's IP address does not match any of the CSA target IP addresses.
33900 .next
33901 The client's host name is authorized but it has no valid target IP addresses
33902 (for example, the target's addresses are IPv6 and the client is using IPv4).
33903 .next
33904 The client's host name has no CSA SRV record but a parent domain has asserted
33905 that all subdomains must be explicitly authorized.
33906 .endlist
33907
33908 The &%csa%& verification condition can take an argument which is the domain to
33909 use for the DNS query. The default is:
33910 .code
33911 verify = csa/$sender_helo_name
33912 .endd
33913 This implementation includes an extension to CSA. If the query domain
33914 is an address literal such as [192.0.2.95], or if it is a bare IP
33915 address, Exim searches for CSA SRV records in the reverse DNS as if
33916 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
33917 meaningful to say:
33918 .code
33919 verify = csa/$sender_host_address
33920 .endd
33921 In fact, this is the check that Exim performs if the client does not say HELO.
33922 This extension can be turned off by setting the main configuration option
33923 &%dns_csa_use_reverse%& to be false.
33924
33925 If a CSA SRV record is not found for the domain itself, a search
33926 is performed through its parent domains for a record which might be
33927 making assertions about subdomains. The maximum depth of this search is limited
33928 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
33929 default. Exim does not look for CSA SRV records in a top level domain, so the
33930 default settings handle HELO domains as long as seven
33931 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
33932 of legitimate HELO domains.
33933
33934 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
33935 direct SRV lookups, this is not sufficient because of the extra parent domain
33936 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
33937 addresses into lookups in the reverse DNS space. The result of a successful
33938 lookup such as:
33939 .code
33940 ${lookup dnsdb {csa=$sender_helo_name}}
33941 .endd
33942 has two space-separated fields: an authorization code and a target host name.
33943 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
33944 authorization required but absent, or &"?"& for unknown.
33945
33946
33947
33948
33949 .section "Bounce address tag validation" "SECTverifyPRVS"
33950 .cindex "BATV, verifying"
33951 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
33952 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
33953 Genuine incoming bounce messages should therefore always be addressed to
33954 recipients that have a valid tag. This scheme is a way of detecting unwanted
33955 bounce messages caused by sender address forgeries (often called &"collateral
33956 spam"&), because the recipients of such messages do not include valid tags.
33957
33958 There are two expansion items to help with the implementation of the BATV
33959 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
33960 the original envelope sender address by using a simple key to add a hash of the
33961 address and some time-based randomizing information. The &%prvs%& expansion
33962 item creates a signed address, and the &%prvscheck%& expansion item checks one.
33963 The syntax of these expansion items is described in section
33964 &<<SECTexpansionitems>>&.
33965 The validity period on signed addresses is seven days.
33966
33967 As an example, suppose the secret per-address keys are stored in an MySQL
33968 database. A query to look up the key for an address could be defined as a macro
33969 like this:
33970 .code
33971 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
33972                 WHERE sender='${quote_mysql:$prvscheck_address}'\
33973                 }{$value}}
33974 .endd
33975 Suppose also that the senders who make use of BATV are defined by an address
33976 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
33977 use this:
33978 .code
33979 # Bounces: drop unsigned addresses for BATV senders
33980 deny senders = :
33981      recipients = +batv_senders
33982      message = This address does not send an unsigned reverse path
33983
33984 # Bounces: In case of prvs-signed address, check signature.
33985 deny senders = :
33986      condition  = ${prvscheck {$local_part@$domain}\
33987                   {PRVSCHECK_SQL}{1}}
33988      !condition = $prvscheck_result
33989      message = Invalid reverse path signature.
33990 .endd
33991 The first statement rejects recipients for bounce messages that are addressed
33992 to plain BATV sender addresses, because it is known that BATV senders do not
33993 send out messages with plain sender addresses. The second statement rejects
33994 recipients that are prvs-signed, but with invalid signatures (either because
33995 the key is wrong, or the signature has timed out).
33996
33997 A non-prvs-signed address is not rejected by the second statement, because the
33998 &%prvscheck%& expansion yields an empty string if its first argument is not a
33999 prvs-signed address, thus causing the &%condition%& condition to be false. If
34000 the first argument is a syntactically valid prvs-signed address, the yield is
34001 the third string (in this case &"1"&), whether or not the cryptographic and
34002 timeout checks succeed. The &$prvscheck_result$& variable contains the result
34003 of the checks (empty for failure, &"1"& for success).
34004
34005 There is one more issue you must consider when implementing prvs-signing:
34006 you have to ensure that the routers accept prvs-signed addresses and
34007 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
34008 router to remove the signature with a configuration along these lines:
34009 .code
34010 batv_redirect:
34011   driver = redirect
34012   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
34013 .endd
34014 This works because, if the third argument of &%prvscheck%& is empty, the result
34015 of the expansion of a prvs-signed address is the decoded value of the original
34016 address. This router should probably be the first of your routers that handles
34017 local addresses.
34018
34019 To create BATV-signed addresses in the first place, a transport of this form
34020 can be used:
34021 .code
34022 external_smtp_batv:
34023   driver = smtp
34024   return_path = ${prvs {$return_path} \
34025                        {${lookup mysql{SELECT \
34026                        secret FROM batv_prvs WHERE \
34027                        sender='${quote_mysql:$sender_address}'} \
34028                        {$value}fail}}}
34029 .endd
34030 If no key can be found for the existing return path, no signing takes place.
34031
34032
34033
34034 .section "Using an ACL to control relaying" "SECTrelaycontrol"
34035 .cindex "&ACL;" "relay control"
34036 .cindex "relaying" "control by ACL"
34037 .cindex "policy control" "relay control"
34038 An MTA is said to &'relay'& a message if it receives it from some host and
34039 delivers it directly to another host as a result of a remote address contained
34040 within it. Redirecting a local address via an alias or forward file and then
34041 passing the message on to another host is not relaying,
34042 .cindex "&""percent hack""&"
34043 but a redirection as a result of the &"percent hack"& is.
34044
34045 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
34046 A host which is acting as a gateway or an MX backup is concerned with incoming
34047 relaying from arbitrary hosts to a specific set of domains. On the other hand,
34048 a host which is acting as a smart host for a number of clients is concerned
34049 with outgoing relaying from those clients to the Internet at large. Often the
34050 same host is fulfilling both functions,
34051 . ///
34052 . as illustrated in the diagram below,
34053 . ///
34054 but in principle these two kinds of relaying are entirely independent. What is
34055 not wanted is the transmission of mail from arbitrary remote hosts through your
34056 system to arbitrary domains.
34057
34058
34059 You can implement relay control by means of suitable statements in the ACL that
34060 runs for each RCPT command. For convenience, it is often easiest to use
34061 Exim's named list facility to define the domains and hosts involved. For
34062 example, suppose you want to do the following:
34063
34064 .ilist
34065 Deliver a number of domains to mailboxes on the local host (or process them
34066 locally in some other way). Let's say these are &'my.dom1.example'& and
34067 &'my.dom2.example'&.
34068 .next
34069 Relay mail for a number of other domains for which you are the secondary MX.
34070 These might be &'friend1.example'& and &'friend2.example'&.
34071 .next
34072 Relay mail from the hosts on your local LAN, to whatever domains are involved.
34073 Suppose your LAN is 192.168.45.0/24.
34074 .endlist
34075
34076
34077 In the main part of the configuration, you put the following definitions:
34078 .code
34079 domainlist local_domains    = my.dom1.example : my.dom2.example
34080 domainlist relay_to_domains = friend1.example : friend2.example
34081 hostlist   relay_from_hosts = 192.168.45.0/24
34082 .endd
34083 Now you can use these definitions in the ACL that is run for every RCPT
34084 command:
34085 .code
34086 acl_check_rcpt:
34087   accept domains = +local_domains : +relay_to_domains
34088   accept hosts   = +relay_from_hosts
34089 .endd
34090 The first statement accepts any RCPT command that contains an address in
34091 the local or relay domains. For any other domain, control passes to the second
34092 statement, which accepts the command only if it comes from one of the relay
34093 hosts. In practice, you will probably want to make your ACL more sophisticated
34094 than this, for example, by including sender and recipient verification. The
34095 default configuration includes a more comprehensive example, which is described
34096 in chapter &<<CHAPdefconfil>>&.
34097
34098
34099
34100 .section "Checking a relay configuration" "SECTcheralcon"
34101 .cindex "relaying" "checking control of"
34102 You can check the relay characteristics of your configuration in the same way
34103 that you can test any ACL behaviour for an incoming SMTP connection, by using
34104 the &%-bh%& option to run a fake SMTP session with which you interact.
34105 .ecindex IIDacl
34106
34107
34108
34109 . ////////////////////////////////////////////////////////////////////////////
34110 . ////////////////////////////////////////////////////////////////////////////
34111
34112 .chapter "Content scanning at ACL time" "CHAPexiscan"
34113 .scindex IIDcosca "content scanning" "at ACL time"
34114 The extension of Exim to include content scanning at ACL time, formerly known
34115 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
34116 was integrated into the main source for Exim release 4.50, and Tom continues to
34117 maintain it. Most of the wording of this chapter is taken from Tom's
34118 specification.
34119
34120 It is also possible to scan the content of messages at other times. The
34121 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
34122 scanning after all the ACLs have run. A transport filter can be used to scan
34123 messages at delivery time (see the &%transport_filter%& option, described in
34124 chapter &<<CHAPtransportgeneric>>&).
34125
34126 If you want to include the ACL-time content-scanning features when you compile
34127 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
34128 &_Local/Makefile_&. When you do that, the Exim binary is built with:
34129
34130 .ilist
34131 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
34132 for all MIME parts for SMTP and non-SMTP messages, respectively.
34133 .next
34134 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
34135 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
34136 run at the end of message reception (the &%acl_smtp_data%& ACL).
34137 .next
34138 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
34139 of messages, or parts of messages, for debugging purposes.
34140 .next
34141 Additional expansion variables that are set in the new ACL and by the new
34142 conditions.
34143 .next
34144 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
34145 .endlist
34146
34147 Content-scanning is continually evolving, and new features are still being
34148 added. While such features are still unstable and liable to incompatible
34149 changes, they are made available in Exim by setting options whose names begin
34150 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
34151 this manual. You can find out about them by reading the file called
34152 &_doc/experimental.txt_&.
34153
34154 All the content-scanning facilities work on a MBOX copy of the message that is
34155 temporarily created in a file called:
34156 .display
34157 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
34158 .endd
34159 The &_.eml_& extension is a friendly hint to virus scanners that they can
34160 expect an MBOX-like structure inside that file. The file is created when the
34161 first content scanning facility is called. Subsequent calls to content
34162 scanning conditions open the same file again. The directory is recursively
34163 removed when the &%acl_smtp_data%& ACL has finished running, unless
34164 .code
34165 control = no_mbox_unspool
34166 .endd
34167 has been encountered. When the MIME ACL decodes files, they are put into the
34168 same directory by default.
34169
34170
34171
34172 .section "Scanning for viruses" "SECTscanvirus"
34173 .cindex "virus scanning"
34174 .cindex "content scanning" "for viruses"
34175 .cindex "content scanning" "the &%malware%& condition"
34176 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
34177 It supports a &"generic"& interface to scanners called via the shell, and
34178 specialized interfaces for &"daemon"& type virus scanners, which are resident
34179 in memory and thus are much faster.
34180
34181 Since message data needs to have arrived,
34182 the condition may be only called in ACL defined by
34183 &%acl_smtp_data%&,
34184 &%acl_smtp_data_prdr%&,
34185 &%acl_smtp_mime%& or
34186 &%acl_smtp_dkim%&
34187
34188 A timeout of 2 minutes is applied to a scanner call (by default);
34189 if it expires then a defer action is taken.
34190
34191 .oindex "&%av_scanner%&"
34192 You can set the &%av_scanner%& option in the main part of the configuration
34193 to specify which scanner to use, together with any additional options that
34194 are needed. The basic syntax is as follows:
34195 .display
34196 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
34197 .endd
34198 If you do not set &%av_scanner%&, it defaults to
34199 .code
34200 av_scanner = sophie:/var/run/sophie
34201 .endd
34202 If the value of &%av_scanner%& starts with a dollar character, it is expanded
34203 before use.
34204 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
34205 The following scanner types are supported in this release,
34206 though individual ones can be included or not at build time:
34207
34208 .vlist
34209 .vitem &%avast%&
34210 .cindex "virus scanners" "avast"
34211 This is the scanner daemon of Avast. It has been tested with Avast Core
34212 Security (currently at version 2.2.0).
34213 You can get a trial version at &url(https://www.avast.com) or for Linux
34214 at &url(https://www.avast.com/linux-server-antivirus).
34215 This scanner type takes one option,
34216 which can be either a full path to a UNIX socket,
34217 or host and port specifiers separated by white space.
34218 The host may be a name or an IP address; the port is either a
34219 single number or a pair of numbers with a dash between.
34220 A list of options may follow. These options are interpreted on the
34221 Exim's side of the malware scanner, or are given on separate lines to
34222 the daemon as options before the main scan command.
34223
34224 .cindex &`pass_unscanned`& "avast"
34225 If &`pass_unscanned`&
34226 is set, any files the Avast scanner can't scan (e.g.
34227 decompression bombs, or invalid archives) are considered clean. Use with
34228 care.
34229
34230 For example:
34231 .code
34232 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
34233 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
34234 av_scanner = avast:192.168.2.22 5036
34235 .endd
34236 If you omit the argument, the default path
34237 &_/var/run/avast/scan.sock_&
34238 is used.
34239 If you use a remote host,
34240 you need to make Exim's spool directory available to it,
34241 as the scanner is passed a file path, not file contents.
34242 For information about available commands and their options you may use
34243 .code
34244 $ socat UNIX:/var/run/avast/scan.sock STDIO:
34245     FLAGS
34246     SENSITIVITY
34247     PACK
34248 .endd
34249
34250 If the scanner returns a temporary failure (e.g. license issues, or
34251 permission problems), the message is deferred and a paniclog entry is
34252 written.  The usual &`defer_ok`& option is available.
34253
34254 .vitem &%aveserver%&
34255 .cindex "virus scanners" "Kaspersky"
34256 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
34257 at &url(https://www.kaspersky.com/). This scanner type takes one option,
34258 which is the path to the daemon's UNIX socket. The default is shown in this
34259 example:
34260 .code
34261 av_scanner = aveserver:/var/run/aveserver
34262 .endd
34263
34264
34265 .vitem &%clamd%&
34266 .cindex "virus scanners" "clamd"
34267 This daemon-type scanner is GPL and free. You can get it at
34268 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
34269 unpack MIME containers, so it used to be recommended to unpack MIME attachments
34270 in the MIME ACL. This is no longer believed to be necessary.
34271
34272 The options are a list of server specifiers, which may be
34273 a UNIX socket specification,
34274 a TCP socket specification,
34275 or a (global) option.
34276
34277 A socket specification consists of a space-separated list.
34278 For a Unix socket the first element is a full path for the socket,
34279 for a TCP socket the first element is the IP address
34280 and the second a port number,
34281 Any further elements are per-server (non-global) options.
34282 These per-server options are supported:
34283 .code
34284 retry=<timespec>        Retry on connect fail
34285 .endd
34286
34287 The &`retry`& option specifies a time after which a single retry for
34288 a failed connect is made.  The default is to not retry.
34289
34290 If a Unix socket file is specified, only one server is supported.
34291
34292 Examples:
34293 .code
34294 av_scanner = clamd:/opt/clamd/socket
34295 av_scanner = clamd:192.0.2.3 1234
34296 av_scanner = clamd:192.0.2.3 1234:local
34297 av_scanner = clamd:192.0.2.3 1234 retry=10s
34298 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
34299 .endd
34300 If the value of av_scanner points to a UNIX socket file or contains the
34301 &`local`&
34302 option, then the ClamAV interface will pass a filename containing the data
34303 to be scanned, which should normally result in less I/O happening and be
34304 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
34305 Exim does not assume that there is a common filesystem with the remote host.
34306
34307 The final example shows that multiple TCP targets can be specified.  Exim will
34308 randomly use one for each incoming email (i.e. it load balances them).  Note
34309 that only TCP targets may be used if specifying a list of scanners; a UNIX
34310 socket cannot be mixed in with TCP targets.  If one of the servers becomes
34311 unavailable, Exim will try the remaining one(s) until it finds one that works.
34312 When a clamd server becomes unreachable, Exim will log a message.  Exim does
34313 not keep track of scanner state between multiple messages, and the scanner
34314 selection is random, so the message will get logged in the mainlog for each
34315 email that the down scanner gets chosen first (message wrapped to be readable):
34316 .code
34317 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
34318    clamd: connection to localhost, port 3310 failed
34319    (Connection refused)
34320 .endd
34321
34322 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
34323 contributing the code for this scanner.
34324
34325 .vitem &%cmdline%&
34326 .cindex "virus scanners" "command line interface"
34327 This is the keyword for the generic command line scanner interface. It can be
34328 used to attach virus scanners that are invoked from the shell. This scanner
34329 type takes 3 mandatory options:
34330
34331 .olist
34332 The full path and name of the scanner binary, with all command line options,
34333 and a placeholder (&`%s`&) for the directory to scan.
34334
34335 .next
34336 A regular expression to match against the STDOUT and STDERR output of the
34337 virus scanner. If the expression matches, a virus was found. You must make
34338 absolutely sure that this expression matches on &"virus found"&. This is called
34339 the &"trigger"& expression.
34340
34341 .next
34342 Another regular expression, containing exactly one pair of parentheses, to
34343 match the name of the virus found in the scanners output. This is called the
34344 &"name"& expression.
34345 .endlist olist
34346
34347 For example, Sophos Sweep reports a virus on a line like this:
34348 .code
34349 Virus 'W32/Magistr-B' found in file ./those.bat
34350 .endd
34351 For the trigger expression, we can match the phrase &"found in file"&. For the
34352 name expression, we want to extract the W32/Magistr-B string, so we can match
34353 for the single quotes left and right of it. Altogether, this makes the
34354 configuration setting:
34355 .code
34356 av_scanner = cmdline:\
34357              /path/to/sweep -ss -all -rec -archive %s:\
34358              found in file:'(.+)'
34359 .endd
34360 .vitem &%drweb%&
34361 .cindex "virus scanners" "DrWeb"
34362 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34363 takes one option,
34364 either a full path to a UNIX socket,
34365 or host and port specifiers separated by white space.
34366 The host may be a name or an IP address; the port is either a
34367 single number or a pair of numbers with a dash between.
34368 For example:
34369 .code
34370 av_scanner = drweb:/var/run/drwebd.sock
34371 av_scanner = drweb:192.168.2.20 31337
34372 .endd
34373 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34374 is used. Thanks to Alex Miller for contributing the code for this scanner.
34375
34376 .vitem &%f-protd%&
34377 .cindex "virus scanners" "f-protd"
34378 The f-protd scanner is accessed via HTTP over TCP.
34379 One argument is taken, being a space-separated hostname and port number
34380 (or port-range).
34381 For example:
34382 .code
34383 av_scanner = f-protd:localhost 10200-10204
34384 .endd
34385 If you omit the argument, the default values shown above are used.
34386
34387 .vitem &%f-prot6d%&
34388 .cindex "virus scanners" "f-prot6d"
34389 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34390 One argument is taken, being a space-separated hostname and port number.
34391 For example:
34392 .code
34393 av_scanner = f-prot6d:localhost 10200
34394 .endd
34395 If you omit the argument, the default values show above are used.
34396
34397 .vitem &%fsecure%&
34398 .cindex "virus scanners" "F-Secure"
34399 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34400 argument which is the path to a UNIX socket. For example:
34401 .code
34402 av_scanner = fsecure:/path/to/.fsav
34403 .endd
34404 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34405 Thelmen for contributing the code for this scanner.
34406
34407 .vitem &%kavdaemon%&
34408 .cindex "virus scanners" "Kaspersky"
34409 This is the scanner daemon of Kaspersky Version 4. This version of the
34410 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34411 scanner type takes one option, which is the path to the daemon's UNIX socket.
34412 For example:
34413 .code
34414 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34415 .endd
34416 The default path is &_/var/run/AvpCtl_&.
34417
34418 .vitem &%mksd%&
34419 .cindex "virus scanners" "mksd"
34420 This was a daemon type scanner that is aimed mainly at Polish users,
34421 though some documentation was available in English.
34422 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34423 and this appears to be a candidate for removal from Exim, unless
34424 we are informed of other virus scanners which use the same protocol
34425 to integrate.
34426 The only option for this scanner type is
34427 the maximum number of processes used simultaneously to scan the attachments,
34428 provided that mksd has
34429 been run with at least the same number of child processes. For example:
34430 .code
34431 av_scanner = mksd:2
34432 .endd
34433 You can safely omit this option (the default value is 1).
34434
34435 .vitem &%sock%&
34436 .cindex "virus scanners" "simple socket-connected"
34437 This is a general-purpose way of talking to simple scanner daemons
34438 running on the local machine.
34439 There are four options:
34440 an address (which may be an IP address and port, or the path of a Unix socket),
34441 a commandline to send (may include a single %s which will be replaced with
34442 the path to the mail file to be scanned),
34443 an RE to trigger on from the returned data,
34444 and an RE to extract malware_name from the returned data.
34445 For example:
34446 .code
34447 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34448 .endd
34449 Note that surrounding whitespace is stripped from each option, meaning
34450 there is no way to specify a trailing newline.
34451 The socket specifier and both regular-expressions are required.
34452 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34453 specify an empty element to get this.
34454
34455 .vitem &%sophie%&
34456 .cindex "virus scanners" "Sophos and Sophie"
34457 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34458 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34459 for this scanner type is the path to the UNIX socket that Sophie uses for
34460 client communication. For example:
34461 .code
34462 av_scanner = sophie:/tmp/sophie
34463 .endd
34464 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34465 the option.
34466 .endlist
34467
34468 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34469 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34470 ACL.
34471
34472 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34473 makes it possible to use different scanners. See further below for an example.
34474 The &%malware%& condition caches its results, so when you use it multiple times
34475 for the same message, the actual scanning process is only carried out once.
34476 However, using expandable items in &%av_scanner%& disables this caching, in
34477 which case each use of the &%malware%& condition causes a new scan of the
34478 message.
34479
34480 The &%malware%& condition takes a right-hand argument that is expanded before
34481 use and taken as a list, slash-separated by default.
34482 The first element can then be one of
34483
34484 .ilist
34485 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34486 The condition succeeds if a virus was found, and fail otherwise. This is the
34487 recommended usage.
34488 .next
34489 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34490 the condition fails immediately.
34491 .next
34492 A regular expression, in which case the message is scanned for viruses. The
34493 condition succeeds if a virus is found and its name matches the regular
34494 expression. This allows you to take special actions on certain types of virus.
34495 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34496 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34497 .endlist
34498
34499 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34500 messages even if there is a problem with the virus scanner.
34501 Otherwise, such a problem causes the ACL to defer.
34502
34503 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34504 specify a non-default timeout.  The default is two minutes.
34505 For example:
34506 .code
34507 malware = * / defer_ok / tmo=10s
34508 .endd
34509 A timeout causes the ACL to defer.
34510
34511 .vindex "&$callout_address$&"
34512 When a connection is made to the scanner the expansion variable &$callout_address$&
34513 is set to record the actual address used.
34514
34515 .vindex "&$malware_name$&"
34516 When a virus is found, the condition sets up an expansion variable called
34517 &$malware_name$& that contains the name of the virus. You can use it in a
34518 &%message%& modifier that specifies the error returned to the sender, and/or in
34519 logging data.
34520
34521 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34522 imposed by your anti-virus scanner.
34523
34524 Here is a very simple scanning example:
34525 .code
34526 deny malware = *
34527      message = This message contains malware ($malware_name)
34528 .endd
34529 The next example accepts messages when there is a problem with the scanner:
34530 .code
34531 deny malware = */defer_ok
34532      message = This message contains malware ($malware_name)
34533 .endd
34534 The next example shows how to use an ACL variable to scan with both sophie and
34535 aveserver. It assumes you have set:
34536 .code
34537 av_scanner = $acl_m0
34538 .endd
34539 in the main Exim configuration.
34540 .code
34541 deny set acl_m0 = sophie
34542      malware = *
34543      message = This message contains malware ($malware_name)
34544
34545 deny set acl_m0 = aveserver
34546      malware = *
34547      message = This message contains malware ($malware_name)
34548 .endd
34549
34550
34551 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34552 .cindex "content scanning" "for spam"
34553 .cindex "spam scanning"
34554 .cindex "SpamAssassin"
34555 .cindex "Rspamd"
34556 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34557 score and a report for the message.
34558 Support is also provided for Rspamd.
34559
34560 For more information about installation and configuration of SpamAssassin or
34561 Rspamd refer to their respective websites at
34562 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34563
34564 SpamAssassin can be installed with CPAN by running:
34565 .code
34566 perl -MCPAN -e 'install Mail::SpamAssassin'
34567 .endd
34568 SpamAssassin has its own set of configuration files. Please review its
34569 documentation to see how you can tweak it. The default installation should work
34570 nicely, however.
34571
34572 .oindex "&%spamd_address%&"
34573 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34574 intend to use an instance running on the local host you do not need to set
34575 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34576 you must set the &%spamd_address%& option in the global part of the Exim
34577 configuration as follows (example):
34578 .code
34579 spamd_address = 192.168.99.45 783
34580 .endd
34581 The SpamAssassin protocol relies on a TCP half-close from the client.
34582 If your SpamAssassin client side is running a Linux system with an
34583 iptables firewall, consider setting
34584 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34585 timeout, Exim uses when waiting for a response from the SpamAssassin
34586 server (currently defaulting to 120s).  With a lower value the Linux
34587 connection tracking may consider your half-closed connection as dead too
34588 soon.
34589
34590
34591 To use Rspamd (which by default listens on all local addresses
34592 on TCP port 11333)
34593 you should add &%variant=rspamd%& after the address/port pair, for example:
34594 .code
34595 spamd_address = 127.0.0.1 11333 variant=rspamd
34596 .endd
34597
34598 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
34599 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34600 filename instead of an address/port pair:
34601 .code
34602 spamd_address = /var/run/spamd_socket
34603 .endd
34604 You can have multiple &%spamd%& servers to improve scalability. These can
34605 reside on other hardware reachable over the network. To specify multiple
34606 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34607 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34608 .code
34609 spamd_address = 192.168.2.10 783 : \
34610                 192.168.2.11 783 : \
34611                 192.168.2.12 783
34612 .endd
34613 Up to 32 &%spamd%& servers are supported.
34614 When a server fails to respond to the connection attempt, all other
34615 servers are tried until one succeeds. If no server responds, the &%spam%&
34616 condition defers.
34617
34618 Unix and TCP socket specifications may be mixed in any order.
34619 Each element of the list is a list itself, space-separated by default
34620 and changeable in the usual way (&<<SECTlistsepchange>>&);
34621 take care to not double the separator.
34622
34623 For TCP socket specifications a host name or IP (v4 or v6, but
34624 subject to list-separator quoting rules) address can be used,
34625 and the port can be one or a dash-separated pair.
34626 In the latter case, the range is tried in strict order.
34627
34628 Elements after the first for Unix sockets, or second for TCP socket,
34629 are options.
34630 The supported options are:
34631 .code
34632 pri=<priority>      Selection priority
34633 weight=<value>      Selection bias
34634 time=<start>-<end>  Use only between these times of day
34635 retry=<timespec>    Retry on connect fail
34636 tmo=<timespec>      Connection time limit
34637 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34638 .endd
34639
34640 The &`pri`& option specifies a priority for the server within the list,
34641 higher values being tried first.
34642 The default priority is 1.
34643
34644 The &`weight`& option specifies a selection bias.
34645 Within a priority set
34646 servers are queried in a random fashion, weighted by this value.
34647 The default value for selection bias is 1.
34648
34649 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34650 in the local time zone; each element being one or more digits.
34651 Either the seconds or both minutes and seconds, plus the leading &`.`&
34652 characters, may be omitted and will be taken as zero.
34653
34654 Timeout specifications for the &`retry`& and &`tmo`& options
34655 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34656
34657 The &`tmo`& option specifies an overall timeout for communication.
34658 The default value is two minutes.
34659
34660 The &`retry`& option specifies a time after which a single retry for
34661 a failed connect is made.
34662 The default is to not retry.
34663
34664 The &%spamd_address%& variable is expanded before use if it starts with
34665 a dollar sign. In this case, the expansion may return a string that is
34666 used as the list so that multiple spamd servers can be the result of an
34667 expansion.
34668
34669 .vindex "&$callout_address$&"
34670 When a connection is made to the server the expansion variable &$callout_address$&
34671 is set to record the actual address used.
34672
34673 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34674 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34675 .code
34676 deny spam = joe
34677      message = This message was classified as SPAM
34678 .endd
34679 The right-hand side of the &%spam%& condition specifies a name. This is
34680 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34681 to scan using a specific profile, but rather use the SpamAssassin system-wide
34682 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34683 Rspamd does not use this setting. However, you must put something on the
34684 right-hand side.
34685
34686 The name allows you to use per-domain or per-user antispam profiles in
34687 principle, but this is not straightforward in practice, because a message may
34688 have multiple recipients, not necessarily all in the same domain. Because the
34689 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34690 read the contents of the message, the variables &$local_part$& and &$domain$&
34691 are not set.
34692 Careful enforcement of single-recipient messages
34693 (e.g. by responding with defer in the recipient ACL for all recipients
34694 after the first),
34695 or the use of PRDR,
34696 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34697 are needed to use this feature.
34698
34699 The right-hand side of the &%spam%& condition is expanded before being used, so
34700 you can put lookups or conditions there. When the right-hand side evaluates to
34701 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34702
34703
34704 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34705 large ones may cause significant performance degradation. As most spam messages
34706 are quite small, it is recommended that you do not scan the big ones. For
34707 example:
34708 .code
34709 deny condition = ${if < {$message_size}{10K}}
34710      spam = nobody
34711      message = This message was classified as SPAM
34712 .endd
34713
34714 The &%spam%& condition returns true if the threshold specified in the user's
34715 SpamAssassin profile has been matched or exceeded. If you want to use the
34716 &%spam%& condition for its side effects (see the variables below), you can make
34717 it always return &"true"& by appending &`:true`& to the username.
34718
34719 .cindex "spam scanning" "returned variables"
34720 When the &%spam%& condition is run, it sets up a number of expansion
34721 variables.
34722 Except for &$spam_report$&,
34723 these variables are saved with the received message so are
34724 available for use at delivery time.
34725
34726 .vlist
34727 .vitem &$spam_score$&
34728 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34729 for inclusion in log or reject messages.
34730
34731 .vitem &$spam_score_int$&
34732 The spam score of the message, multiplied by ten, as an integer value. For
34733 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34734 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34735 The integer value is useful for numeric comparisons in conditions.
34736
34737 .vitem &$spam_bar$&
34738 A string consisting of a number of &"+"& or &"-"& characters, representing the
34739 integer part of the spam score value. A spam score of 4.4 would have a
34740 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34741 headers, since MUAs can match on such strings. The maximum length of the
34742 spam bar is 50 characters.
34743
34744 .vitem &$spam_report$&
34745 A multiline text table, containing the full SpamAssassin report for the
34746 message. Useful for inclusion in headers or reject messages.
34747 This variable is only usable in a DATA-time ACL.
34748 Beware that SpamAssassin may return non-ASCII characters, especially
34749 when running in country-specific locales, which are not legal
34750 unencoded in headers.
34751
34752 .vitem &$spam_action$&
34753 For SpamAssassin either 'reject' or 'no action' depending on the
34754 spam score versus threshold.
34755 For Rspamd, the recommended action.
34756
34757 .endlist
34758
34759 The &%spam%& condition caches its results unless expansion in
34760 spamd_address was used. If you call it again with the same user name, it
34761 does not scan again, but rather returns the same values as before.
34762
34763 The &%spam%& condition returns DEFER if there is any error while running
34764 the message through SpamAssassin or if the expansion of spamd_address
34765 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34766 statement block), append &`/defer_ok`& to the right-hand side of the
34767 spam condition, like this:
34768 .code
34769 deny spam    = joe/defer_ok
34770      message = This message was classified as SPAM
34771 .endd
34772 This causes messages to be accepted even if there is a problem with &%spamd%&.
34773
34774 Here is a longer, commented example of the use of the &%spam%&
34775 condition:
34776 .code
34777 # put headers in all messages (no matter if spam or not)
34778 warn  spam = nobody:true
34779       add_header = X-Spam-Score: $spam_score ($spam_bar)
34780       add_header = X-Spam-Report: $spam_report
34781
34782 # add second subject line with *SPAM* marker when message
34783 # is over threshold
34784 warn  spam = nobody
34785       add_header = Subject: *SPAM* $h_Subject:
34786
34787 # reject spam at high scores (> 12)
34788 deny  spam = nobody:true
34789       condition = ${if >{$spam_score_int}{120}{1}{0}}
34790       message = This message scored $spam_score spam points.
34791 .endd
34792
34793
34794
34795 .section "Scanning MIME parts" "SECTscanmimepart"
34796 .cindex "content scanning" "MIME parts"
34797 .cindex "MIME content scanning"
34798 .oindex "&%acl_smtp_mime%&"
34799 .oindex "&%acl_not_smtp_mime%&"
34800 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34801 each MIME part of an SMTP message, including multipart types, in the sequence
34802 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34803 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34804 options may both refer to the same ACL if you want the same processing in both
34805 cases.
34806
34807 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34808 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34809 the case of a non-SMTP message. However, a MIME ACL is called only if the
34810 message contains a &'Content-Type:'& header line. When a call to a MIME
34811 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
34812 result code is sent to the client. In the case of an SMTP message, the
34813 &%acl_smtp_data%& ACL is not called when this happens.
34814
34815 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34816 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34817 condition to match against the raw MIME part. You can also use the
34818 &%mime_regex%& condition to match against the decoded MIME part (see section
34819 &<<SECTscanregex>>&).
34820
34821 At the start of a MIME ACL, a number of variables are set from the header
34822 information for the relevant MIME part. These are described below. The contents
34823 of the MIME part are not by default decoded into a disk file except for MIME
34824 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
34825 part into a disk file, you can use the &%decode%& condition. The general
34826 syntax is:
34827 .display
34828 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
34829 .endd
34830 The right hand side is expanded before use. After expansion,
34831 the value can be:
34832
34833 .olist
34834 &"0"& or &"false"&, in which case no decoding is done.
34835 .next
34836 The string &"default"&. In that case, the file is put in the temporary
34837 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
34838 a sequential filename consisting of the message id and a sequence number. The
34839 full path and name is available in &$mime_decoded_filename$& after decoding.
34840 .next
34841 A full path name starting with a slash. If the full name is an existing
34842 directory, it is used as a replacement for the default directory. The filename
34843 is then sequentially assigned. If the path does not exist, it is used as
34844 the full path and filename.
34845 .next
34846 If the string does not start with a slash, it is used as the
34847 filename, and the default path is then used.
34848 .endlist
34849 The &%decode%& condition normally succeeds. It is only false for syntax
34850 errors or unusual circumstances such as memory shortages. You can easily decode
34851 a file with its original, proposed filename using
34852 .code
34853 decode = $mime_filename
34854 .endd
34855 However, you should keep in mind that &$mime_filename$& might contain
34856 anything. If you place files outside of the default path, they are not
34857 automatically unlinked.
34858
34859 For RFC822 attachments (these are messages attached to messages, with a
34860 content-type of &"message/rfc822"&), the ACL is called again in the same manner
34861 as for the primary message, only that the &$mime_is_rfc822$& expansion
34862 variable is set (see below). Attached messages are always decoded to disk
34863 before being checked, and the files are unlinked once the check is done.
34864
34865 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
34866 used to match regular expressions against raw and decoded MIME parts,
34867 respectively. They are described in section &<<SECTscanregex>>&.
34868
34869 .cindex "MIME content scanning" "returned variables"
34870 The following list describes all expansion variables that are
34871 available in the MIME ACL:
34872
34873 .vlist
34874 .vitem &$mime_anomaly_level$& &&&
34875        &$mime_anomaly_text$&
34876 .vindex &$mime_anomaly_level$&
34877 .vindex &$mime_anomaly_text$&
34878 If there are problems decoding, these variables contain information on
34879 the detected issue.
34880
34881 .vitem &$mime_boundary$&
34882 .vindex &$mime_boundary$&
34883 If the current part is a multipart (see &$mime_is_multipart$& below), it should
34884 have a boundary string, which is stored in this variable. If the current part
34885 has no boundary parameter in the &'Content-Type:'& header, this variable
34886 contains the empty string.
34887
34888 .vitem &$mime_charset$&
34889 .vindex &$mime_charset$&
34890 This variable contains the character set identifier, if one was found in the
34891 &'Content-Type:'& header. Examples for charset identifiers are:
34892 .code
34893 us-ascii
34894 gb2312 (Chinese)
34895 iso-8859-1
34896 .endd
34897 Please note that this value is not normalized, so you should do matches
34898 case-insensitively.
34899
34900 .vitem &$mime_content_description$&
34901 .vindex &$mime_content_description$&
34902 This variable contains the normalized content of the &'Content-Description:'&
34903 header. It can contain a human-readable description of the parts content. Some
34904 implementations repeat the filename for attachments here, but they are usually
34905 only used for display purposes.
34906
34907 .vitem &$mime_content_disposition$&
34908 .vindex &$mime_content_disposition$&
34909 This variable contains the normalized content of the &'Content-Disposition:'&
34910 header. You can expect strings like &"attachment"& or &"inline"& here.
34911
34912 .vitem &$mime_content_id$&
34913 .vindex &$mime_content_id$&
34914 This variable contains the normalized content of the &'Content-ID:'& header.
34915 This is a unique ID that can be used to reference a part from another part.
34916
34917 .vitem &$mime_content_size$&
34918 .vindex &$mime_content_size$&
34919 This variable is set only after the &%decode%& modifier (see above) has been
34920 successfully run. It contains the size of the decoded part in kilobytes. The
34921 size is always rounded up to full kilobytes, so only a completely empty part
34922 has a &$mime_content_size$& of zero.
34923
34924 .vitem &$mime_content_transfer_encoding$&
34925 .vindex &$mime_content_transfer_encoding$&
34926 This variable contains the normalized content of the
34927 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
34928 type. Typical values are &"base64"& and &"quoted-printable"&.
34929
34930 .vitem &$mime_content_type$&
34931 .vindex &$mime_content_type$&
34932 If the MIME part has a &'Content-Type:'& header, this variable contains its
34933 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
34934 are some examples of popular MIME types, as they may appear in this variable:
34935 .code
34936 text/plain
34937 text/html
34938 application/octet-stream
34939 image/jpeg
34940 audio/midi
34941 .endd
34942 If the MIME part has no &'Content-Type:'& header, this variable contains the
34943 empty string.
34944
34945 .vitem &$mime_decoded_filename$&
34946 .vindex &$mime_decoded_filename$&
34947 This variable is set only after the &%decode%& modifier (see above) has been
34948 successfully run. It contains the full path and filename of the file
34949 containing the decoded data.
34950 .endlist
34951
34952 .cindex "RFC 2047"
34953 .vlist
34954 .vitem &$mime_filename$&
34955 .vindex &$mime_filename$&
34956 This is perhaps the most important of the MIME variables. It contains a
34957 proposed filename for an attachment, if one was found in either the
34958 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
34959 RFC2047
34960 or RFC2231
34961 decoded, but no additional sanity checks are done.
34962  If no filename was
34963 found, this variable contains the empty string.
34964
34965 .vitem &$mime_is_coverletter$&
34966 .vindex &$mime_is_coverletter$&
34967 This variable attempts to differentiate the &"cover letter"& of an e-mail from
34968 attached data. It can be used to clamp down on flashy or unnecessarily encoded
34969 content in the cover letter, while not restricting attachments at all.
34970
34971 The variable contains 1 (true) for a MIME part believed to be part of the
34972 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
34973 follows:
34974
34975 .olist
34976 The outermost MIME part of a message is always a cover letter.
34977
34978 .next
34979 If a multipart/alternative or multipart/related MIME part is a cover letter,
34980 so are all MIME subparts within that multipart.
34981
34982 .next
34983 If any other multipart is a cover letter, the first subpart is a cover letter,
34984 and the rest are attachments.
34985
34986 .next
34987 All parts contained within an attachment multipart are attachments.
34988 .endlist olist
34989
34990 As an example, the following will ban &"HTML mail"& (including that sent with
34991 alternative plain text), while allowing HTML files to be attached. HTML
34992 coverletter mail attached to non-HTML coverletter mail will also be allowed:
34993 .code
34994 deny !condition = $mime_is_rfc822
34995      condition = $mime_is_coverletter
34996      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
34997      message = HTML mail is not accepted here
34998 .endd
34999
35000 .vitem &$mime_is_multipart$&
35001 .vindex &$mime_is_multipart$&
35002 This variable has the value 1 (true) when the current part has the main type
35003 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
35004 Since multipart entities only serve as containers for other parts, you may not
35005 want to carry out specific actions on them.
35006
35007 .vitem &$mime_is_rfc822$&
35008 .vindex &$mime_is_rfc822$&
35009 This variable has the value 1 (true) if the current part is not a part of the
35010 checked message itself, but part of an attached message. Attached message
35011 decoding is fully recursive.
35012
35013 .vitem &$mime_part_count$&
35014 .vindex &$mime_part_count$&
35015 This variable is a counter that is raised for each processed MIME part. It
35016 starts at zero for the very first part (which is usually a multipart). The
35017 counter is per-message, so it is reset when processing RFC822 attachments (see
35018 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
35019 complete, so you can use it in the DATA ACL to determine the number of MIME
35020 parts of a message. For non-MIME messages, this variable contains the value -1.
35021 .endlist
35022
35023
35024
35025 .section "Scanning with regular expressions" "SECTscanregex"
35026 .cindex "content scanning" "with regular expressions"
35027 .cindex "regular expressions" "content scanning with"
35028 You can specify your own custom regular expression matches on the full body of
35029 the message, or on individual MIME parts.
35030
35031 The &%regex%& condition takes one or more regular expressions as arguments and
35032 matches them against the full message (when called in the DATA ACL) or a raw
35033 MIME part (when called in the MIME ACL). The &%regex%& condition matches
35034 linewise, with a maximum line length of 32K characters. That means you cannot
35035 have multiline matches with the &%regex%& condition.
35036
35037 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
35038 to 32K of decoded content (the whole content at once, not linewise). If the
35039 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
35040 is decoded automatically when &%mime_regex%& is executed (using default path
35041 and filename values). If the decoded data is larger than  32K, only the first
35042 32K characters are checked.
35043
35044 The regular expressions are passed as a colon-separated list. To include a
35045 literal colon, you must double it. Since the whole right-hand side string is
35046 expanded before being used, you must also escape dollar signs and backslashes
35047 with more backslashes, or use the &`\N`& facility to disable expansion.
35048 Here is a simple example that contains two regular expressions:
35049 .code
35050 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
35051      message = contains blacklisted regex ($regex_match_string)
35052 .endd
35053 The conditions returns true if any one of the regular expressions matches. The
35054 &$regex_match_string$& expansion variable is then set up and contains the
35055 matching regular expression.
35056 The expansion variables &$regex1$& &$regex2$& etc
35057 are set to any substrings captured by the regular expression.
35058
35059 &*Warning*&: With large messages, these conditions can be fairly
35060 CPU-intensive.
35061
35062 .ecindex IIDcosca
35063
35064
35065
35066
35067 . ////////////////////////////////////////////////////////////////////////////
35068 . ////////////////////////////////////////////////////////////////////////////
35069
35070 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
35071          "Local scan function"
35072 .scindex IIDlosca "&[local_scan()]& function" "description of"
35073 .cindex "customizing" "input scan using C function"
35074 .cindex "policy control" "by local scan function"
35075 In these days of email worms, viruses, and ever-increasing spam, some sites
35076 want to apply a lot of checking to messages before accepting them.
35077
35078 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
35079 passing messages to external virus and spam scanning software. You can also do
35080 a certain amount in Exim itself through string expansions and the &%condition%&
35081 condition in the ACL that runs after the SMTP DATA command or the ACL for
35082 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
35083
35084 To allow for further customization to a site's own requirements, there is the
35085 possibility of linking Exim with a private message scanning function, written
35086 in C. If you want to run code that is written in something other than C, you
35087 can of course use a little C stub to call it.
35088
35089 The local scan function is run once for every incoming message, at the point
35090 when Exim is just about to accept the message.
35091 It can therefore be used to control non-SMTP messages from local processes as
35092 well as messages arriving via SMTP.
35093
35094 Exim applies a timeout to calls of the local scan function, and there is an
35095 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
35096 Zero means &"no timeout"&.
35097 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
35098 before calling the local scan function, so that the most common types of crash
35099 are caught. If the timeout is exceeded or one of those signals is caught, the
35100 incoming message is rejected with a temporary error if it is an SMTP message.
35101 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
35102 code. The incident is logged on the main and reject logs.
35103
35104
35105
35106 .section "Building Exim to use a local scan function" "SECID207"
35107 .cindex "&[local_scan()]& function" "building Exim to use"
35108 To make use of the local scan function feature, you must tell Exim where your
35109 function is before building Exim, by setting
35110 both HAVE_LOCAL_SCAN and
35111 LOCAL_SCAN_SOURCE in your
35112 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
35113 directory, so you might set
35114 .code
35115 HAVE_LOCAL_SCAN=yes
35116 LOCAL_SCAN_SOURCE=Local/local_scan.c
35117 .endd
35118 for example. The function must be called &[local_scan()]&;
35119 the source file(s) for it should first #define LOCAL_SCAN
35120 and then #include "local_scan.h".
35121 It is called by
35122 Exim after it has received a message, when the success return code is about to
35123 be sent. This is after all the ACLs have been run. The return code from your
35124 function controls whether the message is actually accepted or not. There is a
35125 commented template function (that just accepts the message) in the file
35126 _src/local_scan.c_.
35127
35128 If you want to make use of Exim's runtime configuration file to set options
35129 for your &[local_scan()]& function, you must also set
35130 .code
35131 LOCAL_SCAN_HAS_OPTIONS=yes
35132 .endd
35133 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
35134
35135
35136
35137
35138 .section "API for local_scan()" "SECTapiforloc"
35139 .cindex "&[local_scan()]& function" "API description"
35140 .cindex &%dlfunc%& "API description"
35141 You must include this line near the start of your code:
35142 .code
35143 #define LOCAL_SCAN
35144 #include "local_scan.h"
35145 .endd
35146 This header file defines a number of variables and other values, and the
35147 prototype for the function itself. Exim is coded to use unsigned char values
35148 almost exclusively, and one of the things this header defines is a shorthand
35149 for &`unsigned char`& called &`uschar`&.
35150 It also makes available the following macro definitions, to simplify casting character
35151 strings and pointers to character strings:
35152 .code
35153 #define CS   (char *)
35154 #define CCS  (const char *)
35155 #define CSS  (char **)
35156 #define US   (unsigned char *)
35157 #define CUS  (const unsigned char *)
35158 #define USS  (unsigned char **)
35159 .endd
35160 The function prototype for &[local_scan()]& is:
35161 .code
35162 extern int local_scan(int fd, uschar **return_text);
35163 .endd
35164 The arguments are as follows:
35165
35166 .ilist
35167 &%fd%& is a file descriptor for the file that contains the body of the message
35168 (the -D file). The file is open for reading and writing, but updating it is not
35169 recommended. &*Warning*&: You must &'not'& close this file descriptor.
35170
35171 The descriptor is positioned at character 19 of the file, which is the first
35172 character of the body itself, because the first 19 characters are the message
35173 id followed by &`-D`& and a newline. If you rewind the file, you should use the
35174 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
35175 case this changes in some future version.
35176 .next
35177 &%return_text%& is an address which you can use to return a pointer to a text
35178 string at the end of the function. The value it points to on entry is NULL.
35179 .endlist
35180
35181 The function must return an &%int%& value which is one of the following macros:
35182
35183 .vlist
35184 .vitem &`LOCAL_SCAN_ACCEPT`&
35185 .vindex "&$local_scan_data$&"
35186 The message is accepted. If you pass back a string of text, it is saved with
35187 the message, and made available in the variable &$local_scan_data$&. No
35188 newlines are permitted (if there are any, they are turned into spaces) and the
35189 maximum length of text is 1000 characters.
35190
35191 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
35192 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35193 queued without immediate delivery, and is frozen.
35194
35195 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
35196 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35197 queued without immediate delivery.
35198
35199 .vitem &`LOCAL_SCAN_REJECT`&
35200 The message is rejected; the returned text is used as an error message which is
35201 passed back to the sender and which is also logged. Newlines are permitted &--
35202 they cause a multiline response for SMTP rejections, but are converted to
35203 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
35204 used.
35205
35206 .vitem &`LOCAL_SCAN_TEMPREJECT`&
35207 The message is temporarily rejected; the returned text is used as an error
35208 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
35209 problem"& is used.
35210
35211 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
35212 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
35213 message is not written to the reject log. It has the effect of unsetting the
35214 &%rejected_header%& log selector for just this rejection. If
35215 &%rejected_header%& is already unset (see the discussion of the
35216 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
35217 same as LOCAL_SCAN_REJECT.
35218
35219 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
35220 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
35221 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
35222 .endlist
35223
35224 If the message is not being received by interactive SMTP, rejections are
35225 reported by writing to &%stderr%& or by sending an email, as configured by the
35226 &%-oe%& command line options.
35227
35228
35229
35230 .section "Configuration options for local_scan()" "SECTconoptloc"
35231 .cindex "&[local_scan()]& function" "configuration options"
35232 It is possible to have option settings in the main configuration file
35233 that set values in static variables in the &[local_scan()]& module. If you
35234 want to do this, you must have the line
35235 .code
35236 LOCAL_SCAN_HAS_OPTIONS=yes
35237 .endd
35238 in your &_Local/Makefile_& when you build Exim. (This line is in
35239 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
35240 file, you must define static variables to hold the option values, and a table
35241 to define them.
35242
35243 The table must be a vector called &%local_scan_options%&, of type
35244 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
35245 and a pointer to the variable that holds the value. The entries must appear in
35246 alphabetical order. Following &%local_scan_options%& you must also define a
35247 variable called &%local_scan_options_count%& that contains the number of
35248 entries in the table. Here is a short example, showing two kinds of option:
35249 .code
35250 static int my_integer_option = 42;
35251 static uschar *my_string_option = US"a default string";
35252
35253 optionlist local_scan_options[] = {
35254   { "my_integer", opt_int,       &my_integer_option },
35255   { "my_string",  opt_stringptr, &my_string_option }
35256 };
35257
35258 int local_scan_options_count =
35259   sizeof(local_scan_options)/sizeof(optionlist);
35260 .endd
35261 The values of the variables can now be changed from Exim's runtime
35262 configuration file by including a local scan section as in this example:
35263 .code
35264 begin local_scan
35265 my_integer = 99
35266 my_string = some string of text...
35267 .endd
35268 The available types of option data are as follows:
35269
35270 .vlist
35271 .vitem &*opt_bool*&
35272 This specifies a boolean (true/false) option. The address should point to a
35273 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
35274 that are defined as &"1"& and &"0"&, respectively. If you want to detect
35275 whether such a variable has been set at all, you can initialize it to
35276 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
35277 values.)
35278
35279 .vitem &*opt_fixed*&
35280 This specifies a fixed point number, such as is used for load averages.
35281 The address should point to a variable of type &`int`&. The value is stored
35282 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
35283
35284 .vitem &*opt_int*&
35285 This specifies an integer; the address should point to a variable of type
35286 &`int`&. The value may be specified in any of the integer formats accepted by
35287 Exim.
35288
35289 .vitem &*opt_mkint*&
35290 This is the same as &%opt_int%&, except that when such a value is output in a
35291 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
35292 printed with the suffix K or M.
35293
35294 .vitem &*opt_octint*&
35295 This also specifies an integer, but the value is always interpreted as an
35296 octal integer, whether or not it starts with the digit zero, and it is
35297 always output in octal.
35298
35299 .vitem &*opt_stringptr*&
35300 This specifies a string value; the address must be a pointer to a
35301 variable that points to a string (for example, of type &`uschar *`&).
35302
35303 .vitem &*opt_time*&
35304 This specifies a time interval value. The address must point to a variable of
35305 type &`int`&. The value that is placed there is a number of seconds.
35306 .endlist
35307
35308 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
35309 out the values of all the &[local_scan()]& options.
35310
35311
35312
35313 .section "Available Exim variables" "SECID208"
35314 .cindex "&[local_scan()]& function" "available Exim variables"
35315 The header &_local_scan.h_& gives you access to a number of C variables. These
35316 are the only ones that are guaranteed to be maintained from release to release.
35317 Note, however, that you can obtain the value of any Exim expansion variable,
35318 including &$recipients$&, by calling &'expand_string()'&. The exported
35319 C variables are as follows:
35320
35321 .vlist
35322 .vitem &*int&~body_linecount*&
35323 This variable contains the number of lines in the message's body.
35324 It is not valid if the &%spool_wireformat%& option is used.
35325
35326 .vitem &*int&~body_zerocount*&
35327 This variable contains the number of binary zero bytes in the message's body.
35328 It is not valid if the &%spool_wireformat%& option is used.
35329
35330 .vitem &*unsigned&~int&~debug_selector*&
35331 This variable is set to zero when no debugging is taking place. Otherwise, it
35332 is a bitmap of debugging selectors. Two bits are identified for use in
35333 &[local_scan()]&; they are defined as macros:
35334
35335 .ilist
35336 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
35337 testing option that is not privileged &-- any caller may set it. All the
35338 other selector bits can be set only by admin users.
35339
35340 .next
35341 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
35342 by the &`+local_scan`& debug selector. It is not included in the default set
35343 of debugging bits.
35344 .endlist ilist
35345
35346 Thus, to write to the debugging output only when &`+local_scan`& has been
35347 selected, you should use code like this:
35348 .code
35349 if ((debug_selector & D_local_scan) != 0)
35350   debug_printf("xxx", ...);
35351 .endd
35352 .vitem &*uschar&~*expand_string_message*&
35353 After a failing call to &'expand_string()'& (returned value NULL), the
35354 variable &%expand_string_message%& contains the error message, zero-terminated.
35355
35356 .vitem &*header_line&~*header_list*&
35357 A pointer to a chain of header lines. The &%header_line%& structure is
35358 discussed below.
35359
35360 .vitem &*header_line&~*header_last*&
35361 A pointer to the last of the header lines.
35362
35363 .vitem &*const&~uschar&~*headers_charset*&
35364 The value of the &%headers_charset%& configuration option.
35365
35366 .vitem &*BOOL&~host_checking*&
35367 This variable is TRUE during a host checking session that is initiated by the
35368 &%-bh%& command line option.
35369
35370 .vitem &*uschar&~*interface_address*&
35371 The IP address of the interface that received the message, as a string. This
35372 is NULL for locally submitted messages.
35373
35374 .vitem &*int&~interface_port*&
35375 The port on which this message was received. When testing with the &%-bh%&
35376 command line option, the value of this variable is -1 unless a port has been
35377 specified via the &%-oMi%& option.
35378
35379 .vitem &*uschar&~*message_id*&
35380 This variable contains Exim's message id for the incoming message (the value of
35381 &$message_exim_id$&) as a zero-terminated string.
35382
35383 .vitem &*uschar&~*received_protocol*&
35384 The name of the protocol by which the message was received.
35385
35386 .vitem &*int&~recipients_count*&
35387 The number of accepted recipients.
35388
35389 .vitem &*recipient_item&~*recipients_list*&
35390 .cindex "recipient" "adding in local scan"
35391 .cindex "recipient" "removing in local scan"
35392 The list of accepted recipients, held in a vector of length
35393 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35394 can add additional recipients by calling &'receive_add_recipient()'& (see
35395 below). You can delete recipients by removing them from the vector and
35396 adjusting the value in &%recipients_count%&. In particular, by setting
35397 &%recipients_count%& to zero you remove all recipients. If you then return the
35398 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35399 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35400 and then call &'receive_add_recipient()'& as often as needed.
35401
35402 .vitem &*uschar&~*sender_address*&
35403 The envelope sender address. For bounce messages this is the empty string.
35404
35405 .vitem &*uschar&~*sender_host_address*&
35406 The IP address of the sending host, as a string. This is NULL for
35407 locally-submitted messages.
35408
35409 .vitem &*uschar&~*sender_host_authenticated*&
35410 The name of the authentication mechanism that was used, or NULL if the message
35411 was not received over an authenticated SMTP connection.
35412
35413 .vitem &*uschar&~*sender_host_name*&
35414 The name of the sending host, if known.
35415
35416 .vitem &*int&~sender_host_port*&
35417 The port on the sending host.
35418
35419 .vitem &*BOOL&~smtp_input*&
35420 This variable is TRUE for all SMTP input, including BSMTP.
35421
35422 .vitem &*BOOL&~smtp_batched_input*&
35423 This variable is TRUE for BSMTP input.
35424
35425 .vitem &*int&~store_pool*&
35426 The contents of this variable control which pool of memory is used for new
35427 requests. See section &<<SECTmemhanloc>>& for details.
35428 .endlist
35429
35430
35431 .section "Structure of header lines" "SECID209"
35432 The &%header_line%& structure contains the members listed below.
35433 You can add additional header lines by calling the &'header_add()'& function
35434 (see below). You can cause header lines to be ignored (deleted) by setting
35435 their type to *.
35436
35437
35438 .vlist
35439 .vitem &*struct&~header_line&~*next*&
35440 A pointer to the next header line, or NULL for the last line.
35441
35442 .vitem &*int&~type*&
35443 A code identifying certain headers that Exim recognizes. The codes are printing
35444 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35445 Notice in particular that any header line whose type is * is not transmitted
35446 with the message. This flagging is used for header lines that have been
35447 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35448 lines.) Effectively, * means &"deleted"&.
35449
35450 .vitem &*int&~slen*&
35451 The number of characters in the header line, including the terminating and any
35452 internal newlines.
35453
35454 .vitem &*uschar&~*text*&
35455 A pointer to the text of the header. It always ends with a newline, followed by
35456 a zero byte. Internal newlines are preserved.
35457 .endlist
35458
35459
35460
35461 .section "Structure of recipient items" "SECID210"
35462 The &%recipient_item%& structure contains these members:
35463
35464 .vlist
35465 .vitem &*uschar&~*address*&
35466 This is a pointer to the recipient address as it was received.
35467
35468 .vitem &*int&~pno*&
35469 This is used in later Exim processing when top level addresses are created by
35470 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35471 and must always contain -1 at this stage.
35472
35473 .vitem &*uschar&~*errors_to*&
35474 If this value is not NULL, bounce messages caused by failing to deliver to the
35475 recipient are sent to the address it contains. In other words, it overrides the
35476 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35477 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35478 an unqualified address, Exim qualifies it using the domain from
35479 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35480 is NULL for all recipients.
35481 .endlist
35482
35483
35484
35485 .section "Available Exim functions" "SECID211"
35486 .cindex "&[local_scan()]& function" "available Exim functions"
35487 The header &_local_scan.h_& gives you access to a number of Exim functions.
35488 These are the only ones that are guaranteed to be maintained from release to
35489 release:
35490
35491 .vlist
35492 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35493        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35494
35495 This function creates a child process that runs the command specified by
35496 &%argv%&. The environment for the process is specified by &%envp%&, which can
35497 be NULL if no environment variables are to be passed. A new umask is supplied
35498 for the process in &%newumask%&.
35499
35500 Pipes to the standard input and output of the new process are set up
35501 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35502 standard error is cloned to the standard output. If there are any file
35503 descriptors &"in the way"& in the new process, they are closed. If the final
35504 argument is TRUE, the new process is made into a process group leader.
35505
35506 The function returns the pid of the new process, or -1 if things go wrong.
35507
35508 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35509 This function waits for a child process to terminate, or for a timeout (in
35510 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35511 return value is as follows:
35512
35513 .ilist
35514 >= 0
35515
35516 The process terminated by a normal exit and the value is the process
35517 ending status.
35518
35519 .next
35520 < 0 and > &--256
35521
35522 The process was terminated by a signal and the value is the negation of the
35523 signal number.
35524
35525 .next
35526 &--256
35527
35528 The process timed out.
35529 .next
35530 &--257
35531
35532 The was some other error in wait(); &%errno%& is still set.
35533 .endlist
35534
35535 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35536 This function provide you with a means of submitting a new message to
35537 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35538 want, but this packages it all up for you.) The function creates a pipe,
35539 forks a subprocess that is running
35540 .code
35541 exim -t -oem -oi -f <>
35542 .endd
35543 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35544 that is connected to the standard input. The yield of the function is the PID
35545 of the subprocess. You can then write a message to the file descriptor, with
35546 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35547
35548 When you have finished, call &'child_close()'& to wait for the process to
35549 finish and to collect its ending status. A timeout value of zero is usually
35550 fine in this circumstance. Unless you have made a mistake with the recipient
35551 addresses, you should get a return code of zero.
35552
35553
35554 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35555        *sender_authentication)*&
35556 This function is a more sophisticated version of &'child_open()'&. The command
35557 that it runs is:
35558 .display
35559 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35560 .endd
35561 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35562
35563
35564 .vitem &*void&~debug_printf(char&~*,&~...)*&
35565 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35566 output is written to the standard error stream. If no debugging is selected,
35567 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35568 conditional on the &`local_scan`& debug selector by coding like this:
35569 .code
35570 if ((debug_selector & D_local_scan) != 0)
35571   debug_printf("xxx", ...);
35572 .endd
35573
35574 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35575 This is an interface to Exim's string expansion code. The return value is the
35576 expanded string, or NULL if there was an expansion failure.
35577 The C variable &%expand_string_message%& contains an error message after an
35578 expansion failure. If expansion does not change the string, the return value is
35579 the pointer to the input string. Otherwise, the return value points to a new
35580 block of memory that was obtained by a call to &'store_get()'&. See section
35581 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35582
35583 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35584 This function allows you to an add additional header line at the end of the
35585 existing ones. The first argument is the type, and should normally be a space
35586 character. The second argument is a format string and any number of
35587 substitution arguments as for &[sprintf()]&. You may include internal newlines
35588 if you want, and you must ensure that the string ends with a newline.
35589
35590 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
35591         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
35592 This function adds a new header line at a specified point in the header
35593 chain. The header itself is specified as for &'header_add()'&.
35594
35595 If &%name%& is NULL, the new header is added at the end of the chain if
35596 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
35597 NULL, the header lines are searched for the first non-deleted header that
35598 matches the name. If one is found, the new header is added before it if
35599 &%after%& is false. If &%after%& is true, the new header is added after the
35600 found header and any adjacent subsequent ones with the same name (even if
35601 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35602 option controls where the header is added. If it is true, addition is at the
35603 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35604 headers, or at the top if there are no &'Received:'& headers, you could use
35605 .code
35606 header_add_at_position(TRUE, US"Received", TRUE,
35607   ' ', "X-xxx: ...");
35608 .endd
35609 Normally, there is always at least one non-deleted &'Received:'& header, but
35610 there may not be if &%received_header_text%& expands to an empty string.
35611
35612
35613 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35614 This function removes header lines. If &%occurrence%& is zero or negative, all
35615 occurrences of the header are removed. If occurrence is greater than zero, that
35616 particular instance of the header is removed. If no header(s) can be found that
35617 match the specification, the function does nothing.
35618
35619
35620 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35621         int&~length,&~BOOL&~notdel)*&"
35622 This function tests whether the given header has the given name. It is not just
35623 a string comparison, because white space is permitted between the name and the
35624 colon. If the &%notdel%& argument is true, a false return is forced for all
35625 &"deleted"& headers; otherwise they are not treated specially. For example:
35626 .code
35627 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35628 .endd
35629 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35630 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35631 This function base64-encodes a string, which is passed by address and length.
35632 The text may contain bytes of any value, including zero. The result is passed
35633 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35634 zero-terminated.
35635
35636 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35637 This function decodes a base64-encoded string. Its arguments are a
35638 zero-terminated base64-encoded string and the address of a variable that is set
35639 to point to the result, which is in dynamic memory. The length of the decoded
35640 string is the yield of the function. If the input is invalid base64 data, the
35641 yield is -1. A zero byte is added to the end of the output string to make it
35642 easy to interpret as a C string (assuming it contains no zeros of its own). The
35643 added zero byte is not included in the returned count.
35644
35645 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35646 This function checks for a match in a domain list. Domains are always
35647 matched caselessly. The return value is one of the following:
35648 .itable none 0 0 2 15* left 85* left
35649 .irow &`OK`&    "match succeeded"
35650 .irow &`FAIL`&  "match failed"
35651 .irow &`DEFER`& "match deferred"
35652 .endtable
35653 DEFER is usually caused by some kind of lookup defer, such as the
35654 inability to contact a database.
35655
35656 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35657         BOOL&~caseless)*&"
35658 This function checks for a match in a local part list. The third argument
35659 controls case-sensitivity. The return values are as for
35660 &'lss_match_domain()'&.
35661
35662 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35663         BOOL&~caseless)*&"
35664 This function checks for a match in an address list. The third argument
35665 controls the case-sensitivity of the local part match. The domain is always
35666 matched caselessly. The return values are as for &'lss_match_domain()'&.
35667
35668 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35669         uschar&~*list)*&"
35670 This function checks for a match in a host list. The most common usage is
35671 expected to be
35672 .code
35673 lss_match_host(sender_host_name, sender_host_address, ...)
35674 .endd
35675 .vindex "&$sender_host_address$&"
35676 An empty address field matches an empty item in the host list. If the host name
35677 is NULL, the name corresponding to &$sender_host_address$& is automatically
35678 looked up if a host name is required to match an item in the list. The return
35679 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35680 returns ERROR in the case when it had to look up a host name, but the lookup
35681 failed.
35682
35683 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35684         *format,&~...)*&"
35685 This function writes to Exim's log files. The first argument should be zero (it
35686 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35687 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35688 them. It specifies to which log or logs the message is written. The remaining
35689 arguments are a format and relevant insertion arguments. The string should not
35690 contain any newlines, not even at the end.
35691
35692
35693 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35694 This function adds an additional recipient to the message. The first argument
35695 is the recipient address. If it is unqualified (has no domain), it is qualified
35696 with the &%qualify_recipient%& domain. The second argument must always be -1.
35697
35698 This function does not allow you to specify a private &%errors_to%& address (as
35699 described with the structure of &%recipient_item%& above), because it pre-dates
35700 the addition of that field to the structure. However, it is easy to add such a
35701 value afterwards. For example:
35702 .code
35703  receive_add_recipient(US"monitor@mydom.example", -1);
35704  recipients_list[recipients_count-1].errors_to =
35705    US"postmaster@mydom.example";
35706 .endd
35707
35708 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35709 This is a convenience function to remove a named recipient from the list of
35710 recipients. It returns true if a recipient was removed, and false if no
35711 matching recipient could be found. The argument must be a complete email
35712 address.
35713 .endlist
35714
35715
35716 .cindex "RFC 2047"
35717 .vlist
35718 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35719   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35720 This function decodes strings that are encoded according to RFC 2047. Typically
35721 these are the contents of header lines. First, each &"encoded word"& is decoded
35722 from the Q or B encoding into a byte-string. Then, if provided with the name of
35723 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35724 made  to translate the result to the named character set. If this fails, the
35725 binary string is returned with an error message.
35726
35727 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35728 maximum MIME word length is enforced. The third argument is the target
35729 encoding, or NULL if no translation is wanted.
35730
35731 .cindex "binary zero" "in RFC 2047 decoding"
35732 .cindex "RFC 2047" "binary zero in"
35733 If a binary zero is encountered in the decoded string, it is replaced by the
35734 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35735 not be 0 because header lines are handled as zero-terminated strings.
35736
35737 The function returns the result of processing the string, zero-terminated; if
35738 &%lenptr%& is not NULL, the length of the result is set in the variable to
35739 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35740
35741 If an error is encountered, the function returns NULL and uses the &%error%&
35742 argument to return an error message. The variable pointed to by &%error%& is
35743 set to NULL if there is no error; it may be set non-NULL even when the function
35744 returns a non-NULL value if decoding was successful, but there was a problem
35745 with translation.
35746
35747
35748 .vitem &*int&~smtp_fflush(void)*&
35749 This function is used in conjunction with &'smtp_printf()'&, as described
35750 below.
35751
35752 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35753 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35754 output stream. You should use this function only when there is an SMTP output
35755 stream, that is, when the incoming message is being received via interactive
35756 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35757 is FALSE. If you want to test for an incoming message from another host (as
35758 opposed to a local process that used the &%-bs%& command line option), you can
35759 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35760 is involved.
35761
35762 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35763 output function, so it can be used for all forms of SMTP connection.
35764
35765 The second argument is used to request that the data be buffered
35766 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35767 This is advisory only, but likely to save on system-calls and packets
35768 sent when a sequence of calls to the function are made.
35769
35770 The argument was added in Exim version 4.90 - changing the API/ABI.
35771 Nobody noticed until 4.93 was imminent, at which point the
35772 ABI version number was incremented.
35773
35774 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35775 must start with an appropriate response code: 550 if you are going to return
35776 LOCAL_SCAN_REJECT, 451 if you are going to return
35777 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35778 initial lines of a multi-line response, the code must be followed by a hyphen
35779 to indicate that the line is not the final response line. You must also ensure
35780 that the lines you write terminate with CRLF. For example:
35781 .code
35782 smtp_printf("550-this is some extra info\r\n");
35783 return LOCAL_SCAN_REJECT;
35784 .endd
35785 Note that you can also create multi-line responses by including newlines in
35786 the data returned via the &%return_text%& argument. The added value of using
35787 &'smtp_printf()'& is that, for instance, you could introduce delays between
35788 multiple output lines.
35789
35790 The &'smtp_printf()'& function does not return any error indication, because it
35791 does not
35792 guarantee a flush of
35793 pending output, and therefore does not test
35794 the state of the stream. (In the main code of Exim, flushing and error
35795 detection is done when Exim is ready for the next SMTP input command.) If
35796 you want to flush the output and check for an error (for example, the
35797 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35798 arguments. It flushes the output stream, and returns a non-zero value if there
35799 is an error.
35800
35801 .vitem &*void&~*store_get(int,BOOL)*&
35802 This function accesses Exim's internal store (memory) manager. It gets a new
35803 chunk of memory whose size is given by the first argument.
35804 The second argument should be given as TRUE if the memory will be used for
35805 data possibly coming from an attacker (eg. the message content),
35806 FALSE if it is locally-sourced.
35807 Exim bombs out if it ever
35808 runs out of memory. See the next section for a discussion of memory handling.
35809
35810 .vitem &*void&~*store_get_perm(int,BOOL)*&
35811 This function is like &'store_get()'&, but it always gets memory from the
35812 permanent pool. See the next section for a discussion of memory handling.
35813
35814 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35815 See below.
35816
35817 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35818 See below.
35819
35820 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
35821 These three functions create strings using Exim's dynamic memory facilities.
35822 The first makes a copy of an entire string. The second copies up to a maximum
35823 number of characters, indicated by the second argument. The third uses a format
35824 and insertion arguments to create a new string. In each case, the result is a
35825 pointer to a new string in the current memory pool. See the next section for
35826 more discussion.
35827 .endlist
35828
35829
35830
35831 .section "More about Exim's memory handling" "SECTmemhanloc"
35832 .cindex "&[local_scan()]& function" "memory handling"
35833 No function is provided for freeing memory, because that is never needed.
35834 The dynamic memory that Exim uses when receiving a message is automatically
35835 recycled if another message is received by the same process (this applies only
35836 to incoming SMTP connections &-- other input methods can supply only one
35837 message at a time). After receiving the last message, a reception process
35838 terminates.
35839
35840 Because it is recycled, the normal dynamic memory cannot be used for holding
35841 data that must be preserved over a number of incoming messages on the same SMTP
35842 connection. However, Exim in fact uses two pools of dynamic memory; the second
35843 one is not recycled, and can be used for this purpose.
35844
35845 If you want to allocate memory that remains available for subsequent messages
35846 in the same SMTP connection, you should set
35847 .code
35848 store_pool = POOL_PERM
35849 .endd
35850 before calling the function that does the allocation. There is no need to
35851 restore the value if you do not need to; however, if you do want to revert to
35852 the normal pool, you can either restore the previous value of &%store_pool%& or
35853 set it explicitly to POOL_MAIN.
35854
35855 The pool setting applies to all functions that get dynamic memory, including
35856 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
35857 There is also a convenience function called &'store_get_perm()'& that gets a
35858 block of memory from the permanent pool while preserving the value of
35859 &%store_pool%&.
35860 .ecindex IIDlosca
35861
35862
35863
35864
35865 . ////////////////////////////////////////////////////////////////////////////
35866 . ////////////////////////////////////////////////////////////////////////////
35867
35868 .chapter "System-wide message filtering" "CHAPsystemfilter"
35869 .scindex IIDsysfil1 "filter" "system filter"
35870 .scindex IIDsysfil2 "filtering all mail"
35871 .scindex IIDsysfil3 "system filter"
35872 The previous chapters (on ACLs and the local scan function) describe checks
35873 that can be applied to messages before they are accepted by a host. There is
35874 also a mechanism for checking messages once they have been received, but before
35875 they are delivered. This is called the &'system filter'&.
35876
35877 The system filter operates in a similar manner to users' filter files, but it
35878 is run just once per message (however many recipients the message has).
35879 It should not normally be used as a substitute for routing, because &%deliver%&
35880 commands in a system router provide new envelope recipient addresses.
35881 The system filter must be an Exim filter. It cannot be a Sieve filter.
35882
35883 The system filter is run at the start of a delivery attempt, before any routing
35884 is done. If a message fails to be completely delivered at the first attempt,
35885 the system filter is run again at the start of every retry.
35886 If you want your filter to do something only once per message, you can make use
35887 .cindex retry condition
35888 of the &%first_delivery%& condition in an &%if%& command in the filter to
35889 prevent it happening on retries.
35890
35891 .vindex "&$domain$&"
35892 .vindex "&$local_part$&"
35893 &*Warning*&: Because the system filter runs just once, variables that are
35894 specific to individual recipient addresses, such as &$local_part$& and
35895 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
35896 you want to run a centrally-specified filter for each recipient address
35897 independently, you can do so by setting up a suitable &(redirect)& router, as
35898 described in section &<<SECTperaddfil>>& below.
35899
35900
35901 .section "Specifying a system filter" "SECID212"
35902 .cindex "uid (user id)" "system filter"
35903 .cindex "gid (group id)" "system filter"
35904 The name of the file that contains the system filter must be specified by
35905 setting &%system_filter%&. If you want the filter to run under a uid and gid
35906 other than root, you must also set &%system_filter_user%& and
35907 &%system_filter_group%& as appropriate. For example:
35908 .code
35909 system_filter = /etc/mail/exim.filter
35910 system_filter_user = exim
35911 .endd
35912 If a system filter generates any deliveries directly to files or pipes (via the
35913 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
35914 specified by setting &%system_filter_file_transport%& and
35915 &%system_filter_pipe_transport%&, respectively. Similarly,
35916 &%system_filter_reply_transport%& must be set to handle any messages generated
35917 by the &%reply%& command.
35918
35919
35920 .section "Testing a system filter" "SECID213"
35921 You can run simple tests of a system filter in the same way as for a user
35922 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
35923 are permitted only in system filters are recognized.
35924
35925 If you want to test the combined effect of a system filter and a user filter,
35926 you can use both &%-bF%& and &%-bf%& on the same command line.
35927
35928
35929
35930 .section "Contents of a system filter" "SECID214"
35931 The language used to specify system filters is the same as for users' filter
35932 files. It is described in the separate end-user document &'Exim's interface to
35933 mail filtering'&. However, there are some additional features that are
35934 available only in system filters; these are described in subsequent sections.
35935 If they are encountered in a user's filter file or when testing with &%-bf%&,
35936 they cause errors.
35937
35938 .cindex "frozen messages" "manual thaw; testing in filter"
35939 There are two special conditions which, though available in users' filter
35940 files, are designed for use in system filters. The condition &%first_delivery%&
35941 is true only for the first attempt at delivering a message, and
35942 &%manually_thawed%& is true only if the message has been frozen, and
35943 subsequently thawed by an admin user. An explicit forced delivery counts as a
35944 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
35945
35946 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
35947 specify an &"unseen"& (non-significant) delivery, and that delivery does not
35948 succeed, it will not be tried again.
35949 If you want Exim to retry an unseen delivery until it succeeds, you should
35950 arrange to set it up every time the filter runs.
35951
35952 When a system filter finishes running, the values of the variables &$n0$& &--
35953 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
35954 users' filter files. Thus a system filter can, for example, set up &"scores"&
35955 to which users' filter files can refer.
35956
35957
35958
35959 .section "Additional variable for system filters" "SECID215"
35960 .vindex "&$recipients$&"
35961 The expansion variable &$recipients$&, containing a list of all the recipients
35962 of the message (separated by commas and white space), is available in system
35963 filters. It is not available in users' filters for privacy reasons.
35964
35965
35966
35967 .section "Defer, freeze, and fail commands for system filters" "SECID216"
35968 .cindex "freezing messages"
35969 .cindex "message" "freezing"
35970 .cindex "message" "forced failure"
35971 .cindex "&%fail%&" "in system filter"
35972 .cindex "&%freeze%& in system filter"
35973 .cindex "&%defer%& in system filter"
35974 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
35975 always available in system filters, but are not normally enabled in users'
35976 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
35977 for the &(redirect)& router.) These commands can optionally be followed by the
35978 word &%text%& and a string containing an error message, for example:
35979 .code
35980 fail text "this message looks like spam to me"
35981 .endd
35982 The keyword &%text%& is optional if the next character is a double quote.
35983
35984 The &%defer%& command defers delivery of the original recipients of the
35985 message. The &%fail%& command causes all the original recipients to be failed,
35986 and a bounce message to be created. The &%freeze%& command suspends all
35987 delivery attempts for the original recipients. In all cases, any new deliveries
35988 that are specified by the filter are attempted as normal after the filter has
35989 run.
35990
35991 The &%freeze%& command is ignored if the message has been manually unfrozen and
35992 not manually frozen since. This means that automatic freezing by a system
35993 filter can be used as a way of checking out suspicious messages. If a message
35994 is found to be all right, manually unfreezing it allows it to be delivered.
35995
35996 .cindex "log" "&%fail%& command log line"
35997 .cindex "&%fail%&" "log line; reducing"
35998 The text given with a fail command is used as part of the bounce message as
35999 well as being written to the log. If the message is quite long, this can fill
36000 up a lot of log space when such failures are common. To reduce the size of the
36001 log message, Exim interprets the text in a special way if it starts with the
36002 two characters &`<<`& and contains &`>>`& later. The text between these two
36003 strings is written to the log, and the rest of the text is used in the bounce
36004 message. For example:
36005 .code
36006 fail "<<filter test 1>>Your message is rejected \
36007      because it contains attachments that we are \
36008      not prepared to receive."
36009 .endd
36010
36011 .cindex "loop" "caused by &%fail%&"
36012 Take great care with the &%fail%& command when basing the decision to fail on
36013 the contents of the message, because the bounce message will of course include
36014 the contents of the original message and will therefore trigger the &%fail%&
36015 command again (causing a mail loop) unless steps are taken to prevent this.
36016 Testing the &%error_message%& condition is one way to prevent this. You could
36017 use, for example
36018 .code
36019 if $message_body contains "this is spam" and not error_message
36020 then fail text "spam is not wanted here" endif
36021 .endd
36022 though of course that might let through unwanted bounce messages. The
36023 alternative is clever checking of the body and/or headers to detect bounces
36024 generated by the filter.
36025
36026 The interpretation of a system filter file ceases after a
36027 &%defer%&,
36028 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
36029 set up earlier in the filter file are honoured, so you can use a sequence such
36030 as
36031 .code
36032 mail ...
36033 freeze
36034 .endd
36035 to send a specified message when the system filter is freezing (or deferring or
36036 failing) a message. The normal deliveries for the message do not, of course,
36037 take place.
36038
36039
36040
36041 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
36042 .cindex "header lines" "adding; in system filter"
36043 .cindex "header lines" "removing; in system filter"
36044 .cindex "filter" "header lines; adding/removing"
36045 Two filter commands that are available only in system filters are:
36046 .code
36047 headers add <string>
36048 headers remove <string>
36049 .endd
36050 The argument for the &%headers add%& is a string that is expanded and then
36051 added to the end of the message's headers. It is the responsibility of the
36052 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
36053 space is ignored, and if the string is otherwise empty, or if the expansion is
36054 forced to fail, the command has no effect.
36055
36056 You can use &"\n"& within the string, followed by white space, to specify
36057 continued header lines. More than one header may be added in one command by
36058 including &"\n"& within the string without any following white space. For
36059 example:
36060 .code
36061 headers add "X-header-1: ....\n  \
36062              continuation of X-header-1 ...\n\
36063              X-header-2: ...."
36064 .endd
36065 Note that the header line continuation white space after the first newline must
36066 be placed before the backslash that continues the input string, because white
36067 space after input continuations is ignored.
36068
36069 The argument for &%headers remove%& is a colon-separated list of header names.
36070 This command applies only to those headers that are stored with the message;
36071 those that are added at delivery time (such as &'Envelope-To:'& and
36072 &'Return-Path:'&) cannot be removed by this means. If there is more than one
36073 header with the same name, they are all removed.
36074
36075 The &%headers%& command in a system filter makes an immediate change to the set
36076 of header lines that was received with the message (with possible additions
36077 from ACL processing). Subsequent commands in the system filter operate on the
36078 modified set, which also forms the basis for subsequent message delivery.
36079 Unless further modified during routing or transporting, this set of headers is
36080 used for all recipients of the message.
36081
36082 During routing and transporting, the variables that refer to the contents of
36083 header lines refer only to those lines that are in this set. Thus, header lines
36084 that are added by a system filter are visible to users' filter files and to all
36085 routers and transports. This contrasts with the manipulation of header lines by
36086 routers and transports, which is not immediate, but which instead is saved up
36087 until the message is actually being written (see section
36088 &<<SECTheadersaddrem>>&).
36089
36090 If the message is not delivered at the first attempt, header lines that were
36091 added by the system filter are stored with the message, and so are still
36092 present at the next delivery attempt. Header lines that were removed are still
36093 present, but marked &"deleted"& so that they are not transported with the
36094 message. For this reason, it is usual to make the &%headers%& command
36095 conditional on &%first_delivery%& so that the set of header lines is not
36096 modified more than once.
36097
36098 Because header modification in a system filter acts immediately, you have to
36099 use an indirect approach if you want to modify the contents of a header line.
36100 For example:
36101 .code
36102 headers add "Old-Subject: $h_subject:"
36103 headers remove "Subject"
36104 headers add "Subject: new subject (was: $h_old-subject:)"
36105 headers remove "Old-Subject"
36106 .endd
36107
36108
36109
36110 .section "Setting an errors address in a system filter" "SECID217"
36111 .cindex "envelope from"
36112 .cindex "envelope sender"
36113 In a system filter, if a &%deliver%& command is followed by
36114 .code
36115 errors_to <some address>
36116 .endd
36117 in order to change the envelope sender (and hence the error reporting) for that
36118 delivery, any address may be specified. (In a user filter, only the current
36119 user's address can be set.) For example, if some mail is being monitored, you
36120 might use
36121 .code
36122 unseen deliver monitor@spying.example errors_to root@local.example
36123 .endd
36124 to take a copy which would not be sent back to the normal error reporting
36125 address if its delivery failed.
36126
36127
36128
36129 .section "Per-address filtering" "SECTperaddfil"
36130 .vindex "&$domain_data$&"
36131 .vindex "&$local_part_data$&"
36132 In contrast to the system filter, which is run just once per message for each
36133 delivery attempt, it is also possible to set up a system-wide filtering
36134 operation that runs once for each recipient address. In this case, variables
36135 such as &$local_part_data$& and &$domain_data$& can be used,
36136 and indeed, the choice of filter file could be made dependent on them.
36137 This is an example of a router which implements such a filter:
36138 .code
36139 central_filter:
36140   check_local_user
36141   driver = redirect
36142   domains = +local_domains
36143   file = /central/filters/$local_part_data
36144   no_verify
36145   allow_filter
36146   allow_freeze
36147 .endd
36148 The filter is run in a separate process under its own uid. Therefore, either
36149 &%check_local_user%& must be set (as above), in which case the filter is run as
36150 the local user, or the &%user%& option must be used to specify which user to
36151 use. If both are set, &%user%& overrides.
36152
36153 Care should be taken to ensure that none of the commands in the filter file
36154 specify a significant delivery if the message is to go on to be delivered to
36155 its intended recipient. The router will not then claim to have dealt with the
36156 address, so it will be passed on to subsequent routers to be delivered in the
36157 normal way.
36158 .ecindex IIDsysfil1
36159 .ecindex IIDsysfil2
36160 .ecindex IIDsysfil3
36161
36162
36163
36164
36165
36166
36167 . ////////////////////////////////////////////////////////////////////////////
36168 . ////////////////////////////////////////////////////////////////////////////
36169
36170 .chapter "Message processing" "CHAPmsgproc"
36171 .scindex IIDmesproc "message" "general processing"
36172 Exim performs various transformations on the sender and recipient addresses of
36173 all messages that it handles, and also on the messages' header lines. Some of
36174 these are optional and configurable, while others always take place. All of
36175 this processing, except rewriting as a result of routing, and the addition or
36176 removal of header lines while delivering, happens when a message is received,
36177 before it is placed on Exim's queue.
36178
36179 Some of the automatic processing takes place by default only for
36180 &"locally-originated"& messages. This adjective is used to describe messages
36181 that are not received over TCP/IP, but instead are passed to an Exim process on
36182 its standard input. This includes the interactive &"local SMTP"& case that is
36183 set up by the &%-bs%& command line option.
36184
36185 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
36186 or ::1) are not considered to be locally-originated. Exim does not treat the
36187 loopback interface specially in any way.
36188
36189 If you want the loopback interface to be treated specially, you must ensure
36190 that there are appropriate entries in your ACLs.
36191
36192
36193
36194
36195 .section "Submission mode for non-local messages" "SECTsubmodnon"
36196 .cindex "message" "submission"
36197 .cindex "submission mode"
36198 Processing that happens automatically for locally-originated messages (unless
36199 &%suppress_local_fixups%& is set) can also be requested for messages that are
36200 received over TCP/IP. The term &"submission mode"& is used to describe this
36201 state. Submission mode is set by the modifier
36202 .code
36203 control = submission
36204 .endd
36205 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
36206 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
36207 a local submission, and is normally used when the source of the message is
36208 known to be an MUA running on a client host (as opposed to an MTA). For
36209 example, to set submission mode for messages originating on the IPv4 loopback
36210 interface, you could include the following in the MAIL ACL:
36211 .code
36212 warn  hosts = 127.0.0.1
36213       control = submission
36214 .endd
36215 .cindex "&%sender_retain%& submission option"
36216 There are some options that can be used when setting submission mode. A slash
36217 is used to separate options. For example:
36218 .code
36219 control = submission/sender_retain
36220 .endd
36221 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
36222 true and &%local_from_check%& false for the current incoming message. The first
36223 of these allows an existing &'Sender:'& header in the message to remain, and
36224 the second suppresses the check to ensure that &'From:'& matches the
36225 authenticated sender. With this setting, Exim still fixes up messages by adding
36226 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
36227 attempt to check sender authenticity in header lines.
36228
36229 When &%sender_retain%& is not set, a submission mode setting may specify a
36230 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
36231 example:
36232 .code
36233 control = submission/domain=some.domain
36234 .endd
36235 The domain may be empty. How this value is used is described in sections
36236 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
36237 that allows you to specify the user's full name for inclusion in a created
36238 &'Sender:'& or &'From:'& header line. For example:
36239 .code
36240 accept authenticated = *
36241        control = submission/domain=wonderland.example/\
36242                             name=${lookup {$authenticated_id} \
36243                                    lsearch {/etc/exim/namelist}}
36244 .endd
36245 Because the name may contain any characters, including slashes, the &%name%&
36246 option must be given last. The remainder of the string is used as the name. For
36247 the example above, if &_/etc/exim/namelist_& contains:
36248 .code
36249 bigegg:  Humpty Dumpty
36250 .endd
36251 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
36252 line would be:
36253 .code
36254 Sender: Humpty Dumpty <bigegg@wonderland.example>
36255 .endd
36256 .cindex "return path" "in submission mode"
36257 By default, submission mode forces the return path to the same address as is
36258 used to create the &'Sender:'& header. However, if &%sender_retain%& is
36259 specified, the return path is also left unchanged.
36260
36261 &*Note*&: The changes caused by submission mode take effect after the predata
36262 ACL. This means that any sender checks performed before the fix-ups use the
36263 untrusted sender address specified by the user, not the trusted sender address
36264 specified by submission mode. Although this might be slightly unexpected, it
36265 does mean that you can configure ACL checks to spot that a user is trying to
36266 spoof another's address.
36267
36268 .section "Line endings" "SECTlineendings"
36269 .cindex "line endings"
36270 .cindex "carriage return"
36271 .cindex "linefeed"
36272 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
36273 linefeed) is the line ending for messages transmitted over the Internet using
36274 SMTP over TCP/IP. However, within individual operating systems, different
36275 conventions are used. For example, Unix-like systems use just LF, but others
36276 use CRLF or just CR.
36277
36278 Exim was designed for Unix-like systems, and internally, it stores messages
36279 using the system's convention of a single LF as a line terminator. When
36280 receiving a message, all line endings are translated to this standard format.
36281 Originally, it was thought that programs that passed messages directly to an
36282 MTA within an operating system would use that system's convention. Experience
36283 has shown that this is not the case; for example, there are Unix applications
36284 that use CRLF in this circumstance. For this reason, and for compatibility with
36285 other MTAs, the way Exim handles line endings for all messages is now as
36286 follows:
36287
36288 .ilist
36289 LF not preceded by CR is treated as a line ending.
36290 .next
36291 CR is treated as a line ending; if it is immediately followed by LF, the LF
36292 is ignored.
36293 .next
36294 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
36295 nor a local message in the state where a line containing only a dot is a
36296 terminator.
36297 .next
36298 If a bare CR is encountered within a header line, an extra space is added after
36299 the line terminator so as not to end the header line. The reasoning behind this
36300 is that bare CRs in header lines are most likely either to be mistakes, or
36301 people trying to play silly games.
36302 .next
36303 If the first header line received in a message ends with CRLF, a subsequent
36304 bare LF in a header line is treated in the same way as a bare CR in a header
36305 line.
36306 .endlist
36307
36308
36309
36310
36311
36312 .section "Unqualified addresses" "SECID218"
36313 .cindex "unqualified addresses"
36314 .cindex "address" "qualification"
36315 By default, Exim expects every envelope address it receives from an external
36316 host to be fully qualified. Unqualified addresses cause negative responses to
36317 SMTP commands. However, because SMTP is used as a means of transporting
36318 messages from MUAs running on personal workstations, there is sometimes a
36319 requirement to accept unqualified addresses from specific hosts or IP networks.
36320
36321 Exim has two options that separately control which hosts may send unqualified
36322 sender or recipient addresses in SMTP commands, namely
36323 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
36324 cases, if an unqualified address is accepted, it is qualified by adding the
36325 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
36326
36327 .oindex "&%qualify_domain%&"
36328 .oindex "&%qualify_recipient%&"
36329 Unqualified addresses in header lines are automatically qualified for messages
36330 that are locally originated, unless the &%-bnq%& option is given on the command
36331 line. For messages received over SMTP, unqualified addresses in header lines
36332 are qualified only if unqualified addresses are permitted in SMTP commands. In
36333 other words, such qualification is also controlled by
36334 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
36335
36336
36337
36338
36339 .section "The UUCP From line" "SECID219"
36340 .cindex "&""From""& line"
36341 .cindex "UUCP" "&""From""& line"
36342 .cindex "sender" "address"
36343 .oindex "&%uucp_from_pattern%&"
36344 .oindex "&%uucp_from_sender%&"
36345 .cindex "envelope from"
36346 .cindex "envelope sender"
36347 .cindex "Sendmail compatibility" "&""From""& line"
36348 Messages that have come from UUCP (and some other applications) often begin
36349 with a line containing the envelope sender and a timestamp, following the word
36350 &"From"&. Examples of two common formats are:
36351 .code
36352 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
36353 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
36354 .endd
36355 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
36356 Exim recognizes such lines at the start of messages that are submitted to it
36357 via the command line (that is, on the standard input). It does not recognize
36358 such lines in incoming SMTP messages, unless the sending host matches
36359 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36360 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36361 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36362 default value matches the two common cases shown above and puts the address
36363 that follows &"From"& into &$1$&.
36364
36365 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36366 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36367 a trusted user, the message's sender address is constructed by expanding the
36368 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36369 then parsed as an RFC 2822 address. If there is no domain, the local part is
36370 qualified with &%qualify_domain%& unless it is the empty string. However, if
36371 the command line &%-f%& option is used, it overrides the &"From"& line.
36372
36373 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36374 sender address is not changed. This is also the case for incoming SMTP messages
36375 that are permitted to contain &"From"& lines.
36376
36377 Only one &"From"& line is recognized. If there is more than one, the second is
36378 treated as a data line that starts the body of the message, as it is not valid
36379 as a header line. This also happens if a &"From"& line is present in an
36380 incoming SMTP message from a source that is not permitted to send them.
36381
36382
36383
36384 .section "Header lines"
36385 .subsection "Resent- header lines" SECID220
36386 .chindex Resent-
36387 RFC 2822 makes provision for sets of header lines starting with the string
36388 &`Resent-`& to be added to a message when it is resent by the original
36389 recipient to somebody else. These headers are &'Resent-Date:'&,
36390 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36391 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36392
36393 .blockquote
36394 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36395 processing of replies or other such automatic actions on messages.'&
36396 .endblockquote
36397
36398 This leaves things a bit vague as far as other processing actions such as
36399 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36400 follows:
36401
36402 .ilist
36403 A &'Resent-From:'& line that just contains the login id of the submitting user
36404 is automatically rewritten in the same way as &'From:'& (see below).
36405 .next
36406 If there's a rewriting rule for a particular header line, it is also applied to
36407 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36408 &'From:'& also rewrites &'Resent-From:'&.
36409 .next
36410 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36411 also removed.
36412 .next
36413 For a locally-submitted message,
36414 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36415 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36416 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36417 included in log lines in this case.
36418 .next
36419 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36420 &%Resent-%& header lines are present.
36421 .endlist
36422
36423
36424
36425
36426 .subsection Auto-Submitted: SECID221
36427 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36428 includes the header line:
36429 .code
36430 Auto-Submitted: auto-replied
36431 .endd
36432
36433 .subsection Bcc: SECID222
36434 .cindex "&'Bcc:'& header line"
36435 If Exim is called with the &%-t%& option, to take recipient addresses from a
36436 message's header, it removes any &'Bcc:'& header line that may exist (after
36437 extracting its addresses). If &%-t%& is not present on the command line, any
36438 existing &'Bcc:'& is not removed.
36439
36440
36441 .subsection Date: SECID223
36442 .cindex Date:
36443 If a locally-generated or submission-mode message has no &'Date:'& header line,
36444 Exim adds one, using the current date and time, unless the
36445 &%suppress_local_fixups%& control has been specified.
36446
36447 .subsection Delivery-date: SECID224
36448 .cindex "&'Delivery-date:'& header line"
36449 .oindex "&%delivery_date_remove%&"
36450 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36451 set. Exim can be configured to add them to the final delivery of messages. (See
36452 the generic &%delivery_date_add%& transport option.) They should not be present
36453 in messages in transit. If the &%delivery_date_remove%& configuration option is
36454 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36455 messages.
36456
36457
36458 .subsection Envelope-to: SECID225
36459 .chindex Envelope-to:
36460 .oindex "&%envelope_to_remove%&"
36461 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36462 Exim can be configured to add them to the final delivery of messages. (See the
36463 generic &%envelope_to_add%& transport option.) They should not be present in
36464 messages in transit. If the &%envelope_to_remove%& configuration option is set
36465 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36466 messages.
36467
36468
36469 .subsection From: SECTthefrohea
36470 .chindex From:
36471 .cindex "Sendmail compatibility" "&""From""& line"
36472 .cindex "message" "submission"
36473 .cindex "submission mode"
36474 If a submission-mode message does not contain a &'From:'& header line, Exim
36475 adds one if either of the following conditions is true:
36476
36477 .ilist
36478 The envelope sender address is not empty (that is, this is not a bounce
36479 message). The added header line copies the envelope sender address.
36480 .next
36481 .vindex "&$authenticated_id$&"
36482 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36483 .olist
36484 .vindex "&$qualify_domain$&"
36485 If no domain is specified by the submission control, the local part is
36486 &$authenticated_id$& and the domain is &$qualify_domain$&.
36487 .next
36488 If a non-empty domain is specified by the submission control, the local
36489 part is &$authenticated_id$&, and the domain is the specified domain.
36490 .next
36491 If an empty domain is specified by the submission control,
36492 &$authenticated_id$& is assumed to be the complete address.
36493 .endlist
36494 .endlist
36495
36496 A non-empty envelope sender takes precedence.
36497
36498 If a locally-generated incoming message does not contain a &'From:'& header
36499 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36500 containing the sender's address. The calling user's login name and full name
36501 are used to construct the address, as described in section &<<SECTconstr>>&.
36502 They are obtained from the password data by calling &[getpwuid()]& (but see the
36503 &%unknown_login%& configuration option). The address is qualified with
36504 &%qualify_domain%&.
36505
36506 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36507 &'From:'& header line containing just the unqualified login name of the calling
36508 user, this is replaced by an address containing the user's login name and full
36509 name as described in section &<<SECTconstr>>&.
36510
36511
36512 .subsection Message-ID: SECID226
36513 .chindex Message-ID:
36514 .cindex "message" "submission"
36515 .oindex "&%message_id_header_text%&"
36516 If a locally-generated or submission-mode incoming message does not contain a
36517 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36518 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36519 to the message. If there are any &'Resent-:'& headers in the message, it
36520 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36521 message id, preceded by the letter E to ensure it starts with a letter, and
36522 followed by @ and the primary host name. Additional information can be included
36523 in this header line by setting the &%message_id_header_text%& and/or
36524 &%message_id_header_domain%& options.
36525
36526
36527 .subsection Received: SECID227
36528 .chindex Received:
36529 A &'Received:'& header line is added at the start of every message. The
36530 contents are defined by the &%received_header_text%& configuration option, and
36531 Exim automatically adds a semicolon and a timestamp to the configured string.
36532
36533 The &'Received:'& header is generated as soon as the message's header lines
36534 have been received. At this stage, the timestamp in the &'Received:'& header
36535 line is the time that the message started to be received. This is the value
36536 that is seen by the DATA ACL and by the &[local_scan()]& function.
36537
36538 Once a message is accepted, the timestamp in the &'Received:'& header line is
36539 changed to the time of acceptance, which is (apart from a small delay while the
36540 -H spool file is written) the earliest time at which delivery could start.
36541
36542
36543 .subsection References: SECID228
36544 .chindex References:
36545 Messages created by the &(autoreply)& transport include a &'References:'&
36546 header line. This is constructed according to the rules that are described in
36547 section 3.64 of RFC 2822 (which states that replies should contain such a
36548 header line), and section 3.14 of RFC 3834 (which states that automatic
36549 responses are not different in this respect). However, because some mail
36550 processing software does not cope well with very long header lines, no more
36551 than 12 message IDs are copied from the &'References:'& header line in the
36552 incoming message. If there are more than 12, the first one and then the final
36553 11 are copied, before adding the message ID of the incoming message.
36554
36555
36556
36557 .subsection Return-path: SECID229
36558 .chindex Return-path:
36559 .oindex "&%return_path_remove%&"
36560 &'Return-path:'& header lines are defined as something an MTA may insert when
36561 it does the final delivery of messages. (See the generic &%return_path_add%&
36562 transport option.) Therefore, they should not be present in messages in
36563 transit. If the &%return_path_remove%& configuration option is set (the
36564 default), Exim removes &'Return-path:'& header lines from incoming messages.
36565
36566
36567
36568 .subsection Sender: SECTthesenhea
36569 .cindex "&'Sender:'& header line"
36570 .cindex "message" "submission"
36571 .chindex Sender:
36572 For a locally-originated message from an untrusted user, Exim may remove an
36573 existing &'Sender:'& header line, and it may add a new one. You can modify
36574 these actions by setting the &%local_sender_retain%& option true, the
36575 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36576 control setting.
36577
36578 When a local message is received from an untrusted user and
36579 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36580 control has not been set, a check is made to see if the address given in the
36581 &'From:'& header line is the correct (local) sender of the message. The address
36582 that is expected has the login name as the local part and the value of
36583 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36584 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36585 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36586 line is added to the message.
36587
36588 If you set &%local_from_check%& false, this checking does not occur. However,
36589 the removal of an existing &'Sender:'& line still happens, unless you also set
36590 &%local_sender_retain%& to be true. It is not possible to set both of these
36591 options true at the same time.
36592
36593 .cindex "submission mode"
36594 By default, no processing of &'Sender:'& header lines is done for messages
36595 received over TCP/IP or for messages submitted by trusted users. However, when
36596 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36597 not specified on the submission control, the following processing takes place:
36598
36599 .vindex "&$authenticated_id$&"
36600 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36601 authenticated, and &$authenticated_id$& is not empty, a sender address is
36602 created as follows:
36603
36604 .ilist
36605 .vindex "&$qualify_domain$&"
36606 If no domain is specified by the submission control, the local part is
36607 &$authenticated_id$& and the domain is &$qualify_domain$&.
36608 .next
36609 If a non-empty domain is specified by the submission control, the local part
36610 is &$authenticated_id$&, and the domain is the specified domain.
36611 .next
36612 If an empty domain is specified by the submission control,
36613 &$authenticated_id$& is assumed to be the complete address.
36614 .endlist
36615
36616 This address is compared with the address in the &'From:'& header line. If they
36617 are different, a &'Sender:'& header line containing the created address is
36618 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36619 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36620
36621 .cindex "return path" "created from &'Sender:'&"
36622 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36623 the message (the envelope sender address) is changed to be the same address,
36624 except in the case of submission mode when &%sender_retain%& is specified.
36625
36626
36627
36628 .section "Adding and removing header lines in routers and transports" &&&
36629          "SECTheadersaddrem"
36630 .cindex "header lines" "adding; in router or transport"
36631 .cindex "header lines" "removing; in router or transport"
36632 When a message is delivered, the addition and removal of header lines can be
36633 specified in a system filter, or on any of the routers and transports that
36634 process the message. Section &<<SECTaddremheasys>>& contains details about
36635 modifying headers in a system filter. Header lines can also be added in an ACL
36636 as a message is received (see section &<<SECTaddheadacl>>&).
36637
36638 In contrast to what happens in a system filter, header modifications that are
36639 specified on routers and transports apply only to the particular recipient
36640 addresses that are being processed by those routers and transports. These
36641 changes do not actually take place until a copy of the message is being
36642 transported. Therefore, they do not affect the basic set of header lines, and
36643 they do not affect the values of the variables that refer to header lines.
36644
36645 &*Note*&: In particular, this means that any expansions in the configuration of
36646 the transport cannot refer to the modified header lines, because such
36647 expansions all occur before the message is actually transported.
36648
36649 For both routers and transports, the argument of a &%headers_add%&
36650 option must be in the form of one or more RFC 2822 header lines, separated by
36651 newlines (coded as &"\n"&). For example:
36652 .code
36653 headers_add = X-added-header: added by $primary_hostname\n\
36654               X-added-second: another added header line
36655 .endd
36656 Exim does not check the syntax of these added header lines.
36657
36658 Multiple &%headers_add%& options for a single router or transport can be
36659 specified; the values will append to a single list of header lines.
36660 Each header-line is separately expanded.
36661
36662 The argument of a &%headers_remove%& option must consist of a colon-separated
36663 list of header names. This is confusing, because header names themselves are
36664 often terminated by colons. In this case, the colons are the list separators,
36665 not part of the names. For example:
36666 .code
36667 headers_remove = return-receipt-to:acknowledge-to
36668 .endd
36669
36670 Multiple &%headers_remove%& options for a single router or transport can be
36671 specified; the arguments will append to a single header-names list.
36672 Each item is separately expanded.
36673 Note that colons in complex expansions which are used to
36674 form all or part of a &%headers_remove%& list
36675 will act as list separators.
36676
36677 When &%headers_add%& or &%headers_remove%& is specified on a router,
36678 items are expanded at routing time,
36679 and then associated with all addresses that are
36680 accepted by that router, and also with any new addresses that it generates. If
36681 an address passes through several routers as a result of aliasing or
36682 forwarding, the changes are cumulative.
36683
36684 .oindex "&%unseen%&"
36685 However, this does not apply to multiple routers that result from the use of
36686 the &%unseen%& option. Any header modifications that were specified by the
36687 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36688
36689 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36690 settings cannot be delivered together in a batch, so a transport is always
36691 dealing with a set of addresses that have the same header-processing
36692 requirements.
36693
36694 The transport starts by writing the original set of header lines that arrived
36695 with the message, possibly modified by the system filter. As it writes out
36696 these lines, it consults the list of header names that were attached to the
36697 recipient address(es) by &%headers_remove%& options in routers, and it also
36698 consults the transport's own &%headers_remove%& option. Header lines whose
36699 names are on either of these lists are not written out. If there are multiple
36700 instances of any listed header, they are all skipped.
36701
36702 After the remaining original header lines have been written, new header
36703 lines that were specified by routers' &%headers_add%& options are written, in
36704 the order in which they were attached to the address. These are followed by any
36705 header lines specified by the transport's &%headers_add%& option.
36706
36707 This way of handling header line modifications in routers and transports has
36708 the following consequences:
36709
36710 .ilist
36711 The original set of header lines, possibly modified by the system filter,
36712 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36713 to it, at all times.
36714 .next
36715 Header lines that are added by a router's
36716 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36717 expansion syntax in subsequent routers or the transport.
36718 .next
36719 Conversely, header lines that are specified for removal by &%headers_remove%&
36720 in a router remain visible to subsequent routers and the transport.
36721 .next
36722 Headers added to an address by &%headers_add%& in a router cannot be removed by
36723 a later router or by a transport.
36724 .next
36725 An added header can refer to the contents of an original header that is to be
36726 removed, even it has the same name as the added header. For example:
36727 .code
36728 headers_remove = subject
36729 headers_add = Subject: new subject (was: $h_subject:)
36730 .endd
36731 .endlist
36732
36733 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36734 for a &(redirect)& router that has the &%one_time%& option set.
36735
36736
36737
36738
36739
36740 .section "Constructed addresses" "SECTconstr"
36741 .cindex "address" "constructed"
36742 .cindex "constructed address"
36743 When Exim constructs a sender address for a locally-generated message, it uses
36744 the form
36745 .display
36746 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36747 .endd
36748 For example:
36749 .code
36750 Zaphod Beeblebrox <zaphod@end.univ.example>
36751 .endd
36752 The user name is obtained from the &%-F%& command line option if set, or
36753 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36754 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36755 ampersand character, this is replaced by the login name with the first letter
36756 upper cased, as is conventional in a number of operating systems. See the
36757 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36758 The &%unknown_username%& option can be used to specify user names in cases when
36759 there is no password file entry.
36760
36761 .cindex "RFC 2047"
36762 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36763 parts of it if necessary. In addition, if it contains any non-printing
36764 characters, it is encoded as described in RFC 2047, which defines a way of
36765 including non-ASCII characters in header lines. The value of the
36766 &%headers_charset%& option specifies the name of the encoding that is used (the
36767 characters are assumed to be in this encoding). The setting of
36768 &%print_topbitchars%& controls whether characters with the top bit set (that
36769 is, with codes greater than 127) count as printing characters or not.
36770
36771
36772
36773 .section "Case of local parts" "SECID230"
36774 .cindex "case of local parts"
36775 .cindex "local part" "case of"
36776 RFC 2822 states that the case of letters in the local parts of addresses cannot
36777 be assumed to be non-significant. Exim preserves the case of local parts of
36778 addresses, but by default it uses a lower-cased form when it is routing,
36779 because on most Unix systems, usernames are in lower case and case-insensitive
36780 routing is required. However, any particular router can be made to use the
36781 original case for local parts by setting the &%caseful_local_part%& generic
36782 router option.
36783
36784 .cindex "mixed-case login names"
36785 If you must have mixed-case user names on your system, the best way to proceed,
36786 assuming you want case-independent handling of incoming email, is to set up
36787 your first router to convert incoming local parts in your domains to the
36788 correct case by means of a file lookup. For example:
36789 .code
36790 correct_case:
36791   driver = redirect
36792   domains = +local_domains
36793   data = ${lookup{$local_part}cdb\
36794               {/etc/usercased.cdb}{$value}fail}\
36795               @$domain
36796 .endd
36797 For this router, the local part is forced to lower case by the default action
36798 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36799 up a new local part in the correct case. If you then set &%caseful_local_part%&
36800 on any subsequent routers which process your domains, they will operate on
36801 local parts with the correct case in a case-sensitive manner.
36802
36803
36804
36805 .section "Dots in local parts" "SECID231"
36806 .cindex "dot" "in local part"
36807 .cindex "local part" "dots in"
36808 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36809 part may not begin or end with a dot, nor have two consecutive dots in the
36810 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36811 empty components for compatibility.
36812
36813
36814
36815 .section "Rewriting addresses" "SECID232"
36816 .cindex "rewriting" "addresses"
36817 Rewriting of sender and recipient addresses, and addresses in headers, can
36818 happen automatically, or as the result of configuration options, as described
36819 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
36820 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
36821
36822 Automatic rewriting includes qualification, as mentioned above. The other case
36823 in which it can happen is when an incomplete non-local domain is given. The
36824 routing process may cause this to be expanded into the full domain name. For
36825 example, a header such as
36826 .code
36827 To: hare@teaparty
36828 .endd
36829 might get rewritten as
36830 .code
36831 To: hare@teaparty.wonderland.fict.example
36832 .endd
36833 Rewriting as a result of routing is the one kind of message processing that
36834 does not happen at input time, as it cannot be done until the address has
36835 been routed.
36836
36837 Strictly, one should not do &'any'& deliveries of a message until all its
36838 addresses have been routed, in case any of the headers get changed as a
36839 result of routing. However, doing this in practice would hold up many
36840 deliveries for unreasonable amounts of time, just because one address could not
36841 immediately be routed. Exim therefore does not delay other deliveries when
36842 routing of one or more addresses is deferred.
36843 .ecindex IIDmesproc
36844
36845
36846
36847 . ////////////////////////////////////////////////////////////////////////////
36848 . ////////////////////////////////////////////////////////////////////////////
36849
36850 .chapter "SMTP processing" "CHAPSMTP"
36851 .scindex IIDsmtpproc1 "SMTP" "processing details"
36852 .scindex IIDsmtpproc2 "LMTP" "processing details"
36853 Exim supports a number of different ways of using the SMTP protocol, and its
36854 LMTP variant, which is an interactive protocol for transferring messages into a
36855 closed mail store application. This chapter contains details of how SMTP is
36856 processed. For incoming mail, the following are available:
36857
36858 .ilist
36859 SMTP over TCP/IP (Exim daemon or &'inetd'&);
36860 .next
36861 SMTP over the standard input and output (the &%-bs%& option);
36862 .next
36863 Batched SMTP on the standard input (the &%-bS%& option).
36864 .endlist
36865
36866 For mail delivery, the following are available:
36867
36868 .ilist
36869 SMTP over TCP/IP (the &(smtp)& transport);
36870 .next
36871 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
36872 &"lmtp"&);
36873 .next
36874 LMTP over a pipe to a process running in the local host (the &(lmtp)&
36875 transport);
36876 .next
36877 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
36878 the &%use_bsmtp%& option set).
36879 .endlist
36880
36881 &'Batched SMTP'& is the name for a process in which batches of messages are
36882 stored in or read from files (or pipes), in a format in which SMTP commands are
36883 used to contain the envelope information.
36884
36885
36886
36887 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
36888 .cindex "SMTP" "outgoing over TCP/IP"
36889 .cindex "outgoing SMTP over TCP/IP"
36890 .cindex "LMTP" "over TCP/IP"
36891 .cindex "outgoing LMTP over TCP/IP"
36892 .cindex "EHLO"
36893 .cindex "HELO"
36894 .cindex "SIZE" "option on MAIL command"
36895 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
36896 The &%protocol%& option selects which protocol is to be used, but the actual
36897 processing is the same in both cases.
36898
36899 .cindex "ESMTP extensions" SIZE
36900 If, in response to its EHLO command, Exim is told that the SIZE
36901 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
36902 command. The value of <&'n'&> is the message size plus the value of the
36903 &%size_addition%& option (default 1024) to allow for additions to the message
36904 such as per-transport header lines, or changes made in a
36905 .cindex "transport" "filter"
36906 .cindex "filter" "transport filter"
36907 transport filter. If &%size_addition%& is set negative, the use of SIZE is
36908 suppressed.
36909
36910 If the remote server advertises support for PIPELINING, Exim uses the
36911 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
36912 required for the transaction.
36913
36914 If the remote server advertises support for the STARTTLS command, and Exim
36915 was built to support TLS encryption, it tries to start a TLS session unless the
36916 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
36917 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
36918 is called for verification.
36919
36920 If the remote server advertises support for the AUTH command, Exim scans
36921 the authenticators configuration for any suitable client settings, as described
36922 in chapter &<<CHAPSMTPAUTH>>&.
36923
36924 .cindex "carriage return"
36925 .cindex "linefeed"
36926 Responses from the remote host are supposed to be terminated by CR followed by
36927 LF. However, there are known to be hosts that do not send CR characters, so in
36928 order to be able to interwork with such hosts, Exim treats LF on its own as a
36929 line terminator.
36930
36931 If a message contains a number of different addresses, all those with the same
36932 characteristics (for example, the same envelope sender) that resolve to the
36933 same set of hosts, in the same order, are sent in a single SMTP transaction,
36934 even if they are for different domains, unless there are more than the setting
36935 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
36936 they are split into groups containing no more than &%max_rcpt%&s addresses
36937 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
36938 in parallel sessions. The order of hosts with identical MX values is not
36939 significant when checking whether addresses can be batched in this way.
36940
36941 When the &(smtp)& transport suffers a temporary failure that is not
36942 message-related, Exim updates its transport-specific database, which contains
36943 records indexed by host name that remember which messages are waiting for each
36944 particular host. It also updates the retry database with new retry times.
36945
36946 .cindex "hints database" "retry keys"
36947 Exim's retry hints are based on host name plus IP address, so if one address of
36948 a multi-homed host is broken, it will soon be skipped most of the time.
36949 See the next section for more detail about error handling.
36950
36951 .cindex "SMTP" "passed connection"
36952 .cindex "SMTP" "batching over TCP/IP"
36953 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
36954 looks in the hints database for the transport to see if there are any queued
36955 messages waiting for the host to which it is connected. If it finds one, it
36956 creates a new Exim process using the &%-MC%& option (which can only be used by
36957 a process running as root or the Exim user) and passes the TCP/IP socket to it
36958 so that it can deliver another message using the same socket. The new process
36959 does only those deliveries that are routed to the connected host, and may in
36960 turn pass the socket on to a third process, and so on.
36961
36962 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
36963 limit the number of messages sent down a single TCP/IP connection.
36964
36965 .cindex "asterisk" "after IP address"
36966 The second and subsequent messages delivered down an existing connection are
36967 identified in the main log by the addition of an asterisk after the closing
36968 square bracket of the IP address.
36969
36970
36971
36972
36973 .subsection "Errors in outgoing SMTP" SECToutSMTPerr
36974 .cindex "error" "in outgoing SMTP"
36975 .cindex "SMTP" "errors in outgoing"
36976 .cindex "host" "error"
36977 Three different kinds of error are recognized for outgoing SMTP: host errors,
36978 message errors, and recipient errors.
36979
36980 .vlist
36981 .vitem "&*Host errors*&"
36982 A host error is not associated with a particular message or with a
36983 particular recipient of a message. The host errors are:
36984
36985 .ilist
36986 Connection refused or timed out,
36987 .next
36988 Any error response code on connection,
36989 .next
36990 Any error response code to EHLO or HELO,
36991 .next
36992 Loss of connection at any time, except after &"."&,
36993 .next
36994 I/O errors at any time,
36995 .next
36996 Timeouts during the session, other than in response to MAIL, RCPT or
36997 the &"."& at the end of the data.
36998 .endlist ilist
36999
37000 For a host error, a permanent error response on connection, or in response to
37001 EHLO, causes all addresses routed to the host to be failed. Any other host
37002 error causes all addresses to be deferred, and retry data to be created for the
37003 host. It is not tried again, for any message, until its retry time arrives. If
37004 the current set of addresses are not all delivered in this run (to some
37005 alternative host), the message is added to the list of those waiting for this
37006 host, so if it is still undelivered when a subsequent successful delivery is
37007 made to the host, it will be sent down the same SMTP connection.
37008
37009 .vitem "&*Message errors*&"
37010 .cindex "message" "error"
37011 A message error is associated with a particular message when sent to a
37012 particular host, but not with a particular recipient of the message. The
37013 message errors are:
37014
37015 .ilist
37016 Any error response code to MAIL, DATA, or the &"."& that terminates
37017 the data,
37018 .next
37019 Timeout after MAIL,
37020 .next
37021 Timeout or loss of connection after the &"."& that terminates the data. A
37022 timeout after the DATA command itself is treated as a host error, as is loss of
37023 connection at any other time.
37024 .endlist ilist
37025
37026 For a message error, a permanent error response (5&'xx'&) causes all addresses
37027 to be failed, and a delivery error report to be returned to the sender. A
37028 temporary error response (4&'xx'&), or one of the timeouts, causes all
37029 addresses to be deferred. Retry data is not created for the host, but instead,
37030 a retry record for the combination of host plus message id is created. The
37031 message is not added to the list of those waiting for this host. This ensures
37032 that the failing message will not be sent to this host again until the retry
37033 time arrives. However, other messages that are routed to the host are not
37034 affected, so if it is some property of the message that is causing the error,
37035 it will not stop the delivery of other mail.
37036
37037 If the remote host specified support for the SIZE parameter in its response
37038 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
37039 over-large message will cause a message error because the error arrives as a
37040 response to MAIL.
37041
37042 .vitem "&*Recipient errors*&"
37043 .cindex "recipient" "error"
37044 A recipient error is associated with a particular recipient of a message. The
37045 recipient errors are:
37046
37047 .ilist
37048 Any error response to RCPT,
37049 .next
37050 Timeout after RCPT.
37051 .endlist
37052
37053 For a recipient error, a permanent error response (5&'xx'&) causes the
37054 recipient address to be failed, and a bounce message to be returned to the
37055 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
37056 address to be deferred, and routing retry data to be created for it. This is
37057 used to delay processing of the address in subsequent queue runs, until its
37058 routing retry time arrives. This applies to all messages, but because it
37059 operates only in queue runs, one attempt will be made to deliver a new message
37060 to the failing address before the delay starts to operate. This ensures that,
37061 if the failure is really related to the message rather than the recipient
37062 (&"message too big for this recipient"& is a possible example), other messages
37063 have a chance of getting delivered. If a delivery to the address does succeed,
37064 the retry information gets cleared, so all stuck messages get tried again, and
37065 the retry clock is reset.
37066
37067 The message is not added to the list of those waiting for this host. Use of the
37068 host for other messages is unaffected, and except in the case of a timeout,
37069 other recipients are processed independently, and may be successfully delivered
37070 in the current SMTP session. After a timeout it is of course impossible to
37071 proceed with the session, so all addresses get deferred. However, those other
37072 than the one that failed do not suffer any subsequent retry delays. Therefore,
37073 if one recipient is causing trouble, the others have a chance of getting
37074 through when a subsequent delivery attempt occurs before the failing
37075 recipient's retry time.
37076 .endlist
37077
37078 In all cases, if there are other hosts (or IP addresses) available for the
37079 current set of addresses (for example, from multiple MX records), they are
37080 tried in this run for any undelivered addresses, subject of course to their
37081 own retry data. In other words, recipient error retry data does not take effect
37082 until the next delivery attempt.
37083
37084 Some hosts have been observed to give temporary error responses to every
37085 MAIL command at certain times (&"insufficient space"& has been seen). It
37086 would be nice if such circumstances could be recognized, and defer data for the
37087 host itself created, but this is not possible within the current Exim design.
37088 What actually happens is that retry data for every (host, message) combination
37089 is created.
37090
37091 The reason that timeouts after MAIL and RCPT are treated specially is that
37092 these can sometimes arise as a result of the remote host's verification
37093 procedures. Exim makes this assumption, and treats them as if a temporary error
37094 response had been received. A timeout after &"."& is treated specially because
37095 it is known that some broken implementations fail to recognize the end of the
37096 message if the last character of the last line is a binary zero. Thus, it is
37097 helpful to treat this case as a message error.
37098
37099 Timeouts at other times are treated as host errors, assuming a problem with the
37100 host, or the connection to it. If a timeout after MAIL, RCPT,
37101 or &"."& is really a connection problem, the assumption is that at the next try
37102 the timeout is likely to occur at some other point in the dialogue, causing it
37103 then to be treated as a host error.
37104
37105 There is experimental evidence that some MTAs drop the connection after the
37106 terminating &"."& if they do not like the contents of the message for some
37107 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
37108 should be given. That is why Exim treats this case as a message rather than a
37109 host error, in order not to delay other messages to the same host.
37110
37111
37112
37113
37114 .section "Incoming SMTP messages over TCP/IP" "SECID233"
37115 .cindex "SMTP" "incoming over TCP/IP"
37116 .cindex "incoming SMTP over TCP/IP"
37117 .cindex "inetd"
37118 .cindex "daemon"
37119 Incoming SMTP messages can be accepted in one of two ways: by running a
37120 listening daemon, or by using &'inetd'&. In the latter case, the entry in
37121 &_/etc/inetd.conf_& should be like this:
37122 .code
37123 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
37124 .endd
37125 Exim distinguishes between this case and the case of a locally running user
37126 agent using the &%-bs%& option by checking whether or not the standard input is
37127 a socket. When it is, either the port must be privileged (less than 1024), or
37128 the caller must be root or the Exim user. If any other user passes a socket
37129 with an unprivileged port number, Exim prints a message on the standard error
37130 stream and exits with an error code.
37131
37132 By default, Exim does not make a log entry when a remote host connects or
37133 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
37134 unexpected. It can be made to write such log entries by setting the
37135 &%smtp_connection%& log selector.
37136
37137 .cindex "carriage return"
37138 .cindex "linefeed"
37139 Commands from the remote host are supposed to be terminated by CR followed by
37140 LF. However, there are known to be hosts that do not send CR characters. In
37141 order to be able to interwork with such hosts, Exim treats LF on its own as a
37142 line terminator.
37143 Furthermore, because common code is used for receiving messages from all
37144 sources, a CR on its own is also interpreted as a line terminator. However, the
37145 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
37146
37147 .cindex "EHLO" "invalid data"
37148 .cindex "HELO" "invalid data"
37149 One area that sometimes gives rise to problems concerns the EHLO or
37150 HELO commands. Some clients send syntactically invalid versions of these
37151 commands, which Exim rejects by default. (This is nothing to do with verifying
37152 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
37153 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
37154 match the broken hosts that send invalid commands.
37155
37156 .cindex "SIZE option on MAIL command"
37157 .cindex "MAIL" "SIZE option"
37158 The amount of disk space available is checked whenever SIZE is received on
37159 a MAIL command, independently of whether &%message_size_limit%& or
37160 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
37161 false. A temporary error is given if there is not enough space. If
37162 &%check_spool_space%& is set, the check is for that amount of space plus the
37163 value given with SIZE, that is, it checks that the addition of the incoming
37164 message will not reduce the space below the threshold.
37165
37166 When a message is successfully received, Exim includes the local message id in
37167 its response to the final &"."& that terminates the data. If the remote host
37168 logs this text it can help with tracing what has happened to a message.
37169
37170 The Exim daemon can limit the number of simultaneous incoming connections it is
37171 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
37172 number of simultaneous incoming connections from a single remote host (see the
37173 &%smtp_accept_max_per_host%& option). Additional connection attempts are
37174 rejected using the SMTP temporary error code 421.
37175
37176 The Exim daemon does not rely on the SIGCHLD signal to detect when a
37177 subprocess has finished, as this can get lost at busy times. Instead, it looks
37178 for completed subprocesses every time it wakes up. Provided there are other
37179 things happening (new incoming calls, starts of queue runs), completed
37180 processes will be noticed and tidied away. On very quiet systems you may
37181 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
37182 it will be noticed when the daemon next wakes up.
37183
37184 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
37185 and can also be set up to reject SMTP calls from non-reserved hosts at times of
37186 high system load &-- for details see the &%smtp_accept_reserve%&,
37187 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
37188 applies in both the daemon and &'inetd'& cases.
37189
37190 Exim normally starts a delivery process for each message received, though this
37191 can be varied by means of the &%-odq%& command line option and the
37192 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
37193 number of simultaneously running delivery processes started in this way from
37194 SMTP input can be limited by the &%smtp_accept_queue%& and
37195 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
37196 subsequently received messages are just put on the input queue without starting
37197 a delivery process.
37198
37199 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
37200 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
37201 started up from the &'inetd'& daemon, because in that case each connection is
37202 handled by an entirely independent Exim process. Control by load average is,
37203 however, available with &'inetd'&.
37204
37205 Exim can be configured to verify addresses in incoming SMTP commands as they
37206 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
37207 to rewrite addresses at this time &-- before any syntax checking is done. See
37208 section &<<SSECTrewriteS>>&.
37209
37210 Exim can also be configured to limit the rate at which a client host submits
37211 MAIL and RCPT commands in a single SMTP session. See the
37212 &%smtp_ratelimit_hosts%& option.
37213
37214
37215
37216 .subsection "Unrecognized SMTP commands" SECID234
37217 .cindex "SMTP" "unrecognized commands"
37218 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
37219 commands during a single SMTP connection, it drops the connection after sending
37220 the error response to the last command. The default value for
37221 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
37222 abuse that subvert web servers into making connections to SMTP ports; in these
37223 circumstances, a number of non-SMTP lines are sent first.
37224
37225
37226 .subsection "Syntax and protocol errors in SMTP commands" SECID235
37227 .cindex "SMTP" "syntax errors"
37228 .cindex "SMTP" "protocol errors"
37229 A syntax error is detected if an SMTP command is recognized, but there is
37230 something syntactically wrong with its data, for example, a malformed email
37231 address in a RCPT command. Protocol errors include invalid command
37232 sequencing such as RCPT before MAIL. If Exim receives more than
37233 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
37234 drops the connection after sending the error response to the last command. The
37235 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
37236 broken clients that loop sending bad commands (yes, it has been seen).
37237
37238
37239
37240 .subsection "Use of non-mail SMTP commands" SECID236
37241 .cindex "SMTP" "non-mail commands"
37242 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
37243 DATA. Exim counts such commands, and drops the connection if there are too
37244 many of them in a single SMTP session. This action catches some
37245 denial-of-service attempts and things like repeated failing AUTHs, or a mad
37246 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
37247 defines what &"too many"& means. Its default value is 10.
37248
37249 When a new message is expected, one occurrence of RSET is not counted. This
37250 allows a client to send one RSET between messages (this is not necessary,
37251 but some clients do it). Exim also allows one uncounted occurrence of HELO
37252 or EHLO, and one occurrence of STARTTLS between messages. After
37253 starting up a TLS session, another EHLO is expected, and so it too is not
37254 counted.
37255
37256 The first occurrence of AUTH in a connection, or immediately following
37257 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
37258 RCPT, DATA, and QUIT are counted.
37259
37260 You can control which hosts are subject to the limit set by
37261 &%smtp_accept_max_nonmail%& by setting
37262 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
37263 the limit apply to all hosts. This option means that you can exclude any
37264 specific badly-behaved hosts that you have to live with.
37265
37266
37267
37268
37269 .subsection "The VRFY and EXPN commands" SECID237
37270 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
37271 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
37272 appropriate) in order to decide whether the command should be accepted or not.
37273
37274 .cindex "VRFY" "processing"
37275 When no ACL is defined for VRFY, or if it rejects without
37276 setting an explicit response code, the command is accepted
37277 (with a 252 SMTP response code)
37278 in order to support awkward clients that do a VRFY before every RCPT.
37279 When VRFY is accepted, it runs exactly the same code as when Exim is
37280 called with the &%-bv%& option, and returns 250/451/550
37281 SMTP response codes.
37282
37283 .cindex "EXPN" "processing"
37284 If no ACL for EXPN is defined, the command is rejected.
37285 When EXPN is accepted, a single-level expansion of the address is done.
37286 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
37287 than a verification (the &%-bv%& option). If an unqualified local part is given
37288 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
37289 of VRFY and EXPN commands are logged on the main and reject logs, and
37290 VRFY verification failures are logged in the main log for consistency with
37291 RCPT failures.
37292
37293
37294
37295 .subsection "The ETRN command" SECTETRN
37296 .cindex "ETRN" "processing"
37297 .cindex "ESMTP extensions" ETRN
37298 RFC 1985 describes an ESMTP command called ETRN that is designed to
37299 overcome the security problems of the TURN command (which has fallen into
37300 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
37301 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
37302 should be accepted or not. If no ACL is defined, the command is rejected.
37303
37304 The ETRN command is concerned with &"releasing"& messages that are awaiting
37305 delivery to certain hosts. As Exim does not organize its message queue by host,
37306 the only form of ETRN that is supported by default is the one where the
37307 text starts with the &"#"& prefix, in which case the remainder of the text is
37308 specific to the SMTP server. A valid ETRN command causes a run of Exim with
37309 the &%-R%& option to happen, with the remainder of the ETRN text as its
37310 argument. For example,
37311 .code
37312 ETRN #brigadoon
37313 .endd
37314 runs the command
37315 .code
37316 exim -R brigadoon
37317 .endd
37318 which causes a delivery attempt on all messages with undelivered addresses
37319 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
37320 default), Exim prevents the simultaneous execution of more than one queue run
37321 for the same argument string as a result of an ETRN command. This stops
37322 a misbehaving client from starting more than one queue runner at once.
37323
37324 .cindex "hints database" "ETRN serialization"
37325 Exim implements the serialization by means of a hints database in which a
37326 record is written whenever a process is started by ETRN, and deleted when
37327 the process completes. However, Exim does not keep the SMTP session waiting for
37328 the ETRN process to complete. Once ETRN is accepted, the client is sent
37329 a &"success"& return code. Obviously there is scope for hints records to get
37330 left lying around if there is a system or program crash. To guard against this,
37331 Exim ignores any records that are more than six hours old.
37332
37333 .oindex "&%smtp_etrn_command%&"
37334 For more control over what ETRN does, the &%smtp_etrn_command%& option can
37335 used. This specifies a command that is run whenever ETRN is received,
37336 whatever the form of its argument. For
37337 example:
37338 .code
37339 smtp_etrn_command = /etc/etrn_command $domain \
37340                     $sender_host_address
37341 .endd
37342 .vindex "&$domain$&"
37343 The string is split up into arguments which are independently expanded. The
37344 expansion variable &$domain$& is set to the argument of the ETRN command,
37345 and no syntax checking is done on the contents of this argument. Exim does not
37346 wait for the command to complete, so its status code is not checked. Exim runs
37347 under its own uid and gid when receiving incoming SMTP, so it is not possible
37348 for it to change them before running the command.
37349
37350
37351
37352 .section "Incoming local SMTP" "SECID238"
37353 .cindex "SMTP" "local incoming"
37354 Some user agents use SMTP to pass messages to their local MTA using the
37355 standard input and output, as opposed to passing the envelope on the command
37356 line and writing the message to the standard input. This is supported by the
37357 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37358 messages over TCP/IP (including the use of ACLs), except that the envelope
37359 sender given in a MAIL command is ignored unless the caller is trusted. In
37360 an ACL you can detect this form of SMTP input by testing for an empty host
37361 identification. It is common to have this as the first line in the ACL that
37362 runs for RCPT commands:
37363 .code
37364 accept hosts = :
37365 .endd
37366 This accepts SMTP messages from local processes without doing any other tests.
37367
37368
37369
37370 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37371 .cindex "SMTP" "batched outgoing"
37372 .cindex "batched SMTP output"
37373 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37374 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37375 be output in BSMTP format. No SMTP responses are possible for this form of
37376 delivery. All it is doing is using SMTP commands as a way of transmitting the
37377 envelope along with the message.
37378
37379 The message is written to the file or pipe preceded by the SMTP commands
37380 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37381 the message that start with a dot have an extra dot added. The SMTP command
37382 HELO is not normally used. If it is required, the &%message_prefix%& option
37383 can be used to specify it.
37384
37385 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37386 one recipient address at a time by default. However, you can arrange for them
37387 to handle several addresses at once by setting the &%batch_max%& option. When
37388 this is done for BSMTP, messages may contain multiple RCPT commands. See
37389 chapter &<<CHAPbatching>>& for more details.
37390
37391 .vindex "&$host$&"
37392 When one or more addresses are routed to a BSMTP transport by a router that
37393 sets up a host list, the name of the first host on the list is available to the
37394 transport in the variable &$host$&. Here is an example of such a transport and
37395 router:
37396 .code
37397 begin routers
37398 route_append:
37399   driver = manualroute
37400   transport = smtp_appendfile
37401   route_list = domain.example  batch.host.example
37402
37403 begin transports
37404 smtp_appendfile:
37405   driver = appendfile
37406   directory = /var/bsmtp/$host
37407   batch_max = 1000
37408   use_bsmtp
37409   user = exim
37410 .endd
37411 This causes messages addressed to &'domain.example'& to be written in BSMTP
37412 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37413 message (unless there are more than 1000 recipients).
37414
37415
37416
37417 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37418 .cindex "SMTP" "batched incoming"
37419 .cindex "batched SMTP input"
37420 The &%-bS%& command line option causes Exim to accept one or more messages by
37421 reading SMTP on the standard input, but to generate no responses. If the caller
37422 is trusted, the senders in the MAIL commands are believed; otherwise the
37423 sender is always the caller of Exim. Unqualified senders and receivers are not
37424 rejected (there seems little point) but instead just get qualified. HELO
37425 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37426 as NOOP; QUIT quits.
37427
37428 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37429 ACL is run in the same way as for non-SMTP local input.
37430
37431 If an error is detected while reading a message, including a missing &"."& at
37432 the end, Exim gives up immediately. It writes details of the error to the
37433 standard output in a stylized way that the calling program should be able to
37434 make some use of automatically, for example:
37435 .code
37436 554 Unexpected end of file
37437 Transaction started in line 10
37438 Error detected in line 14
37439 .endd
37440 It writes a more verbose version, for human consumption, to the standard error
37441 file, for example:
37442 .code
37443 An error was detected while processing a file of BSMTP input.
37444 The error message was:
37445
37446 501 '>' missing at end of address
37447
37448 The SMTP transaction started in line 10.
37449 The error was detected in line 12.
37450 The SMTP command at fault was:
37451
37452 rcpt to:<malformed@in.com.plete
37453
37454 1 previous message was successfully processed.
37455 The rest of the batch was abandoned.
37456 .endd
37457 The return code from Exim is zero only if there were no errors. It is 1 if some
37458 messages were accepted before an error was detected, and 2 if no messages were
37459 accepted.
37460 .ecindex IIDsmtpproc1
37461 .ecindex IIDsmtpproc2
37462
37463
37464
37465 . ////////////////////////////////////////////////////////////////////////////
37466 . ////////////////////////////////////////////////////////////////////////////
37467
37468 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37469          "Customizing messages"
37470 When a message fails to be delivered, or remains in the queue for more than a
37471 configured amount of time, Exim sends a message to the original sender, or
37472 to an alternative configured address. The text of these messages is built into
37473 the code of Exim, but it is possible to change it, either by adding a single
37474 string, or by replacing each of the paragraphs by text supplied in a file.
37475
37476 The &'From:'& and &'To:'& header lines are automatically generated; you can
37477 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37478 option. Exim also adds the line
37479 .code
37480 Auto-Submitted: auto-generated
37481 .endd
37482 to all warning and bounce messages,
37483
37484
37485 .section "Customizing bounce messages" "SECID239"
37486 .cindex "customizing" "bounce message"
37487 .cindex "bounce message" "customizing"
37488 If &%bounce_message_text%& is set, its contents are included in the default
37489 message immediately after &"This message was created automatically by mail
37490 delivery software."& The string is not expanded. It is not used if
37491 &%bounce_message_file%& is set.
37492
37493 When &%bounce_message_file%& is set, it must point to a template file for
37494 constructing error messages. The file consists of a series of text items,
37495 separated by lines consisting of exactly four asterisks. If the file cannot be
37496 opened, default text is used and a message is written to the main and panic
37497 logs. If any text item in the file is empty, default text is used for that
37498 item.
37499
37500 .vindex "&$bounce_recipient$&"
37501 .vindex "&$bounce_return_size_limit$&"
37502 Each item of text that is read from the file is expanded, and there are two
37503 expansion variables which can be of use here: &$bounce_recipient$& is set to
37504 the recipient of an error message while it is being created, and
37505 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37506 option, rounded to a whole number.
37507
37508 The items must appear in the file in the following order:
37509
37510 .ilist
37511 The first item is included in the headers, and should include at least a
37512 &'Subject:'& header. Exim does not check the syntax of these headers.
37513 .next
37514 The second item forms the start of the error message. After it, Exim lists the
37515 failing addresses with their error messages.
37516 .next
37517 The third item is used to introduce any text from pipe transports that is to be
37518 returned to the sender. It is omitted if there is no such text.
37519 .next
37520 The fourth, fifth and sixth items will be ignored and may be empty.
37521 The fields exist for back-compatibility
37522 .endlist
37523
37524 The default state (&%bounce_message_file%& unset) is equivalent to the
37525 following file, in which the sixth item is empty. The &'Subject:'& and some
37526 other lines have been split in order to fit them on the page:
37527 .code
37528 Subject: Mail delivery failed
37529   ${if eq{$sender_address}{$bounce_recipient}
37530   {: returning message to sender}}
37531 ****
37532 This message was created automatically by mail delivery software.
37533
37534 A message ${if eq{$sender_address}{$bounce_recipient}
37535   {that you sent }{sent by
37536
37537 <$sender_address>
37538
37539 }}could not be delivered to all of its recipients.
37540 This is a permanent error. The following address(es) failed:
37541 ****
37542 The following text was generated during the delivery attempt(s):
37543 ****
37544 ------ This is a copy of the message, including all the headers.
37545   ------
37546 ****
37547 ------ The body of the message is $message_size characters long;
37548   only the first
37549 ------ $bounce_return_size_limit or so are included here.
37550 ****
37551 .endd
37552 .section "Customizing warning messages" "SECTcustwarn"
37553 .cindex "customizing" "warning message"
37554 .cindex "warning of delay" "customizing the message"
37555 The option &%warn_message_file%& can be pointed at a template file for use when
37556 warnings about message delays are created. In this case there are only three
37557 text sections:
37558
37559 .ilist
37560 The first item is included in the headers, and should include at least a
37561 &'Subject:'& header. Exim does not check the syntax of these headers.
37562 .next
37563 The second item forms the start of the warning message. After it, Exim lists
37564 the delayed addresses.
37565 .next
37566 The third item then ends the message.
37567 .endlist
37568
37569 The default state is equivalent to the following file, except that some lines
37570 have been split here, in order to fit them on the page:
37571 .code
37572 Subject: Warning: message $message_exim_id delayed
37573   $warn_message_delay
37574 ****
37575 This message was created automatically by mail delivery software.
37576
37577 A message ${if eq{$sender_address}{$warn_message_recipients}
37578 {that you sent }{sent by
37579
37580 <$sender_address>
37581
37582 }}has not been delivered to all of its recipients after
37583 more than $warn_message_delay in the queue on $primary_hostname.
37584
37585 The message identifier is:     $message_exim_id
37586 The subject of the message is: $h_subject
37587 The date of the message is:    $h_date
37588
37589 The following address(es) have not yet been delivered:
37590 ****
37591 No action is required on your part. Delivery attempts will
37592 continue for some time, and this warning may be repeated at
37593 intervals if the message remains undelivered. Eventually the
37594 mail delivery software will give up, and when that happens,
37595 the message will be returned to you.
37596 .endd
37597 .vindex "&$warn_message_delay$&"
37598 .vindex "&$warn_message_recipients$&"
37599 However, in the default state the subject and date lines are omitted if no
37600 appropriate headers exist. During the expansion of this file,
37601 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37602 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37603 of recipients for the warning message. There may be more than one if there are
37604 multiple addresses with different &%errors_to%& settings on the routers that
37605 handled them.
37606
37607
37608
37609
37610 . ////////////////////////////////////////////////////////////////////////////
37611 . ////////////////////////////////////////////////////////////////////////////
37612
37613 .chapter "Some common configuration settings" "CHAPcomconreq"
37614 This chapter discusses some configuration settings that seem to be fairly
37615 common. More examples and discussion can be found in the Exim book.
37616
37617
37618
37619 .section "Sending mail to a smart host" "SECID240"
37620 .cindex "smart host" "example router"
37621 If you want to send all mail for non-local domains to a &"smart host"&, you
37622 should replace the default &(dnslookup)& router with a router which does the
37623 routing explicitly:
37624 .code
37625 send_to_smart_host:
37626   driver = manualroute
37627   route_list = !+local_domains smart.host.name
37628   transport = remote_smtp
37629 .endd
37630 You can use the smart host's IP address instead of the name if you wish.
37631 If you are using Exim only to submit messages to a smart host, and not for
37632 receiving incoming messages, you can arrange for it to do the submission
37633 synchronously by setting the &%mua_wrapper%& option (see chapter
37634 &<<CHAPnonqueueing>>&).
37635
37636
37637
37638
37639 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37640 .cindex "mailing lists"
37641 Exim can be used to run simple mailing lists, but for large and/or complicated
37642 requirements, the use of additional specialized mailing list software such as
37643 Majordomo or Mailman is recommended.
37644
37645 The &(redirect)& router can be used to handle mailing lists where each list
37646 is maintained in a separate file, which can therefore be managed by an
37647 independent manager. The &%domains%& router option can be used to run these
37648 lists in a separate domain from normal mail. For example:
37649 .code
37650 lists:
37651   driver = redirect
37652   domains = lists.example
37653   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37654   forbid_pipe
37655   forbid_file
37656   errors_to = ${quote_local_part:$local_part-request}@lists.example
37657   no_more
37658 .endd
37659 This router is skipped for domains other than &'lists.example'&. For addresses
37660 in that domain, it looks for a file that matches the local part. If there is no
37661 such file, the router declines, but because &%no_more%& is set, no subsequent
37662 routers are tried, and so the whole delivery fails.
37663
37664 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37665 expanded into a filename or a pipe delivery, which is usually inappropriate in
37666 a mailing list.
37667
37668 .oindex "&%errors_to%&"
37669 The &%errors_to%& option specifies that any delivery errors caused by addresses
37670 taken from a mailing list are to be sent to the given address rather than the
37671 original sender of the message. However, before acting on this, Exim verifies
37672 the error address, and ignores it if verification fails.
37673
37674 For example, using the configuration above, mail sent to
37675 &'dicts@lists.example'& is passed on to those addresses contained in
37676 &_/usr/lists/dicts_&, with error reports directed to
37677 &'dicts-request@lists.example'&, provided that this address can be verified.
37678 There could be a file called &_/usr/lists/dicts-request_& containing
37679 the address(es) of this particular list's manager(s), but other approaches,
37680 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37681 or &%local_part_suffix%& options) to handle addresses of the form
37682 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37683
37684
37685
37686 .section "Syntax errors in mailing lists" "SECID241"
37687 .cindex "mailing lists" "syntax errors in"
37688 If an entry in redirection data contains a syntax error, Exim normally defers
37689 delivery of the original address. That means that a syntax error in a mailing
37690 list holds up all deliveries to the list. This may not be appropriate when a
37691 list is being maintained automatically from data supplied by users, and the
37692 addresses are not rigorously checked.
37693
37694 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37695 entries that fail to parse, noting the incident in the log. If in addition
37696 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37697 whenever a broken address is skipped. It is usually appropriate to set
37698 &%syntax_errors_to%& to the same address as &%errors_to%&.
37699
37700
37701
37702 .section "Re-expansion of mailing lists" "SECID242"
37703 .cindex "mailing lists" "re-expansion of"
37704 Exim remembers every individual address to which a message has been delivered,
37705 in order to avoid duplication, but it normally stores only the original
37706 recipient addresses with a message. If all the deliveries to a mailing list
37707 cannot be done at the first attempt, the mailing list is re-expanded when the
37708 delivery is next tried. This means that alterations to the list are taken into
37709 account at each delivery attempt, so addresses that have been added to
37710 the list since the message arrived will therefore receive a copy of the
37711 message, even though it pre-dates their subscription.
37712
37713 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37714 on the &(redirect)& router. If this is done, any addresses generated by the
37715 router that fail to deliver at the first attempt are added to the message as
37716 &"top level"& addresses, and the parent address that generated them is marked
37717 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37718 subsequent delivery attempts. The disadvantage of this is that if any of the
37719 failing addresses are incorrect, correcting them in the file has no effect on
37720 pre-existing messages.
37721
37722 The original top-level address is remembered with each of the generated
37723 addresses, and is output in any log messages. However, any intermediate parent
37724 addresses are not recorded. This makes a difference to the log only if the
37725 &%all_parents%& selector is set, but for mailing lists there is normally only
37726 one level of expansion anyway.
37727
37728
37729
37730 .section "Closed mailing lists" "SECID243"
37731 .cindex "mailing lists" "closed"
37732 The examples so far have assumed open mailing lists, to which anybody may
37733 send mail. It is also possible to set up closed lists, where mail is accepted
37734 from specified senders only. This is done by making use of the generic
37735 &%senders%& option to restrict the router that handles the list.
37736
37737 The following example uses the same file as a list of recipients and as a list
37738 of permitted senders. It requires three routers:
37739 .code
37740 lists_request:
37741   driver = redirect
37742   domains = lists.example
37743   local_part_suffix = -request
37744   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37745   file = /usr/lists/${local_part_data}-request
37746   no_more
37747
37748 lists_post:
37749   driver = redirect
37750   domains = lists.example
37751   local_parts = ${lookup {$local_part} dsearch,filter=file,ret=full {/usr/lists}}
37752   senders = ${if exists {$local_part_data} {lsearch;$local_part_data}{*}}
37753   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37754   forbid_pipe
37755   forbid_file
37756   errors_to = ${quote_local_part:$local_part-request}@lists.example
37757   no_more
37758
37759 lists_closed:
37760   driver = redirect
37761   domains = lists.example
37762   allow_fail
37763   data = :fail: $local_part@lists.example is a closed mailing list
37764 .endd
37765 All three routers have the same &%domains%& setting, so for any other domains,
37766 they are all skipped. The first router runs only if the local part ends in
37767 &%-request%&. It handles messages to the list manager(s) by means of an open
37768 mailing list.
37769
37770 The second router runs only if the &%senders%& precondition is satisfied. It
37771 checks for the existence of a list that corresponds to the local part, and then
37772 checks that the sender is on the list by means of a linear search. It is
37773 necessary to check for the existence of the file before trying to search it,
37774 because otherwise Exim thinks there is a configuration error. If the file does
37775 not exist, the expansion of &%senders%& is *, which matches all senders. This
37776 means that the router runs, but because there is no list, declines, and
37777 &%no_more%& ensures that no further routers are run. The address fails with an
37778 &"unrouteable address"& error.
37779
37780 The third router runs only if the second router is skipped, which happens when
37781 a mailing list exists, but the sender is not on it. This router forcibly fails
37782 the address, giving a suitable error message.
37783
37784
37785
37786
37787 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37788 .cindex "VERP"
37789 .cindex "Variable Envelope Return Paths"
37790 .cindex "envelope from"
37791 .cindex "envelope sender"
37792 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37793 are a way of helping mailing list administrators discover which subscription
37794 address is the cause of a particular delivery failure. The idea is to encode
37795 the original recipient address in the outgoing envelope sender address, so that
37796 if the message is forwarded by another host and then subsequently bounces, the
37797 original recipient can be extracted from the recipient address of the bounce.
37798
37799 .oindex &%errors_to%&
37800 .oindex &%return_path%&
37801 Envelope sender addresses can be modified by Exim using two different
37802 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37803 list examples), or the &%return_path%& option on a transport. The second of
37804 these is effective only if the message is successfully delivered to another
37805 host; it is not used for errors detected on the local host (see the description
37806 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37807 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37808 .code
37809 verp_smtp:
37810   driver = smtp
37811   max_rcpt = 1
37812   return_path = \
37813     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37814       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37815 .endd
37816 This has the effect of rewriting the return path (envelope sender) on outgoing
37817 SMTP messages, if the local part of the original return path ends in
37818 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37819 local part and domain of the recipient into the return path. Suppose, for
37820 example, that a message whose return path has been set to
37821 &'somelist-request@your.dom.example'& is sent to
37822 &'subscriber@other.dom.example'&. In the transport, the return path is
37823 rewritten as
37824 .code
37825 somelist-request+subscriber=other.dom.example@your.dom.example
37826 .endd
37827 .vindex "&$local_part$&"
37828 For this to work, you must tell Exim to send multiple copies of messages that
37829 have more than one recipient, so that each copy has just one recipient. This is
37830 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
37831 might be sent to several different recipients in the same domain, in which case
37832 &$local_part$& is not available in the transport, because it is not unique.
37833
37834 Unless your host is doing nothing but mailing list deliveries, you should
37835 probably use a separate transport for the VERP deliveries, so as not to use
37836 extra resources in making one-per-recipient copies for other deliveries. This
37837 can easily be done by expanding the &%transport%& option in the router:
37838 .code
37839 dnslookup:
37840   driver = dnslookup
37841   domains = ! +local_domains
37842   transport = \
37843     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37844       {verp_smtp}{remote_smtp}}
37845   no_more
37846 .endd
37847 If you want to change the return path using &%errors_to%& in a router instead
37848 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
37849 routers that handle mailing list addresses. This will ensure that all delivery
37850 errors, including those detected on the local host, are sent to the VERP
37851 address.
37852
37853 On a host that does no local deliveries and has no manual routing, only the
37854 &(dnslookup)& router needs to be changed. A special transport is not needed for
37855 SMTP deliveries. Every mailing list recipient has its own return path value,
37856 and so Exim must hand them to the transport one at a time. Here is an example
37857 of a &(dnslookup)& router that implements VERP:
37858 .code
37859 verp_dnslookup:
37860   driver = dnslookup
37861   domains = ! +local_domains
37862   transport = remote_smtp
37863   errors_to = \
37864     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
37865      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37866   no_more
37867 .endd
37868 Before you start sending out messages with VERPed return paths, you must also
37869 configure Exim to accept the bounce messages that come back to those paths.
37870 Typically this is done by setting a &%local_part_suffix%& option for a
37871 router, and using this to route the messages to wherever you want to handle
37872 them.
37873
37874 The overhead incurred in using VERP depends very much on the size of the
37875 message, the number of recipient addresses that resolve to the same remote
37876 host, and the speed of the connection over which the message is being sent. If
37877 a lot of addresses resolve to the same host and the connection is slow, sending
37878 a separate copy of the message for each address may take substantially longer
37879 than sending a single copy with many recipients (for which VERP cannot be
37880 used).
37881
37882
37883
37884
37885
37886
37887 .section "Virtual domains" "SECTvirtualdomains"
37888 .cindex "virtual domains"
37889 .cindex "domain" "virtual"
37890 The phrase &'virtual domain'& is unfortunately used with two rather different
37891 meanings:
37892
37893 .ilist
37894 A domain for which there are no real mailboxes; all valid local parts are
37895 aliases for other email addresses. Common examples are organizational
37896 top-level domains and &"vanity"& domains.
37897 .next
37898 One of a number of independent domains that are all handled by the same host,
37899 with mailboxes on that host, but where the mailbox owners do not necessarily
37900 have login accounts on that host.
37901 .endlist
37902
37903 The first usage is probably more common, and does seem more &"virtual"& than
37904 the second. This kind of domain can be handled in Exim with a straightforward
37905 aliasing router. One approach is to create a separate alias file for each
37906 virtual domain. Exim can test for the existence of the alias file to determine
37907 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
37908 to a router of this form:
37909 .code
37910 virtual:
37911   driver = redirect
37912   domains = dsearch;/etc/mail/virtual
37913   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
37914   no_more
37915 .endd
37916 The &%domains%& option specifies that the router is to be skipped, unless there
37917 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
37918 domain that is being processed.
37919 The &(dsearch)& lookup used results in an untainted version of &$domain$&
37920 being placed into the &$domain_data$& variable.
37921
37922 When the router runs, it looks up the local
37923 part in the file to find a new address (or list of addresses). The &%no_more%&
37924 setting ensures that if the lookup fails (leading to &%data%& being an empty
37925 string), Exim gives up on the address without trying any subsequent routers.
37926
37927 This one router can handle all the virtual domains because the alias filenames
37928 follow a fixed pattern. Permissions can be arranged so that appropriate people
37929 can edit the different alias files. A successful aliasing operation results in
37930 a new envelope recipient address, which is then routed from scratch.
37931
37932 The other kind of &"virtual"& domain can also be handled in a straightforward
37933 way. One approach is to create a file for each domain containing a list of
37934 valid local parts, and use it in a router like this:
37935 .code
37936 my_domains:
37937   driver = accept
37938   domains = dsearch;/etc/mail/domains
37939   local_parts = lsearch;/etc/mail/domains/$domain
37940   transport = my_mailboxes
37941 .endd
37942 The address is accepted if there is a file for the domain, and the local part
37943 can be found in the file. The &%domains%& option is used to check for the
37944 file's existence because &%domains%& is tested before the &%local_parts%&
37945 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
37946 because that option is tested after &%local_parts%&. The transport is as
37947 follows:
37948 .code
37949 my_mailboxes:
37950   driver = appendfile
37951   file = /var/mail/$domain_data/$local_part_data
37952   user = mail
37953 .endd
37954 This uses a directory of mailboxes for each domain. The &%user%& setting is
37955 required, to specify which uid is to be used for writing to the mailboxes.
37956
37957 The configuration shown here is just one example of how you might support this
37958 requirement. There are many other ways this kind of configuration can be set
37959 up, for example, by using a database instead of separate files to hold all the
37960 information about the domains.
37961
37962
37963
37964 .section "Multiple user mailboxes" "SECTmulbox"
37965 .cindex "multiple mailboxes"
37966 .cindex "mailbox" "multiple"
37967 .cindex "local part" "prefix"
37968 .cindex "local part" "suffix"
37969 Heavy email users often want to operate with multiple mailboxes, into which
37970 incoming mail is automatically sorted. A popular way of handling this is to
37971 allow users to use multiple sender addresses, so that replies can easily be
37972 identified. Users are permitted to add prefixes or suffixes to their local
37973 parts for this purpose. The wildcard facility of the generic router options
37974 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
37975 example, consider this router:
37976 .code
37977 userforward:
37978   driver = redirect
37979   check_local_user
37980   file = $home/.forward
37981   local_part_suffix = -*
37982   local_part_suffix_optional
37983   allow_filter
37984 .endd
37985 .vindex "&$local_part_suffix$&"
37986 It runs a user's &_.forward_& file for all local parts of the form
37987 &'username-*'&. Within the filter file the user can distinguish different
37988 cases by testing the variable &$local_part_suffix$&. For example:
37989 .code
37990 if $local_part_suffix contains -special then
37991 save /home/$local_part_data/Mail/special
37992 endif
37993 .endd
37994 If the filter file does not exist, or does not deal with such addresses, they
37995 fall through to subsequent routers, and, assuming no subsequent use of the
37996 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
37997 control over which suffixes are valid.
37998
37999 Alternatively, a suffix can be used to trigger the use of a different
38000 &_.forward_& file &-- which is the way a similar facility is implemented in
38001 another MTA:
38002 .code
38003 userforward:
38004   driver = redirect
38005   check_local_user
38006   local_part_suffix = -*
38007   local_part_suffix_optional
38008   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
38009   allow_filter
38010 .endd
38011 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
38012 example, &_.forward-special_& is used. Once again, if the appropriate file
38013 does not exist, or does not deal with the address, it is passed on to
38014 subsequent routers, which could, if required, look for an unqualified
38015 &_.forward_& file to use as a default.
38016
38017
38018
38019 .section "Simplified vacation processing" "SECID244"
38020 .cindex "vacation processing"
38021 The traditional way of running the &'vacation'& program is for a user to set up
38022 a pipe command in a &_.forward_& file
38023 (see section &<<SECTspecitredli>>& for syntax details).
38024 This is prone to error by inexperienced users. There are two features of Exim
38025 that can be used to make this process simpler for users:
38026
38027 .ilist
38028 A local part prefix such as &"vacation-"& can be specified on a router which
38029 can cause the message to be delivered directly to the &'vacation'& program, or
38030 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
38031 &_.forward_& file are then much simpler. For example:
38032 .code
38033 spqr, vacation-spqr
38034 .endd
38035 .next
38036 The &%require_files%& generic router option can be used to trigger a
38037 vacation delivery by checking for the existence of a certain file in the
38038 user's home directory. The &%unseen%& generic option should also be used, to
38039 ensure that the original delivery also proceeds. In this case, all the user has
38040 to do is to create a file called, say, &_.vacation_&, containing a vacation
38041 message.
38042 .endlist
38043
38044 Another advantage of both these methods is that they both work even when the
38045 use of arbitrary pipes by users is locked out.
38046
38047
38048
38049 .section "Taking copies of mail" "SECID245"
38050 .cindex "message" "copying every"
38051 Some installations have policies that require archive copies of all messages to
38052 be made. A single copy of each message can easily be taken by an appropriate
38053 command in a system filter, which could, for example, use a different file for
38054 each day's messages.
38055
38056 There is also a shadow transport mechanism that can be used to take copies of
38057 messages that are successfully delivered by local transports, one copy per
38058 delivery. This could be used, &'inter alia'&, to implement automatic
38059 notification of delivery by sites that insist on doing such things.
38060
38061
38062
38063 .section "Intermittently connected hosts" "SECID246"
38064 .cindex "intermittently connected hosts"
38065 It has become quite common (because it is cheaper) for hosts to connect to the
38066 Internet periodically rather than remain connected all the time. The normal
38067 arrangement is that mail for such hosts accumulates on a system that is
38068 permanently connected.
38069
38070 Exim was designed for use on permanently connected hosts, and so it is not
38071 particularly well-suited to use in an intermittently connected environment.
38072 Nevertheless there are some features that can be used.
38073
38074
38075 .section "Exim on the upstream server host" "SECID247"
38076 It is tempting to arrange for incoming mail for the intermittently connected
38077 host to remain in Exim's queue until the client connects. However, this
38078 approach does not scale very well. Two different kinds of waiting message are
38079 being mixed up in the same queue &-- those that cannot be delivered because of
38080 some temporary problem, and those that are waiting for their destination host
38081 to connect. This makes it hard to manage the queue, as well as wasting
38082 resources, because each queue runner scans the entire queue.
38083
38084 A better approach is to separate off those messages that are waiting for an
38085 intermittently connected host. This can be done by delivering these messages
38086 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
38087 format, from where they are transmitted by other software when their
38088 destination connects. This makes it easy to collect all the mail for one host
38089 in a single directory, and to apply local timeout rules on a per-message basis
38090 if required.
38091
38092 On a very small scale, leaving the mail on Exim's queue can be made to work. If
38093 you are doing this, you should configure Exim with a long retry period for the
38094 intermittent host. For example:
38095 .code
38096 cheshire.wonderland.fict.example    *   F,5d,24h
38097 .endd
38098 This stops a lot of failed delivery attempts from occurring, but Exim remembers
38099 which messages it has queued up for that host. Once the intermittent host comes
38100 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
38101 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
38102 causes all the queued up messages to be delivered, often down a single SMTP
38103 connection. While the host remains connected, any new messages get delivered
38104 immediately.
38105
38106 If the connecting hosts do not have fixed IP addresses, that is, if a host is
38107 issued with a different IP address each time it connects, Exim's retry
38108 mechanisms on the holding host get confused, because the IP address is normally
38109 used as part of the key string for holding retry information. This can be
38110 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
38111 Since this has disadvantages for permanently connected hosts, it is best to
38112 arrange a separate transport for the intermittently connected ones.
38113
38114
38115
38116 .section "Exim on the intermittently connected client host" "SECID248"
38117 The value of &%smtp_accept_queue_per_connection%& should probably be
38118 increased, or even set to zero (that is, disabled) on the intermittently
38119 connected host, so that all incoming messages down a single connection get
38120 delivered immediately.
38121
38122 .cindex "SMTP" "passed connection"
38123 .cindex "SMTP" "multiple deliveries"
38124 .cindex "multiple SMTP deliveries"
38125 .cindex "first pass routing"
38126 Mail waiting to be sent from an intermittently connected host will probably
38127 not have been routed, because without a connection DNS lookups are not
38128 possible. This means that if a normal queue run is done at connection time,
38129 each message is likely to be sent in a separate SMTP session. This can be
38130 avoided by starting the queue run with a command line option beginning with
38131 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
38132 first pass, routing is done but no deliveries take place. The second pass is a
38133 normal queue run; since all the messages have been previously routed, those
38134 destined for the same host are likely to get sent as multiple deliveries in a
38135 single SMTP connection.
38136
38137
38138
38139 . ////////////////////////////////////////////////////////////////////////////
38140 . ////////////////////////////////////////////////////////////////////////////
38141
38142 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
38143          "Exim as a non-queueing client"
38144 .cindex "client, non-queueing"
38145 .cindex "smart host" "suppressing queueing"
38146 On a personal computer, it is a common requirement for all
38147 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
38148 configured to operate that way, for all the popular operating systems.
38149 However, there are some MUAs for Unix-like systems that cannot be so
38150 configured: they submit messages using the command line interface of
38151 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
38152 messages this way.
38153
38154 If the personal computer runs continuously, there is no problem, because it can
38155 run a conventional MTA that handles delivery to the smart host, and deal with
38156 any delays via its queueing mechanism. However, if the computer does not run
38157 continuously or runs different operating systems at different times, queueing
38158 email is not desirable.
38159
38160 There is therefore a requirement for something that can provide the
38161 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
38162 any queueing or retrying facilities. Furthermore, the delivery to the smart
38163 host should be synchronous, so that if it fails, the sending MUA is immediately
38164 informed. In other words, we want something that extends an MUA that submits
38165 to a local MTA via the command line so that it behaves like one that submits
38166 to a remote smart host using TCP/SMTP.
38167
38168 There are a number of applications (for example, there is one called &'ssmtp'&)
38169 that do this job. However, people have found them to be lacking in various
38170 ways. For instance, you might want to allow aliasing and forwarding to be done
38171 before sending a message to the smart host.
38172
38173 Exim already had the necessary infrastructure for doing this job. Just a few
38174 tweaks were needed to make it behave as required, though it is somewhat of an
38175 overkill to use a fully-featured MTA for this purpose.
38176
38177 .oindex "&%mua_wrapper%&"
38178 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
38179 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
38180 assumes that it is being used to &"wrap"& a command-line MUA in the manner
38181 just described. As well as setting &%mua_wrapper%&, you also need to provide a
38182 compatible router and transport configuration. Typically there will be just one
38183 router and one transport, sending everything to a smart host.
38184
38185 When run in MUA wrapping mode, the behaviour of Exim changes in the
38186 following ways:
38187
38188 .ilist
38189 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
38190 In other words, the only way to submit messages is via the command line.
38191 .next
38192 Each message is synchronously delivered as soon as it is received (&%-odi%& is
38193 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
38194 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
38195 does not finish until the delivery attempt is complete. If the delivery is
38196 successful, a zero return code is given.
38197 .next
38198 Address redirection is permitted, but the final routing for all addresses must
38199 be to the same remote transport, and to the same list of hosts. Furthermore,
38200 the return address (envelope sender) must be the same for all recipients, as
38201 must any added or deleted header lines. In other words, it must be possible to
38202 deliver the message in a single SMTP transaction, however many recipients there
38203 are.
38204 .next
38205 If these conditions are not met, or if routing any address results in a
38206 failure or defer status, or if Exim is unable to deliver all the recipients
38207 successfully to one of the smart hosts, delivery of the entire message fails.
38208 .next
38209 Because no queueing is allowed, all failures are treated as permanent; there
38210 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
38211 smart host. Furthermore, because only a single yes/no response can be given to
38212 the caller, it is not possible to deliver to some recipients and not others. If
38213 there is an error (temporary or permanent) for any recipient, all are failed.
38214 .next
38215 If more than one smart host is listed, Exim will try another host after a
38216 connection failure or a timeout, in the normal way. However, if this kind of
38217 failure happens for all the hosts, the delivery fails.
38218 .next
38219 When delivery fails, an error message is written to the standard error stream
38220 (as well as to Exim's log), and Exim exits to the caller with a return code
38221 value 1. The message is expunged from Exim's spool files. No bounce messages
38222 are ever generated.
38223 .next
38224 No retry data is maintained, and any retry rules are ignored.
38225 .next
38226 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
38227 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
38228 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
38229 .endlist
38230
38231 The overall effect is that Exim makes a single synchronous attempt to deliver
38232 the message, failing if there is any kind of problem. Because no local
38233 deliveries are done and no daemon can be run, Exim does not need root
38234 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
38235 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
38236 the advantages and disadvantages of running without root privilege.
38237
38238
38239
38240
38241 . ////////////////////////////////////////////////////////////////////////////
38242 . ////////////////////////////////////////////////////////////////////////////
38243
38244 .chapter "Log files" "CHAPlog"
38245 .scindex IIDloggen "log" "general description"
38246 .cindex "log" "types of"
38247 Exim writes three different logs, referred to as the main log, the reject log,
38248 and the panic log:
38249
38250 .ilist
38251 .cindex "main log"
38252 The main log records the arrival of each message and each delivery in a single
38253 line in each case. The format is as compact as possible, in an attempt to keep
38254 down the size of log files. Two-character flag sequences make it easy to pick
38255 out these lines. A number of other events are recorded in the main log. Some of
38256 them are optional, in which case the &%log_selector%& option controls whether
38257 they are included or not. A Perl script called &'eximstats'&, which does simple
38258 analysis of main log files, is provided in the Exim distribution (see section
38259 &<<SECTmailstat>>&).
38260 .next
38261 .cindex "reject log"
38262 The reject log records information from messages that are rejected as a result
38263 of a configuration option (that is, for policy reasons).
38264 The first line of each rejection is a copy of the line that is also written to
38265 the main log. Then, if the message's header has been read at the time the log
38266 is written, its contents are written to this log. Only the original header
38267 lines are available; header lines added by ACLs are not logged. You can use the
38268 reject log to check that your policy controls are working correctly; on a busy
38269 host this may be easier than scanning the main log for rejection messages. You
38270 can suppress the writing of the reject log by setting &%write_rejectlog%&
38271 false.
38272 .next
38273 .cindex "panic log"
38274 .cindex "system log"
38275 When certain serious errors occur, Exim writes entries to its panic log. If the
38276 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
38277 are usually written to the main log as well, but can get lost amid the mass of
38278 other entries. The panic log should be empty under normal circumstances. It is
38279 therefore a good idea to check it (or to have a &'cron'& script check it)
38280 regularly, in order to become aware of any problems. When Exim cannot open its
38281 panic log, it tries as a last resort to write to the system log (syslog). This
38282 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
38283 message itself is written at priority LOG_CRIT.
38284 .endlist
38285
38286 Every log line starts with a timestamp, in the format shown in the following
38287 example. Note that many of the examples shown in this chapter are line-wrapped.
38288 In the log file, this would be all on one line:
38289 .code
38290 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
38291   by QUIT
38292 .endd
38293 By default, the timestamps are in the local timezone. There are two
38294 ways of changing this:
38295
38296 .ilist
38297 You can set the &%timezone%& option to a different time zone; in particular, if
38298 you set
38299 .code
38300 timezone = UTC
38301 .endd
38302 the timestamps will be in UTC (aka GMT).
38303 .next
38304 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
38305 example:
38306 .code
38307 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
38308 .endd
38309 .endlist
38310
38311 .cindex "log" "process ids in"
38312 .cindex "pid (process id)" "in log lines"
38313 Exim does not include its process id in log lines by default, but you can
38314 request that it does so by specifying the &`pid`& log selector (see section
38315 &<<SECTlogselector>>&). When this is set, the process id is output, in square
38316 brackets, immediately after the time and date.
38317
38318
38319
38320
38321 .section "Where the logs are written" "SECTwhelogwri"
38322 .cindex "log" "destination"
38323 .cindex "log" "to file"
38324 .cindex "log" "to syslog"
38325 .cindex "syslog"
38326 The logs may be written to local files, or to syslog, or both. However, it
38327 should be noted that many syslog implementations use UDP as a transport, and
38328 are therefore unreliable in the sense that messages are not guaranteed to
38329 arrive at the loghost, nor is the ordering of messages necessarily maintained.
38330 It has also been reported that on large log files (tens of megabytes) you may
38331 need to tweak syslog to prevent it syncing the file with each write &-- on
38332 Linux this has been seen to make syslog take 90% plus of CPU time.
38333
38334 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
38335 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
38336 configuration. This latter string is expanded, so it can contain, for example,
38337 references to the host name:
38338 .code
38339 log_file_path = /var/log/$primary_hostname/exim_%slog
38340 .endd
38341 It is generally advisable, however, to set the string in &_Local/Makefile_&
38342 rather than at runtime, because then the setting is available right from the
38343 start of Exim's execution. Otherwise, if there's something it wants to log
38344 before it has read the configuration file (for example, an error in the
38345 configuration file) it will not use the path you want, and may not be able to
38346 log at all.
38347
38348 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
38349 list, currently limited to at most two items. This is one option where the
38350 facility for changing a list separator may not be used. The list must always be
38351 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38352 otherwise the item must either be an absolute path, containing &`%s`& at the
38353 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38354 implying the use of a default path.
38355
38356 When Exim encounters an empty item in the list, it searches the list defined by
38357 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38358 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38359 mean &"use the path specified at build time"&. If no such item exists, log
38360 files are written in the &_log_& subdirectory of the spool directory. This is
38361 equivalent to the configuration file setting:
38362 .code
38363 log_file_path = $spool_directory/log/%slog
38364 .endd
38365 If you do not specify anything at build time or runtime,
38366 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38367 that is where the logs are written.
38368
38369 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38370 are in use &-- see section &<<SECTdatlogfil>>& below.
38371
38372 Here are some examples of possible Makefile settings:
38373 .display
38374 &`LOG_FILE_PATH=syslog                    `& syslog only
38375 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38376 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38377 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38378 .endd
38379 If there are more than two paths in the list, the first is used and a panic
38380 error is logged.
38381
38382
38383
38384 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38385 .cindex "log" "cycling local files"
38386 .cindex "cycling logs"
38387 .cindex "&'exicyclog'&"
38388 .cindex "log" "local files; writing to"
38389 Some operating systems provide centralized and standardized methods for cycling
38390 log files. For those that do not, a utility script called &'exicyclog'& is
38391 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38392 main and reject logs each time it is called. The maximum number of old logs to
38393 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38394
38395 An Exim delivery process opens the main log when it first needs to write to it,
38396 and it keeps the file open in case subsequent entries are required &-- for
38397 example, if a number of different deliveries are being done for the same
38398 message. However, remote SMTP deliveries can take a long time, and this means
38399 that the file may be kept open long after it is renamed if &'exicyclog'& or
38400 something similar is being used to rename log files on a regular basis. To
38401 ensure that a switch of log files is noticed as soon as possible, Exim calls
38402 &[stat()]& on the main log's name before reusing an open file, and if the file
38403 does not exist, or its inode has changed, the old file is closed and Exim
38404 tries to open the main log from scratch. Thus, an old log file may remain open
38405 for quite some time, but no Exim processes should write to it once it has been
38406 renamed.
38407
38408
38409
38410 .section "Datestamped log files" "SECTdatlogfil"
38411 .cindex "log" "datestamped files"
38412 Instead of cycling the main and reject log files by renaming them
38413 periodically, some sites like to use files whose names contain a datestamp,
38414 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38415 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38416 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38417 point where the datestamp is required. For example:
38418 .code
38419 log_file_path = /var/spool/exim/log/%slog-%D
38420 log_file_path = /var/log/exim-%s-%D.log
38421 log_file_path = /var/spool/exim/log/%D-%slog
38422 log_file_path = /var/log/exim/%s.%M
38423 .endd
38424 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38425 examples of names generated by the above examples:
38426 .code
38427 /var/spool/exim/log/mainlog-20021225
38428 /var/log/exim-reject-20021225.log
38429 /var/spool/exim/log/20021225-mainlog
38430 /var/log/exim/main.200212
38431 .endd
38432 When this form of log file is specified, Exim automatically switches to new
38433 files at midnight. It does not make any attempt to compress old logs; you
38434 will need to write your own script if you require this. You should not
38435 run &'exicyclog'& with this form of logging.
38436
38437 The location of the panic log is also determined by &%log_file_path%&, but it
38438 is not datestamped, because rotation of the panic log does not make sense.
38439 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38440 the string. In addition, if it immediately follows a slash, a following
38441 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38442 character is removed. Thus, the four examples above would give these panic
38443 log names:
38444 .code
38445 /var/spool/exim/log/paniclog
38446 /var/log/exim-panic.log
38447 /var/spool/exim/log/paniclog
38448 /var/log/exim/panic
38449 .endd
38450
38451
38452 .section "Logging to syslog" "SECID249"
38453 .cindex "log" "syslog; writing to"
38454 The use of syslog does not change what Exim logs or the format of its messages,
38455 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38456 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38457 that, the same strings are written to syslog as to log files. The syslog
38458 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38459 by default, but you can change these by setting the &%syslog_facility%& and
38460 &%syslog_processname%& options, respectively. If Exim was compiled with
38461 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38462 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38463 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38464 the time and host name to each line.
38465 The three log streams are mapped onto syslog priorities as follows:
38466
38467 .ilist
38468 &'mainlog'& is mapped to LOG_INFO
38469 .next
38470 &'rejectlog'& is mapped to LOG_NOTICE
38471 .next
38472 &'paniclog'& is mapped to LOG_ALERT
38473 .endlist
38474
38475 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38476 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38477 these are routed by syslog to the same place. You can suppress this duplication
38478 by setting &%syslog_duplication%& false.
38479
38480 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38481 entries contain multiple lines when headers are included. To cope with both
38482 these cases, entries written to syslog are split into separate &[syslog()]&
38483 calls at each internal newline, and also after a maximum of
38484 870 data characters. (This allows for a total syslog line length of 1024, when
38485 additions such as timestamps are added.) If you are running a syslog
38486 replacement that can handle lines longer than the 1024 characters allowed by
38487 RFC 3164, you should set
38488 .code
38489 SYSLOG_LONG_LINES=yes
38490 .endd
38491 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38492 lines, but it still splits at internal newlines in &'reject'& log entries.
38493
38494 To make it easy to re-assemble split lines later, each component of a split
38495 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38496 where <&'n'&> is the component number and <&'m'&> is the total number of
38497 components in the entry. The / delimiter is used when the line was split
38498 because it was too long; if it was split because of an internal newline, the \
38499 delimiter is used. For example, supposing the length limit to be 50 instead of
38500 870, the following would be the result of a typical rejection message to
38501 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38502 name, and pid as added by syslog:
38503 .code
38504 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38505 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38506 [3/5]  when scanning for sender: missing or malformed lo
38507 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38508 [5/5] mple>)
38509 .endd
38510 The same error might cause the following lines to be written to &"rejectlog"&
38511 (LOG_NOTICE):
38512 .code
38513 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38514 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38515 [3/18] er when scanning for sender: missing or malformed
38516 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38517 [5\18] .example>)
38518 [6\18] Recipients: ph10@some.domain.cam.example
38519 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38520 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38521 [9\18]        id 16RdAL-0006pc-00
38522 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38523 [11\18] 09:43 +0100
38524 [12\18] F From: <>
38525 [13\18]   Subject: this is a test header
38526 [18\18]   X-something: this is another header
38527 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38528 [16\18] le>
38529 [17\18] B Bcc:
38530 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38531 .endd
38532 Log lines that are neither too long nor contain newlines are written to syslog
38533 without modification.
38534
38535 If only syslog is being used, the Exim monitor is unable to provide a log tail
38536 display, unless syslog is routing &'mainlog'& to a file on the local host and
38537 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38538 where it is.
38539
38540
38541
38542 .section "Log line flags" "SECID250"
38543 One line is written to the main log for each message received, and for each
38544 successful, unsuccessful, and delayed delivery. These lines can readily be
38545 picked out by the distinctive two-character flags that immediately follow the
38546 timestamp. The flags are:
38547 .itable none 0 0 2 10* left 90* left
38548 .irow &%<=%&     "message arrival"
38549 .irow &%(=%&     "message fakereject"
38550 .irow &%=>%&     "normal message delivery"
38551 .irow &%->%&     "additional address in same delivery"
38552 .irow &%>>%&     "cutthrough message delivery"
38553 .irow &%*>%&     "delivery suppressed by &%-N%&"
38554 .irow &%**%&     "delivery failed; address bounced"
38555 .irow &%==%&     "delivery deferred; temporary problem"
38556 .endtable
38557
38558
38559 .section "Logging message reception" "SECID251"
38560 .cindex "log" "reception line"
38561 The format of the single-line entry in the main log that is written for every
38562 message received is shown in the basic example below, which is split over
38563 several lines in order to fit it on the page:
38564 .code
38565 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38566   H=mailer.fict.example [192.168.123.123] U=exim
38567   P=smtp S=5678 id=<incoming message id>
38568 .endd
38569 The address immediately following &"<="& is the envelope sender address. A
38570 bounce message is shown with the sender address &"<>"&, and if it is locally
38571 generated, this is followed by an item of the form
38572 .code
38573 R=<message id>
38574 .endd
38575 which is a reference to the message that caused the bounce to be sent.
38576
38577 .cindex "HELO"
38578 .cindex "EHLO"
38579 For messages from other hosts, the H and U fields identify the remote host and
38580 record the RFC 1413 identity of the user that sent the message, if one was
38581 received. The number given in square brackets is the IP address of the sending
38582 host. If there is a single, unparenthesized  host name in the H field, as
38583 above, it has been verified to correspond to the IP address (see the
38584 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
38585 by the remote host in the SMTP HELO or EHLO command, and has not been
38586 verified. If verification yields a different name to that given for HELO or
38587 EHLO, the verified name appears first, followed by the HELO or EHLO
38588 name in parentheses.
38589
38590 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
38591 without brackets, in the HELO or EHLO command, leading to entries in
38592 the log containing text like these examples:
38593 .code
38594 H=(10.21.32.43) [192.168.8.34]
38595 H=([10.21.32.43]) [192.168.8.34]
38596 .endd
38597 This can be confusing. Only the final address in square brackets can be relied
38598 on.
38599
38600 For locally generated messages (that is, messages not received over TCP/IP),
38601 the H field is omitted, and the U field contains the login name of the caller
38602 of Exim.
38603
38604 .cindex "authentication" "logging"
38605 .cindex "AUTH" "logging"
38606 For all messages, the P field specifies the protocol used to receive the
38607 message. This is the value that is stored in &$received_protocol$&. In the case
38608 of incoming SMTP messages, the value indicates whether or not any SMTP
38609 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38610 session was encrypted, there is an additional X field that records the cipher
38611 suite that was used.
38612
38613 .cindex log protocol
38614 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38615 hosts that have authenticated themselves using the SMTP AUTH command. The first
38616 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38617 there is an additional item A= followed by the name of the authenticator that
38618 was used. If an authenticated identification was set up by the authenticator's
38619 &%server_set_id%& option, this is logged too, separated by a colon from the
38620 authenticator name.
38621
38622 .cindex "size" "of message"
38623 The id field records the existing message id, if present. The size of the
38624 received message is given by the S field. When the message is delivered,
38625 headers may be removed or added, so that the size of delivered copies of the
38626 message may not correspond with this value (and indeed may be different to each
38627 other).
38628
38629 The &%log_selector%& option can be used to request the logging of additional
38630 data when a message is received. See section &<<SECTlogselector>>& below.
38631
38632
38633
38634 .section "Logging deliveries" "SECID252"
38635 .cindex "log" "delivery line"
38636 The format of the single-line entry in the main log that is written for every
38637 delivery is shown in one of the examples below, for local and remote
38638 deliveries, respectively. Each example has been split into multiple lines in order
38639 to fit it on the page:
38640 .code
38641 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38642   <marv@hitch.fict.example> R=localuser T=local_delivery
38643 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38644   monk@holistic.fict.example R=dnslookup T=remote_smtp
38645   H=holistic.fict.example [192.168.234.234]
38646 .endd
38647 For ordinary local deliveries, the original address is given in angle brackets
38648 after the final delivery address, which might be a pipe or a file. If
38649 intermediate address(es) exist between the original and the final address, the
38650 last of these is given in parentheses after the final address. The R and T
38651 fields record the router and transport that were used to process the address.
38652
38653 If SMTP AUTH was used for the delivery there is an additional item A=
38654 followed by the name of the authenticator that was used.
38655 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38656 option, this is logged too, as a second colon-separated list item.
38657 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
38658
38659 If a shadow transport was run after a successful local delivery, the log line
38660 for the successful delivery has an item added on the end, of the form
38661 .display
38662 &`ST=<`&&'shadow transport name'&&`>`&
38663 .endd
38664 If the shadow transport did not succeed, the error message is put in
38665 parentheses afterwards.
38666
38667 .cindex "asterisk" "after IP address"
38668 When more than one address is included in a single delivery (for example, two
38669 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38670 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38671 down a single SMTP connection, an asterisk follows the
38672 remote IP address (and port if enabled)
38673 in the log lines for the second and subsequent messages.
38674 When two or more messages are delivered down a single TLS connection, the
38675 DNS and some TLS-related information logged for the first message delivered
38676 will not be present in the log lines for the second and subsequent messages.
38677 TLS cipher information is still available.
38678
38679 .cindex "delivery" "cutthrough; logging"
38680 .cindex "cutthrough" "logging"
38681 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38682 line precedes the reception line, since cutthrough waits for a possible
38683 rejection from the destination in case it can reject the sourced item.
38684
38685 The generation of a reply message by a filter file gets logged as a
38686 &"delivery"& to the addressee, preceded by &">"&.
38687
38688 The &%log_selector%& option can be used to request the logging of additional
38689 data when a message is delivered. See section &<<SECTlogselector>>& below.
38690
38691
38692 .section "Discarded deliveries" "SECID253"
38693 .cindex "discarded messages"
38694 .cindex "message" "discarded"
38695 .cindex "delivery" "discarded; logging"
38696 When a message is discarded as a result of the command &"seen finish"& being
38697 obeyed in a filter file which generates no deliveries, a log entry of the form
38698 .code
38699 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38700   <low.club@bridge.example> R=userforward
38701 .endd
38702 is written, to record why no deliveries are logged. When a message is discarded
38703 because it is aliased to &":blackhole:"& the log line is like this:
38704 .code
38705 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38706   <hole@nowhere.example> R=blackhole_router
38707 .endd
38708
38709
38710 .section "Deferred deliveries" "SECID254"
38711 When a delivery is deferred, a line of the following form is logged:
38712 .code
38713 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38714   R=dnslookup T=smtp defer (146): Connection refused
38715 .endd
38716 In the case of remote deliveries, the error is the one that was given for the
38717 last IP address that was tried. Details of individual SMTP failures are also
38718 written to the log, so the above line would be preceded by something like
38719 .code
38720 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38721   mail1.endrest.example [192.168.239.239]: Connection refused
38722 .endd
38723 When a deferred address is skipped because its retry time has not been reached,
38724 a message is written to the log, but this can be suppressed by setting an
38725 appropriate value in &%log_selector%&.
38726
38727
38728
38729 .section "Delivery failures" "SECID255"
38730 .cindex "delivery" "failure; logging"
38731 If a delivery fails because an address cannot be routed, a line of the
38732 following form is logged:
38733 .code
38734 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38735   <jim@trek99.example>: unknown mail domain
38736 .endd
38737 If a delivery fails at transport time, the router and transport are shown, and
38738 the response from the remote host is included, as in this example:
38739 .code
38740 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38741   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38742   after pipelined RCPT TO:<ace400@pb.example>: host
38743   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38744   <ace400@pb.example>...Addressee unknown
38745 .endd
38746 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38747 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38748 disabling PIPELINING. The log lines for all forms of delivery failure are
38749 flagged with &`**`&.
38750
38751
38752
38753 .section "Fake deliveries" "SECID256"
38754 .cindex "delivery" "fake; logging"
38755 If a delivery does not actually take place because the &%-N%& option has been
38756 used to suppress it, a normal delivery line is written to the log, except that
38757 &"=>"& is replaced by &"*>"&.
38758
38759
38760
38761 .section "Completion" "SECID257"
38762 A line of the form
38763 .code
38764 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38765 .endd
38766 is written to the main log when a message is about to be removed from the spool
38767 at the end of its processing.
38768
38769
38770
38771
38772 .section "Summary of Fields in Log Lines" "SECID258"
38773 .cindex "log" "summary of fields"
38774 A summary of the field identifiers that are used in log lines is shown in
38775 the following table:
38776 .display
38777 &`A   `&        authenticator name (and optional id and sender)
38778 &`C   `&        SMTP confirmation on delivery
38779 &`    `&        command list for &"no mail in SMTP session"&
38780 &`CV  `&        certificate verification status
38781 &`D   `&        duration of &"no mail in SMTP session"&
38782 &`DKIM`&        domain verified in incoming message
38783 &`DN  `&        distinguished name from peer certificate
38784 &`DS  `&        DNSSEC secured lookups
38785 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38786 &`F   `&        sender address (on delivery lines)
38787 &`H   `&        host name and IP address
38788 &`I   `&        local interface used
38789 &`id  `&        message id (from header) for incoming message
38790 &`K   `&        CHUNKING extension used
38791 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38792 &`M8S `&        8BITMIME status for incoming message
38793 &`P   `&        on &`<=`& lines: protocol used
38794 &`    `&        on &`=>`& and &`**`& lines: return path
38795 &`PRDR`&        PRDR extension used
38796 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38797 &`Q   `&        alternate queue name
38798 &`QT  `&        on &`=>`& lines: time spent on queue so far
38799 &`    `&        on &"Completed"& lines: time spent on queue
38800 &`R   `&        on &`<=`& lines: reference for local bounce
38801 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38802 &`RT  `&        on &`<=`& lines: time taken for reception
38803 &`S   `&        size of message in bytes
38804 &`SNI `&        server name indication from TLS client hello
38805 &`ST  `&        shadow transport name
38806 &`T   `&        on &`<=`& lines: message subject (topic)
38807 &`TFO `&        connection took advantage of TCP Fast Open
38808 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38809 &`U   `&        local user or RFC 1413 identity
38810 &`X   `&        TLS cipher suite
38811 .endd
38812
38813
38814 .section "Other log entries" "SECID259"
38815 Various other types of log entry are written from time to time. Most should be
38816 self-explanatory. Among the more common are:
38817
38818 .ilist
38819 .cindex "retry" "time not reached"
38820 &'retry time not reached'&&~&~An address previously suffered a temporary error
38821 during routing or local delivery, and the time to retry has not yet arrived.
38822 This message is not written to an individual message log file unless it happens
38823 during the first delivery attempt.
38824 .next
38825 &'retry time not reached for any host'&&~&~An address previously suffered
38826 temporary errors during remote delivery, and the retry time has not yet arrived
38827 for any of the hosts to which it is routed.
38828 .next
38829 .cindex "spool directory" "file locked"
38830 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
38831 some other Exim process is already working on the message. This can be quite
38832 common if queue running processes are started at frequent intervals. The
38833 &'exiwhat'& utility script can be used to find out what Exim processes are
38834 doing.
38835 .next
38836 .cindex "error" "ignored"
38837 &'error ignored'&&~&~There are several circumstances that give rise to this
38838 message:
38839 .olist
38840 Exim failed to deliver a bounce message whose age was greater than
38841 &%ignore_bounce_errors_after%&. The bounce was discarded.
38842 .next
38843 A filter file set up a delivery using the &"noerror"& option, and the delivery
38844 failed. The delivery was discarded.
38845 .next
38846 A delivery set up by a router configured with
38847 . ==== As this is a nested list, any displays it contains must be indented
38848 . ==== as otherwise they are too far to the left.
38849 .code
38850     errors_to = <>
38851 .endd
38852 failed. The delivery was discarded.
38853 .endlist olist
38854 .next
38855 .cindex DKIM "log line"
38856 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
38857 logging and the message has a DKIM signature header.
38858 .endlist ilist
38859
38860
38861
38862
38863
38864 .section "Reducing or increasing what is logged" "SECTlogselector"
38865 .cindex "log" "selectors"
38866 By setting the &%log_selector%& global option, you can disable some of Exim's
38867 default logging, or you can request additional logging. The value of
38868 &%log_selector%& is made up of names preceded by plus or minus characters. For
38869 example:
38870 .code
38871 log_selector = +arguments -retry_defer
38872 .endd
38873 The list of optional log items is in the following table, with the default
38874 selection marked by asterisks:
38875 .itable none 0 0 3 2.8in left 10pt center 3in left
38876 .irow &`8bitmime`&                      &nbsp; "received 8BITMIME status"
38877 .irow &`acl_warn_skipped`&              *       "skipped &%warn%& statement in ACL"
38878 .irow &`address_rewrite`&               &nbsp; "address rewriting"
38879 .irow &`all_parents`&                   &nbsp; "all parents in => lines"
38880 .irow &`arguments`&                     &nbsp; "command line arguments"
38881 .irow &`connection_reject`&             *       "connection rejections"
38882 .irow &`delay_delivery`&                *       "immediate delivery delayed"
38883 .irow &`deliver_time`&                  &nbsp; "time taken to attempt delivery"
38884 .irow &`delivery_size`&                 &nbsp; "add &`S=`&&'nnn'& to => lines"
38885 .irow &`dkim`&                          *       "DKIM verified domain on <= lines"
38886 .irow &`dkim_verbose`&                  &nbsp; "separate full DKIM verification result line, per signature"
38887 .irow &`dnslist_defer`&                 *       "defers of DNS list (aka RBL) lookups"
38888 .irow &`dnssec`&                        &nbsp; "DNSSEC secured lookups"
38889 .irow &`etrn`&                          *       "ETRN commands"
38890 .irow &`host_lookup_failed`&            *       "as it says"
38891 .irow &`ident_timeout`&                 &nbsp; "timeout for ident connection"
38892 .irow &`incoming_interface`&            &nbsp; "local interface on <= and => lines"
38893 .irow &`incoming_port`&                 &nbsp; "remote port on <= lines"
38894 .irow &`lost_incoming_connection`&      *       "as it says (includes timeouts)"
38895 .irow &`millisec`&                      &nbsp; "millisecond timestamps and RT,QT,DT,D times"
38896 .irow &`msg_id`&                        *       "on <= lines, Message-ID: header value"
38897 .irow &`msg_id_created`&                &nbsp; "on <= lines, Message-ID: header value when one had to be added"
38898 .irow &`outgoing_interface`&            &nbsp; "local interface on => lines"
38899 .irow &`outgoing_port`&                 &nbsp; "add remote port to => lines"
38900 .irow &`queue_run`&                     *       "start and end queue runs"
38901 .irow &`queue_time`&                    &nbsp; "time on queue for one recipient"
38902 .irow &`queue_time_exclusive`&          &nbsp; "exclude recieve time from QT times"
38903 .irow &`queue_time_overall`&            &nbsp; "time on queue for whole message"
38904 .irow &`pid`&                           &nbsp; "Exim process id"
38905 .irow &`pipelining`&                    &nbsp; "PIPELINING use, on <= and => lines"
38906 .irow &`proxy`&                         &nbsp; "proxy address on <= and => lines"
38907 .irow &`receive_time`&                  &nbsp; "time taken to receive message"
38908 .irow &`received_recipients`&           &nbsp; "recipients on <= lines"
38909 .irow &`received_sender`&               &nbsp; "sender on <= lines"
38910 .irow &`rejected_header`&               *       "header contents on reject log"
38911 .irow &`retry_defer`&                   *       "&<quote>&retry time not reached&</quote>&"
38912 .irow &`return_path_on_delivery`&       &nbsp; "put return path on => and ** lines"
38913 .irow &`sender_on_delivery`&            &nbsp; "add sender to => lines"
38914 .irow &`sender_verify_fail`&            *       "sender verification failures"
38915 .irow &`size_reject`&                   *       "rejection because too big"
38916 .irow &`skip_delivery`&                 *       "delivery skipped in a queue run"
38917 .irow &`smtp_confirmation`&             *       "SMTP confirmation on => lines"
38918 .irow &`smtp_connection`&               &nbsp; "incoming SMTP connections"
38919 .irow &`smtp_incomplete_transaction`&   &nbsp; "incomplete SMTP transactions"
38920 .irow &`smtp_mailauth`&                 &nbsp; "AUTH argument to MAIL commands"
38921 .irow &`smtp_no_mail`&                  &nbsp; "session with no MAIL commands"
38922 .irow &`smtp_protocol_error`&           &nbsp; "SMTP protocol errors"
38923 .irow &`smtp_syntax_error`&             &nbsp; "SMTP syntax errors"
38924 .irow &`subject`&                       &nbsp; "contents of &'Subject:'& on <= lines"
38925 .irow &`tls_certificate_verified`&      *       "certificate verification status"
38926 .irow &`tls_cipher`&                    *       "TLS cipher suite on <= and => lines"
38927 .irow &`tls_peerdn`&                    &nbsp; "TLS peer DN on <= and => lines"
38928 .irow &`tls_resumption`&                &nbsp; "append * to cipher field"
38929 .irow &`tls_sni`&                       &nbsp; "TLS SNI on <= lines"
38930 .irow &`unknown_in_list`&               &nbsp; "DNS lookup failed in list match"
38931 .irow &`all`&                           &nbsp; "&*all of the above*&"
38932 .endtable
38933 See also the &%slow_lookup_log%& main configuration option,
38934 section &<<SECID99>>&
38935
38936 More details on each of these items follows:
38937
38938 .ilist
38939 .cindex "8BITMIME"
38940 .cindex "log" "8BITMIME"
38941 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
38942 which may help in tracking down interoperability issues with ancient MTAs
38943 that are not 8bit clean.  This is added to the &"<="& line, tagged with
38944 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
38945 &`7BIT`& and &`8BITMIME`& respectively.
38946 .next
38947 .cindex "&%warn%& ACL verb" "log when skipping"
38948 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
38949 its conditions cannot be evaluated, a log line to this effect is written if
38950 this log selector is set.
38951 .next
38952 .cindex "log" "rewriting"
38953 .cindex "rewriting" "logging"
38954 &%address_rewrite%&: This applies both to global rewrites and per-transport
38955 rewrites, but not to rewrites in filters run as an unprivileged user (because
38956 such users cannot access the log).
38957 .next
38958 .cindex "log" "full parentage"
38959 &%all_parents%&: Normally only the original and final addresses are logged on
38960 delivery lines; with this selector, intermediate parents are given in
38961 parentheses between them.
38962 .next
38963 .cindex "log" "Exim arguments"
38964 .cindex "Exim arguments, logging"
38965 &%arguments%&: This causes Exim to write the arguments with which it was called
38966 to the main log, preceded by the current working directory. This is a debugging
38967 feature, added to make it easier to find out how certain MUAs call
38968 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
38969 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
38970 that are empty or that contain white space are quoted. Non-printing characters
38971 are shown as escape sequences. This facility cannot log unrecognized arguments,
38972 because the arguments are checked before the configuration file is read. The
38973 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
38974 between the caller and Exim.
38975 .next
38976 .cindex "log" "connection rejections"
38977 &%connection_reject%&: A log entry is written whenever an incoming SMTP
38978 connection is rejected, for whatever reason.
38979 .next
38980 .cindex "log" "delayed delivery"
38981 .cindex "delayed delivery, logging"
38982 &%delay_delivery%&: A log entry is written whenever a delivery process is not
38983 started for an incoming message because the load is too high or too many
38984 messages were received on one connection. Logging does not occur if no delivery
38985 process is started because &%queue_only%& is set or &%-odq%& was used.
38986 .next
38987 .cindex "log" "delivery duration"
38988 &%deliver_time%&: For each delivery, the amount of real time it has taken to
38989 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
38990 If millisecond logging is enabled, short times will be shown with greater
38991 precision, eg. &`DT=0.304s`&.
38992 .next
38993 .cindex "log" "message size on delivery"
38994 .cindex "size" "of message"
38995 &%delivery_size%&: For each delivery, the size of message delivered is added to
38996 the &"=>"& line, tagged with S=.
38997 .next
38998 .cindex log "DKIM verification"
38999 .cindex DKIM "verification logging"
39000 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
39001 verifies successfully a tag of DKIM is added, with one of the verified domains.
39002 .next
39003 .cindex log "DKIM verification"
39004 .cindex DKIM "verification logging"
39005 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
39006 .next
39007 .cindex "log" "dnslist defer"
39008 .cindex "DNS list" "logging defer"
39009 .cindex "black list (DNS)"
39010 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
39011 DNS black list suffers a temporary error.
39012 .next
39013 .cindex log dnssec
39014 .cindex dnssec logging
39015 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
39016 dns lookups gave secure results a tag of DS is added.
39017 For acceptance this covers the reverse and forward lookups for host name verification.
39018 It does not cover helo-name verification.
39019 For delivery this covers the SRV, MX, A and/or AAAA lookups.
39020 .next
39021 .cindex "log" "ETRN commands"
39022 .cindex "ETRN" "logging"
39023 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
39024 is run to determine whether or not it is actually accepted. An invalid ETRN
39025 command, or one received within a message transaction is not logged by this
39026 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
39027 .next
39028 .cindex "log" "host lookup failure"
39029 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
39030 any addresses, or when a lookup of an IP address fails to find a host name, a
39031 log line is written. This logging does not apply to direct DNS lookups when
39032 routing email addresses, but it does apply to &"byname"& lookups.
39033 .next
39034 .cindex "log" "ident timeout"
39035 .cindex "RFC 1413" "logging timeout"
39036 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
39037 client's ident port times out.
39038 .next
39039 .cindex "log" "incoming interface"
39040 .cindex "log" "outgoing interface"
39041 .cindex "log" "local interface"
39042 .cindex "log" "local address and port"
39043 .cindex "TCP/IP" "logging local address and port"
39044 .cindex "interface" "logging"
39045 &%incoming_interface%&: The interface on which a message was received is added
39046 to the &"<="& line as an IP address in square brackets, tagged by I= and
39047 followed by a colon and the port number. The local interface and port are also
39048 added to other SMTP log lines, for example, &"SMTP connection from"&, to
39049 rejection lines, and (despite the name) to outgoing
39050 &"=>"&, &"->"&, &"=="& and &"**"& lines.
39051 The latter can be disabled by turning off the &%outgoing_interface%& option.
39052 .next
39053 .cindex log "incoming proxy address"
39054 .cindex proxy "logging proxy address"
39055 .cindex "TCP/IP" "logging proxy address"
39056 &%proxy%&: The internal (closest to the system running Exim) IP address
39057 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
39058 on a proxied connection
39059 or the &"=>"& line for a message delivered on a proxied connection.
39060 See &<<SECTproxyInbound>>& for more information.
39061 .next
39062 .cindex "log" "incoming remote port"
39063 .cindex "port" "logging remote"
39064 .cindex "TCP/IP" "logging incoming remote port"
39065 .vindex "&$sender_fullhost$&"
39066 .vindex "&$sender_rcvhost$&"
39067 &%incoming_port%&: The remote port number from which a message was received is
39068 added to log entries and &'Received:'& header lines, following the IP address
39069 in square brackets, and separated from it by a colon. This is implemented by
39070 changing the value that is put in the &$sender_fullhost$& and
39071 &$sender_rcvhost$& variables. Recording the remote port number has become more
39072 important with the widening use of NAT (see RFC 2505).
39073 .next
39074 .cindex "log" "dropped connection"
39075 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
39076 connection is unexpectedly dropped.
39077 .next
39078 .cindex "log" "millisecond timestamps"
39079 .cindex millisecond logging
39080 .cindex timestamps "millisecond, in logs"
39081 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
39082 appended to the seconds value.
39083 .next
39084 .cindex "log" "message id"
39085 &%msg_id%&: The value of the Message-ID: header.
39086 .next
39087 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
39088 This will be either because the message is a bounce, or was submitted locally
39089 (submission mode) without one.
39090 The field identifier will have an asterix appended: &"id*="&.
39091 .next
39092 .cindex "log" "outgoing interface"
39093 .cindex "log" "local interface"
39094 .cindex "log" "local address and port"
39095 .cindex "TCP/IP" "logging local address and port"
39096 .cindex "interface" "logging"
39097 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
39098 interface on which a message was sent is added to delivery lines as an I= tag
39099 followed by IP address in square brackets. You can disable this by turning
39100 off the &%outgoing_interface%& option.
39101 .next
39102 .cindex "log" "outgoing remote port"
39103 .cindex "port" "logging outgoing remote"
39104 .cindex "TCP/IP" "logging outgoing remote port"
39105 &%outgoing_port%&: The remote port number is added to delivery log lines (those
39106 containing => tags) following the IP address.
39107 The local port is also added if &%incoming_interface%& and
39108 &%outgoing_interface%& are both enabled.
39109 This option is not included in the default setting, because for most ordinary
39110 configurations, the remote port number is always 25 (the SMTP port), and the
39111 local port is a random ephemeral port.
39112 .next
39113 .cindex "log" "process ids in"
39114 .cindex "pid (process id)" "in log lines"
39115 &%pid%&: The current process id is added to every log line, in square brackets,
39116 immediately after the time and date.
39117 .next
39118 .cindex log pipelining
39119 .cindex pipelining "logging outgoing"
39120 &%pipelining%&: A field is added to delivery and accept
39121 log lines when the ESMTP PIPELINING extension was used.
39122 The field is a single "L".
39123
39124 On accept lines, where PIPELINING was offered but not used by the client,
39125 the field has a minus appended.
39126
39127 .cindex "pipelining" "early connection"
39128 If Exim is built without the DISABLE_PIPE_CONNECT build option
39129 accept "L" fields have a period appended if the feature was
39130 offered but not used, or an asterisk appended if used.
39131 Delivery "L" fields have an asterisk appended if used.
39132
39133 .next
39134 .cindex "log" "queue run"
39135 .cindex "queue runner" "logging"
39136 &%queue_run%&: The start and end of every queue run are logged.
39137 .next
39138 .cindex "log" "queue time"
39139 &%queue_time%&: The amount of time the message has been in the queue on the
39140 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
39141 &`QT=3m45s`&.
39142 If millisecond logging is enabled, short times will be shown with greater
39143 precision, eg. &`QT=1.578s`&.
39144 .next
39145 &%queue_time_overall%&: The amount of time the message has been in the queue on
39146 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
39147 example, &`QT=3m45s`&.
39148 .next
39149 .cindex "log" "receive duration"
39150 &%receive_time%&: For each message, the amount of real time it has taken to
39151 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
39152 If millisecond logging is enabled, short times will be shown with greater
39153 precision, eg. &`RT=0.204s`&.
39154 .next
39155 .cindex "log" "recipients"
39156 &%received_recipients%&: The recipients of a message are listed in the main log
39157 as soon as the message is received. The list appears at the end of the log line
39158 that is written when a message is received, preceded by the word &"for"&. The
39159 addresses are listed after they have been qualified, but before any rewriting
39160 has taken place.
39161 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
39162 in the list.
39163 .next
39164 .cindex "log" "sender reception"
39165 &%received_sender%&: The unrewritten original sender of a message is added to
39166 the end of the log line that records the message's arrival, after the word
39167 &"from"& (before the recipients if &%received_recipients%& is also set).
39168 .next
39169 .cindex "log" "header lines for rejection"
39170 &%rejected_header%&: If a message's header has been received at the time a
39171 rejection is written to the reject log, the complete header is added to the
39172 log. Header logging can be turned off individually for messages that are
39173 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
39174 .next
39175 .cindex "log" "retry defer"
39176 &%retry_defer%&: A log line is written if a delivery is deferred because a
39177 retry time has not yet been reached. However, this &"retry time not reached"&
39178 message is always omitted from individual message logs after the first delivery
39179 attempt.
39180 .next
39181 .cindex "log" "return path"
39182 &%return_path_on_delivery%&: The return path that is being transmitted with
39183 the message is included in delivery and bounce lines, using the tag P=.
39184 This is omitted if no delivery actually happens, for example, if routing fails,
39185 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
39186 .next
39187 .cindex "log" "sender on delivery"
39188 &%sender_on_delivery%&: The message's sender address is added to every delivery
39189 and bounce line, tagged by F= (for &"from"&).
39190 This is the original sender that was received with the message; it is not
39191 necessarily the same as the outgoing return path.
39192 .next
39193 .cindex "log" "sender verify failure"
39194 &%sender_verify_fail%&: If this selector is unset, the separate log line that
39195 gives details of a sender verification failure is not written. Log lines for
39196 the rejection of SMTP commands contain just &"sender verify failed"&, so some
39197 detail is lost.
39198 .next
39199 .cindex "log" "size rejection"
39200 &%size_reject%&: A log line is written whenever a message is rejected because
39201 it is too big.
39202 .next
39203 .cindex "log" "frozen messages; skipped"
39204 .cindex "frozen messages" "logging skipping"
39205 &%skip_delivery%&: A log line is written whenever a message is skipped during a
39206 queue run because it another process is already delivering it or because
39207 it is frozen.
39208 .cindex "&""spool file is locked""&"
39209 .cindex "&""message is frozen""&"
39210 The message that is written is either &"spool file is locked"& or
39211 &"message is frozen"&.
39212 .next
39213 .cindex "log" "smtp confirmation"
39214 .cindex "SMTP" "logging confirmation"
39215 .cindex "LMTP" "logging confirmation"
39216 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
39217 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
39218 A number of MTAs (including Exim) return an identifying string in this
39219 response.
39220 .next
39221 .cindex "log" "SMTP connections"
39222 .cindex "SMTP" "logging connections"
39223 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
39224 established or closed, unless the connection is from a host that matches
39225 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
39226 only when the closure is unexpected.) This applies to connections from local
39227 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
39228 dropped in the middle of a message, a log line is always written, whether or
39229 not this selector is set, but otherwise nothing is written at the start and end
39230 of connections unless this selector is enabled.
39231
39232 For TCP/IP connections to an Exim daemon, the current number of connections is
39233 included in the log message for each new connection, but note that the count is
39234 reset if the daemon is restarted.
39235 Also, because connections are closed (and the closure is logged) in
39236 subprocesses, the count may not include connections that have been closed but
39237 whose termination the daemon has not yet noticed. Thus, while it is possible to
39238 match up the opening and closing of connections in the log, the value of the
39239 logged counts may not be entirely accurate.
39240 .next
39241 .cindex "log" "SMTP transaction; incomplete"
39242 .cindex "SMTP" "logging incomplete transactions"
39243 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
39244 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
39245 and the message sender plus any accepted recipients are included in the log
39246 line. This can provide evidence of dictionary attacks.
39247 .next
39248 .cindex "log" "non-MAIL SMTP sessions"
39249 .cindex "MAIL" "logging session without"
39250 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
39251 connection terminates without having issued a MAIL command. This includes both
39252 the case when the connection is dropped, and the case when QUIT is used. It
39253 does not include cases where the connection is rejected right at the start (by
39254 an ACL, or because there are too many connections, or whatever). These cases
39255 already have their own log lines.
39256
39257 The log line that is written contains the identity of the client in the usual
39258 way, followed by D= and a time, which records the duration of the connection.
39259 If the connection was authenticated, this fact is logged exactly as it is for
39260 an incoming message, with an A= item. If the connection was encrypted, CV=,
39261 DN=, and X= items may appear as they do for an incoming message, controlled by
39262 the same logging options.
39263
39264 Finally, if any SMTP commands were issued during the connection, a C= item
39265 is added to the line, listing the commands that were used. For example,
39266 .code
39267 C=EHLO,QUIT
39268 .endd
39269 shows that the client issued QUIT straight after EHLO. If there were fewer
39270 than 20 commands, they are all listed. If there were more than 20 commands,
39271 the last 20 are listed, preceded by &"..."&. However, with the default
39272 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
39273 have been aborted before 20 non-mail commands are processed.
39274 .next
39275 &%smtp_mailauth%&: A third subfield with the authenticated sender,
39276 colon-separated, is appended to the A= item for a message arrival or delivery
39277 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
39278 was accepted or used.
39279 .next
39280 .cindex "log" "SMTP protocol error"
39281 .cindex "SMTP" "logging protocol error"
39282 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
39283 encountered. Exim does not have perfect detection of all protocol errors
39284 because of transmission delays and the use of pipelining. If PIPELINING has
39285 been advertised to a client, an Exim server assumes that the client will use
39286 it, and therefore it does not count &"expected"& errors (for example, RCPT
39287 received after rejecting MAIL) as protocol errors.
39288 .next
39289 .cindex "SMTP" "logging syntax errors"
39290 .cindex "SMTP" "syntax errors; logging"
39291 .cindex "SMTP" "unknown command; logging"
39292 .cindex "log" "unknown SMTP command"
39293 .cindex "log" "SMTP syntax error"
39294 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
39295 encountered. An unrecognized command is treated as a syntax error. For an
39296 external connection, the host identity is given; for an internal connection
39297 using &%-bs%& the sender identification (normally the calling user) is given.
39298 .next
39299 .cindex "log" "subject"
39300 .cindex "subject, logging"
39301 &%subject%&: The subject of the message is added to the arrival log line,
39302 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
39303 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
39304 specifies whether characters with values greater than 127 should be logged
39305 unchanged, or whether they should be rendered as escape sequences.
39306 .next
39307 .cindex "log" "certificate verification"
39308 .cindex log DANE
39309 .cindex DANE logging
39310 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
39311 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
39312 verified
39313 using a CA trust anchor,
39314 &`CV=dane`& if using a DNS trust anchor,
39315 and &`CV=no`& if not.
39316 .next
39317 .cindex "log" "TLS cipher"
39318 .cindex "TLS" "logging cipher"
39319 &%tls_cipher%&: When a message is sent or received over an encrypted
39320 connection, the cipher suite used is added to the log line, preceded by X=.
39321 .next
39322 .cindex "log" "TLS peer DN"
39323 .cindex "TLS" "logging peer DN"
39324 &%tls_peerdn%&: When a message is sent or received over an encrypted
39325 connection, and a certificate is supplied by the remote host, the peer DN is
39326 added to the log line, preceded by DN=.
39327 .next
39328 .cindex "log" "TLS resumption"
39329 .cindex "TLS" "logging session resumption"
39330 &%tls_resumption%&: When a message is sent or received over an encrypted
39331 connection and the TLS session resumed one used on a previous TCP connection,
39332 an asterisk is appended to the X= cipher field in the log line.
39333 .next
39334 .cindex "log" "TLS SNI"
39335 .cindex "TLS" "logging SNI"
39336 .cindex SNI logging
39337 &%tls_sni%&: When a message is received over an encrypted connection, and
39338 the remote host provided the Server Name Indication extension, the SNI is
39339 added to the log line, preceded by SNI=.
39340 .next
39341 .cindex "log" "DNS failure in list"
39342 &%unknown_in_list%&: This setting causes a log entry to be written when the
39343 result of a list match is failure because a DNS lookup failed.
39344 .endlist
39345
39346
39347 .section "Message log" "SECID260"
39348 .cindex "message" "log file for"
39349 .cindex "log" "message log; description of"
39350 .cindex "&_msglog_& directory"
39351 .oindex "&%preserve_message_logs%&"
39352 In addition to the general log files, Exim writes a log file for each message
39353 that it handles. The names of these per-message logs are the message ids, and
39354 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39355 message log contains copies of the log lines that apply to the message. This
39356 makes it easier to inspect the status of an individual message without having
39357 to search the main log. A message log is deleted when processing of the message
39358 is complete, unless &%preserve_message_logs%& is set, but this should be used
39359 only with great care because they can fill up your disk very quickly.
39360
39361 On a heavily loaded system, it may be desirable to disable the use of
39362 per-message logs, in order to reduce disk I/O. This can be done by setting the
39363 &%message_logs%& option false.
39364 .ecindex IIDloggen
39365
39366
39367
39368
39369 . ////////////////////////////////////////////////////////////////////////////
39370 . ////////////////////////////////////////////////////////////////////////////
39371
39372 .chapter "Exim utilities" "CHAPutils"
39373 .scindex IIDutils "utilities"
39374 A number of utility scripts and programs are supplied with Exim and are
39375 described in this chapter. There is also the Exim Monitor, which is covered in
39376 the next chapter. The utilities described here are:
39377
39378 .itable none 0 0 3  7* left  15* left  40* left
39379 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39380   "list what Exim processes are doing"
39381 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39382 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39383 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39384 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39385                                                 various criteria"
39386 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39387 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39388   "extract statistics from the log"
39389 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39390   "check address acceptance from given IP"
39391 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39392 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39393 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39394 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39395 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39396 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39397 .endtable
39398
39399 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39400 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39401 &url(https://duncanthrax.net/exilog/) for details.
39402
39403
39404
39405
39406 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39407 .cindex "&'exiwhat'&"
39408 .cindex "process, querying"
39409 .cindex "SIGUSR1"
39410 On operating systems that can restart a system call after receiving a signal
39411 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39412 a line describing what it is doing to the file &_exim-process.info_& in the
39413 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39414 processes it can find, having first emptied the file. It then waits for one
39415 second to allow the Exim processes to react before displaying the results. In
39416 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39417 send the signal to the Exim processes, so it is normally run as root.
39418
39419 &*Warning*&: This is not an efficient process. It is intended for occasional
39420 use by system administrators. It is not sensible, for example, to set up a
39421 script that sends SIGUSR1 signals to Exim processes at short intervals.
39422
39423
39424 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39425 varies in different operating systems. Not only are different options used,
39426 but the format of the output is different. For this reason, there are some
39427 system configuration options that configure exactly how &'exiwhat'& works. If
39428 it doesn't seem to be working for you, check the following compile-time
39429 options:
39430 .itable none 0 0 2 30* left 70* left
39431 .irow &`EXIWHAT_PS_CMD`&        "the command for running &'ps'&"
39432 .irow &`EXIWHAT_PS_ARG`&        "the argument for &'ps'&"
39433 .irow &`EXIWHAT_EGREP_ARG`&     "the argument for &'egrep'& to select from &'ps'& output"
39434 .irow &`EXIWHAT_KILL_ARG`&      "the argument for the &'kill'& command"
39435 .endtable
39436 An example of typical output from &'exiwhat'& is
39437 .code
39438 164 daemon: -q1h, listening on port 25
39439 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39440 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39441   [10.19.42.42] (editor@ref.example)
39442 10592 handling incoming call from [192.168.243.242]
39443 10628 accepting a local non-SMTP message
39444 .endd
39445 The first number in the output line is the process number. The third line has
39446 been split here, in order to fit it on the page.
39447
39448
39449
39450 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39451 .cindex "&'exiqgrep'&"
39452 .cindex "queue" "grepping"
39453 This utility is a Perl script contributed by Matt Hubbard. It runs
39454 .code
39455 exim -bpu
39456 .endd
39457 or (in case &*-a*& switch is specified)
39458 .code
39459 exim -bp
39460 .endd
39461 to obtain a queue listing, and then greps the output to select messages
39462 that match given criteria. The following selection options are available:
39463
39464 .vlist
39465 .vitem &*-f*&&~<&'regex'&>
39466 Match the sender address using a case-insensitive search. The field that is
39467 tested is enclosed in angle brackets, so you can test for bounce messages with
39468 .code
39469 exiqgrep -f '^<>$'
39470 .endd
39471 .vitem &*-r*&&~<&'regex'&>
39472 Match a recipient address using a case-insensitive search. The field that is
39473 tested is not enclosed in angle brackets.
39474
39475 .vitem &*-s*&&~<&'regex'&>
39476 Match against the size field.
39477
39478 .vitem &*-y*&&~<&'seconds'&>
39479 Match messages that are younger than the given time.
39480
39481 .vitem &*-o*&&~<&'seconds'&>
39482 Match messages that are older than the given time.
39483
39484 .vitem &*-z*&
39485 Match only frozen messages.
39486
39487 .vitem &*-x*&
39488 Match only non-frozen messages.
39489
39490 .vitem &*-G*&&~<&'queuename'&>
39491 Match only messages in the given queue.  Without this, the default queue is searched.
39492 .endlist
39493
39494 The following options control the format of the output:
39495
39496 .vlist
39497 .vitem &*-c*&
39498 Display only the count of matching messages.
39499
39500 .vitem &*-l*&
39501 Long format &-- display the full message information as output by Exim. This is
39502 the default.
39503
39504 .vitem &*-i*&
39505 Display message ids only.
39506
39507 .vitem &*-b*&
39508 Brief format &-- one line per message.
39509
39510 .vitem &*-R*&
39511 Display messages in reverse order.
39512
39513 .vitem &*-a*&
39514 Include delivered recipients in queue listing.
39515 .endlist
39516
39517 The following options give alternates for configuration:
39518
39519 .vlist
39520 .vitem &*-C*&&~<&'config&~file'&>
39521 is used to specify an alternate &_exim.conf_& which might
39522 contain alternate exim configuration the queue management might be using.
39523
39524 .vitem &*-E*&&~<&'path'&>
39525 can be used to specify a path for the exim binary,
39526 overriding the built-in one.
39527 .endlist
39528
39529 There is one more option, &%-h%&, which outputs a list of options.
39530 At least one selection option, or either the &*-c*& or &*-h*& option, must be given.
39531
39532
39533
39534 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39535 .cindex "&'exiqsumm'&"
39536 .cindex "queue" "summary"
39537 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39538 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39539 running a command such as
39540 .code
39541 exim -bp | exiqsumm
39542 .endd
39543 The output consists of one line for each domain that has messages waiting for
39544 it, as in the following example:
39545 .code
39546 3   2322   74m   66m  msn.com.example
39547 .endd
39548 Each line lists the number of pending deliveries for a domain, their total
39549 volume, and the length of time that the oldest and the newest messages have
39550 been waiting. Note that the number of pending deliveries is greater than the
39551 number of messages when messages have more than one recipient.
39552
39553 A summary line is output at the end. By default the output is sorted on the
39554 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39555 the output to be sorted by oldest message and by count of messages,
39556 respectively. There are also three options that split the messages for each
39557 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39558 separates frozen messages, and &%-s%& separates messages according to their
39559 sender.
39560
39561 The output of &'exim -bp'& contains the original addresses in the message, so
39562 this also applies to the output from &'exiqsumm'&. No domains from addresses
39563 generated by aliasing or forwarding are included (unless the &%one_time%&
39564 option of the &(redirect)& router has been used to convert them into &"top
39565 level"& addresses).
39566
39567
39568
39569
39570 .section "Extracting specific information from the log (exigrep)" &&&
39571          "SECTextspeinf"
39572 .cindex "&'exigrep'&"
39573 .cindex "log" "extracts; grepping for"
39574 The &'exigrep'& utility is a Perl script that searches one or more main log
39575 files for entries that match a given pattern. When it finds a match, it
39576 extracts all the log entries for the relevant message, not just those that
39577 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
39578 given message, or all mail for a given user, or for a given host, for example.
39579 The input files can be in Exim log format or syslog format.
39580 If a matching log line is not associated with a specific message, it is
39581 included in &'exigrep'&'s output without any additional lines. The usage is:
39582 .display
39583 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
39584 .endd
39585 If no log filenames are given on the command line, the standard input is read.
39586
39587 The &%-t%& argument specifies a number of seconds. It adds an additional
39588 condition for message selection. Messages that are complete are shown only if
39589 they spent more than <&'n'&> seconds in the queue.
39590
39591 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
39592 makes it case-sensitive. This may give a performance improvement when searching
39593 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
39594 option; with &%-I%& they do not. In both cases it is possible to change the
39595 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
39596
39597 The &%-l%& option means &"literal"&, that is, treat all characters in the
39598 pattern as standing for themselves. Otherwise the pattern must be a Perl
39599 regular expression.
39600
39601 The &%-v%& option inverts the matching condition. That is, a line is selected
39602 if it does &'not'& match the pattern.
39603
39604 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39605 that are generated as a result/response to a message that &'exigrep'& matched
39606 normally.
39607
39608 Example of &%-M%&:
39609 user_a sends a message to user_b, which generates a bounce back to user_b. If
39610 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39611 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
39612 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
39613 when searching for &"user_a"& will show both messages since the bounce is
39614 &"related"& to or a &"result"& of the first message that was found by the
39615 search term.
39616
39617 If the location of a &'zcat'& command is known from the definition of
39618 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
39619 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
39620 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
39621 autodetection of some well known compression extensions.
39622
39623
39624 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
39625 .cindex "&'exipick'&"
39626 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
39627 lists messages from the queue according to a variety of criteria. For details
39628 of &'exipick'&'s facilities, run &'exipick'& with
39629 the &%--help%& option.
39630
39631
39632 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
39633 .cindex "log" "cycling local files"
39634 .cindex "cycling logs"
39635 .cindex "&'exicyclog'&"
39636 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39637 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39638 you are using log files with datestamps in their names (see section
39639 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39640 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39641 There are two command line options for &'exicyclog'&:
39642 .ilist
39643 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39644 default that is set when Exim is built. The default default is 10.
39645 .next
39646 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39647 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39648 overriding the script's default, which is to find the setting from Exim's
39649 configuration.
39650 .endlist
39651
39652 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39653 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39654 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39655 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39656 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39657 logs are handled similarly.
39658
39659 If the limit is greater than 99, the script uses 3-digit numbers such as
39660 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39661 to one that is greater, or &'vice versa'&, you will have to fix the names of
39662 any existing log files.
39663
39664 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39665 the end are deleted. All files with numbers greater than 01 are compressed,
39666 using a compression command which is configured by the COMPRESS_COMMAND
39667 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39668 root &%crontab%& entry of the form
39669 .code
39670 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39671 .endd
39672 assuming you have used the name &"exim"& for the Exim user. You can run
39673 &'exicyclog'& as root if you wish, but there is no need.
39674
39675
39676
39677 .section "Mail statistics (eximstats)" "SECTmailstat"
39678 .cindex "statistics"
39679 .cindex "&'eximstats'&"
39680 A Perl script called &'eximstats'& is provided for extracting statistical
39681 information from log files. The output is either plain text, or HTML.
39682 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39683 . --- 404 error and everything else points to that.
39684
39685 The &'eximstats'& script has been hacked about quite a bit over time. The
39686 latest version is the result of some extensive revision by Steve Campbell. A
39687 lot of information is given by default, but there are options for suppressing
39688 various parts of it. Following any options, the arguments to the script are a
39689 list of files, which should be main log files. For example:
39690 .code
39691 eximstats -nr /var/spool/exim/log/mainlog.01
39692 .endd
39693 By default, &'eximstats'& extracts information about the number and volume of
39694 messages received from or delivered to various hosts. The information is sorted
39695 both by message count and by volume, and the top fifty hosts in each category
39696 are listed on the standard output. Similar information, based on email
39697 addresses or domains instead of hosts can be requested by means of various
39698 options. For messages delivered and received locally, similar statistics are
39699 also produced per user.
39700
39701 The output also includes total counts and statistics about delivery errors, and
39702 histograms showing the number of messages received and deliveries made in each
39703 hour of the day. A delivery with more than one address in its envelope (for
39704 example, an SMTP transaction with more than one RCPT command) is counted
39705 as a single delivery by &'eximstats'&.
39706
39707 Though normally more deliveries than receipts are reported (as messages may
39708 have multiple recipients), it is possible for &'eximstats'& to report more
39709 messages received than delivered, even though the queue is empty at the start
39710 and end of the period in question. If an incoming message contains no valid
39711 recipients, no deliveries are recorded for it. A bounce message is handled as
39712 an entirely separate message.
39713
39714 &'eximstats'& always outputs a grand total summary giving the volume and number
39715 of messages received and deliveries made, and the number of hosts involved in
39716 each case. It also outputs the number of messages that were delayed (that is,
39717 not completely delivered at the first attempt), and the number that had at
39718 least one address that failed.
39719
39720 The remainder of the output is in sections that can be independently disabled
39721 or modified by various options. It consists of a summary of deliveries by
39722 transport, histograms of messages received and delivered per time interval
39723 (default per hour), information about the time messages spent in the queue,
39724 a list of relayed messages, lists of the top fifty sending hosts, local
39725 senders, destination hosts, and destination local users by count and by volume,
39726 and a list of delivery errors that occurred.
39727
39728 The relay information lists messages that were actually relayed, that is, they
39729 came from a remote host and were directly delivered to some other remote host,
39730 without being processed (for example, for aliasing or forwarding) locally.
39731
39732 There are quite a few options for &'eximstats'& to control exactly what it
39733 outputs. These are documented in the Perl script itself, and can be extracted
39734 by running the command &(perldoc)& on the script. For example:
39735 .code
39736 perldoc /usr/exim/bin/eximstats
39737 .endd
39738
39739 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39740 .cindex "&'exim_checkaccess'&"
39741 .cindex "policy control" "checking access"
39742 .cindex "checking access"
39743 The &%-bh%& command line argument allows you to run a fake SMTP session with
39744 debugging output, in order to check what Exim is doing when it is applying
39745 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39746 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39747 sometimes you just want to answer the question &"Does this address have
39748 access?"& without bothering with any further details.
39749
39750 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39751 two arguments, an IP address and an email address:
39752 .code
39753 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39754 .endd
39755 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39756 given email address would be accepted in a RCPT command in a TCP/IP
39757 connection from the host with the given IP address. The output of the utility
39758 is either the word &"accepted"&, or the SMTP error response, for example:
39759 .code
39760 Rejected:
39761 550 Relay not permitted
39762 .endd
39763 When running this test, the utility uses &`<>`& as the envelope sender address
39764 for the MAIL command, but you can change this by providing additional
39765 options. These are passed directly to the Exim command. For example, to specify
39766 that the test is to be run with the sender address &'himself@there.example'&
39767 you can use:
39768 .code
39769 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39770                  -f himself@there.example
39771 .endd
39772 Note that these additional Exim command line items must be given after the two
39773 mandatory arguments.
39774
39775 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39776 while running its checks. You can run checks that include callouts by using
39777 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39778
39779
39780
39781 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39782 .cindex "DBM" "building dbm files"
39783 .cindex "building DBM files"
39784 .cindex "&'exim_dbmbuild'&"
39785 .cindex "lower casing"
39786 .cindex "binary zero" "in lookup key"
39787 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39788 the format used by the &(lsearch)& lookup (see section
39789 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39790 names as keys and the remainder of the information as data. The lower-casing
39791 can be prevented by calling the program with the &%-nolc%& option.
39792
39793 A terminating zero is included as part of the key string. This is expected by
39794 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39795 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39796 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39797 files.
39798
39799 The program requires two arguments: the name of the input file (which can be a
39800 single hyphen to indicate the standard input), and the name of the output file.
39801 It creates the output under a temporary name, and then renames it if all went
39802 well.
39803
39804 .cindex "USE_DB"
39805 If the native DB interface is in use (USE_DB is set in a compile-time
39806 configuration file &-- this is common in free versions of Unix) the two
39807 filenames must be different, because in this mode the Berkeley DB functions
39808 create a single output file using exactly the name given. For example,
39809 .code
39810 exim_dbmbuild /etc/aliases /etc/aliases.db
39811 .endd
39812 reads the system alias file and creates a DBM version of it in
39813 &_/etc/aliases.db_&.
39814
39815 In systems that use the &'ndbm'& routines (mostly proprietary versions of
39816 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
39817 environment, the suffixes are added to the second argument of
39818 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
39819 when the Berkeley functions are used in compatibility mode (though this is not
39820 recommended), because in that case it adds a &_.db_& suffix to the filename.
39821
39822 If a duplicate key is encountered, the program outputs a warning, and when it
39823 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
39824 option is used. By default, only the first of a set of duplicates is used &--
39825 this makes it compatible with &(lsearch)& lookups. There is an option
39826 &%-lastdup%& which causes it to use the data for the last duplicate instead.
39827 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
39828 &%stderr%&. For other errors, where it doesn't actually make a new file, the
39829 return code is 2.
39830
39831
39832
39833
39834 .section "Finding individual retry times (exinext)" "SECTfinindret"
39835 .cindex "retry" "times"
39836 .cindex "&'exinext'&"
39837 A utility called &'exinext'& (mostly a Perl script) provides the ability to
39838 fish specific information out of the retry database. Given a mail domain (or a
39839 complete address), it looks up the hosts for that domain, and outputs any retry
39840 information for the hosts or for the domain. At present, the retry information
39841 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
39842 output. For example:
39843 .code
39844 $ exinext piglet@milne.fict.example
39845 kanga.milne.example:192.168.8.1 error 146: Connection refused
39846   first failed: 21-Feb-1996 14:57:34
39847   last tried:   21-Feb-1996 14:57:34
39848   next try at:  21-Feb-1996 15:02:34
39849 roo.milne.example:192.168.8.3 error 146: Connection refused
39850   first failed: 20-Jan-1996 13:12:08
39851   last tried:   21-Feb-1996 11:42:03
39852   next try at:  21-Feb-1996 19:42:03
39853   past final cutoff time
39854 .endd
39855 You can also give &'exinext'& a local part, without a domain, and it
39856 will give any retry information for that local part in your default domain.
39857 A message id can be used to obtain retry information pertaining to a specific
39858 message. This exists only when an attempt to deliver a message to a remote host
39859 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
39860 &'exinext'& is not particularly efficient, but then it is not expected to be
39861 run very often.
39862
39863 The &'exinext'& utility calls Exim to find out information such as the location
39864 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
39865 passed on to the &'exim'& commands. The first specifies an alternate Exim
39866 configuration file, and the second sets macros for use within the configuration
39867 file. These features are mainly to help in testing, but might also be useful in
39868 environments where more than one configuration file is in use.
39869
39870
39871
39872 .section "Hints database maintenance" "SECThindatmai"
39873 .cindex "hints database" "maintenance"
39874 .cindex "maintaining Exim's hints database"
39875 Three utility programs are provided for maintaining the DBM files that Exim
39876 uses to contain its delivery hint information. Each program requires two
39877 arguments. The first specifies the name of Exim's spool directory, and the
39878 second is the name of the database it is to operate on. These are as follows:
39879
39880 .ilist
39881 &'retry'&: the database of retry information
39882 .next
39883 &'wait-'&<&'transport name'&>: databases of information about messages waiting
39884 for remote hosts
39885 .next
39886 &'callout'&: the callout cache
39887 .next
39888 &'ratelimit'&: the data for implementing the ratelimit ACL condition
39889 .next
39890 &'tls'&: TLS session resumption data
39891 .next
39892 &'misc'&: other hints data
39893 .endlist
39894
39895 The &'misc'& database is used for
39896
39897 .ilist
39898 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
39899 .next
39900 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
39901 &(smtp)& transport)
39902 .next
39903 Limiting the concurrency of specific transports (when &%max_parallel%& is set
39904 in a transport)
39905 .endlist
39906
39907
39908
39909 .section "exim_dumpdb" "SECTdumpdb"
39910 .cindex "&'exim_dumpdb'&"
39911 The entire contents of a database are written to the standard output by the
39912 &'exim_dumpdb'& program,
39913 taking as arguments the spool and database names.
39914 An option &'-z'& may be given to request times in UTC;
39915 otherwise times are in the local timezone.
39916 An option &'-k'& may be given to dump only the record keys.
39917 For example, to dump the retry database:
39918 .code
39919 exim_dumpdb /var/spool/exim retry
39920 .endd
39921 For the retry database
39922 two lines of output are produced for each entry:
39923 .code
39924 T:mail.ref.example:192.168.242.242 146 77 Connection refused
39925 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
39926 .endd
39927 The first item on the first line is the key of the record. It starts with one
39928 of the letters R, or T, depending on whether it refers to a routing or
39929 transport retry. For a local delivery, the next part is the local address; for
39930 a remote delivery it is the name of the remote host, followed by its failing IP
39931 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
39932 transport). If the remote port is not the standard one (port 25), it is added
39933 to the IP address. Then there follows an error code, an additional error code,
39934 and a textual description of the error.
39935
39936 The three times on the second line are the time of first failure, the time of
39937 the last delivery attempt, and the computed time for the next attempt. The line
39938 ends with an asterisk if the cutoff time for the last retry rule has been
39939 exceeded.
39940
39941 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
39942 consists of a host name followed by a list of ids for messages that are or were
39943 waiting to be delivered to that host. If there are a very large number for any
39944 one host, continuation records, with a sequence number added to the host name,
39945 may be seen. The data in these records is often out of date, because a message
39946 may be routed to several alternative hosts, and Exim makes no effort to keep
39947 cross-references.
39948
39949
39950
39951 .section "exim_tidydb" "SECTtidydb"
39952 .cindex "&'exim_tidydb'&"
39953 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
39954 database. If run with no options, it removes all records that are more than 30
39955 days old. The age is calculated from the date and time that the record was last
39956 updated. Note that, in the case of the retry database, it is &'not'& the time
39957 since the first delivery failure. Information about a host that has been down
39958 for more than 30 days will remain in the database, provided that the record is
39959 updated sufficiently often.
39960
39961 The cutoff date can be altered by means of the &%-t%& option, which must be
39962 followed by a time. For example, to remove all records older than a week from
39963 the retry database:
39964 .code
39965 exim_tidydb -t 7d /var/spool/exim retry
39966 .endd
39967 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
39968 message ids. In the former these appear as data in records keyed by host &--
39969 they were messages that were waiting for that host &-- and in the latter they
39970 are the keys for retry information for messages that have suffered certain
39971 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
39972 message ids in database records are those of messages that are still on the
39973 queue. Message ids for messages that no longer exist are removed from
39974 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
39975 For the &'retry'& database, records whose keys are non-existent message ids are
39976 removed. The &'exim_tidydb'& utility outputs comments on the standard output
39977 whenever it removes information from the database.
39978
39979 Certain records are automatically removed by Exim when they are no longer
39980 needed, but others are not. For example, if all the MX hosts for a domain are
39981 down, a retry record is created for each one. If the primary MX host comes back
39982 first, its record is removed when Exim successfully delivers to it, but the
39983 records for the others remain because Exim has not tried to use those hosts.
39984
39985 It is important, therefore, to run &'exim_tidydb'& periodically on all the
39986 hints databases. You should do this at a quiet time of day, because it requires
39987 a database to be locked (and therefore inaccessible to Exim) while it does its
39988 work. Removing records from a DBM file does not normally make the file smaller,
39989 but all the common DBM libraries are able to re-use the space that is released.
39990 After an initial phase of increasing in size, the databases normally reach a
39991 point at which they no longer get any bigger, as long as they are regularly
39992 tidied.
39993
39994 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
39995 databases is likely to keep on increasing.
39996
39997
39998
39999
40000 .section "exim_fixdb" "SECTfixdb"
40001 .cindex "&'exim_fixdb'&"
40002 The &'exim_fixdb'& program is a utility for interactively modifying databases.
40003 Its main use is for testing Exim, but it might also be occasionally useful for
40004 getting round problems in a live system. Its interface
40005 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
40006 key of a database record can then be entered, and the data for that record is
40007 displayed.
40008
40009 If &"d"& is typed at the next prompt, the entire record is deleted. For all
40010 except the &'retry'& database, that is the only operation that can be carried
40011 out. For the &'retry'& database, each field is output preceded by a number, and
40012 data for individual fields can be changed by typing the field number followed
40013 by new data, for example:
40014 .code
40015 > 4 951102:1000
40016 .endd
40017 resets the time of the next delivery attempt. Time values are given as a
40018 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
40019 used as optional separators.
40020
40021 Both displayed and input times are in the local timezone by default.
40022 If an option &'-z'& is used on the command line, displayed times
40023 are in UTC.
40024
40025
40026
40027
40028 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
40029 .cindex "mailbox" "maintenance"
40030 .cindex "&'exim_lock'&"
40031 .cindex "locking mailboxes"
40032 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
40033 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
40034 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
40035 a user agent while investigating a problem. The utility requires the name of
40036 the file as its first argument. If the locking is successful, the second
40037 argument is run as a command (using C's &[system()]& function); if there is no
40038 second argument, the value of the SHELL environment variable is used; if this
40039 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
40040 is unlocked and the utility ends. The following options are available:
40041
40042 .vlist
40043 .vitem &%-fcntl%&
40044 Use &[fcntl()]& locking on the open mailbox.
40045
40046 .vitem &%-flock%&
40047 Use &[flock()]& locking on the open mailbox, provided the operating system
40048 supports it.
40049
40050 .vitem &%-interval%&
40051 This must be followed by a number, which is a number of seconds; it sets the
40052 interval to sleep between retries (default 3).
40053
40054 .vitem &%-lockfile%&
40055 Create a lock file before opening the mailbox.
40056
40057 .vitem &%-mbx%&
40058 Lock the mailbox using MBX rules.
40059
40060 .vitem &%-q%&
40061 Suppress verification output.
40062
40063 .vitem &%-retries%&
40064 This must be followed by a number; it sets the number of times to try to get
40065 the lock (default 10).
40066
40067 .vitem &%-restore_time%&
40068 This option causes &%exim_lock%& to restore the modified and read times to the
40069 locked file before exiting. This allows you to access a locked mailbox (for
40070 example, to take a backup copy) without disturbing the times that the user
40071 subsequently sees.
40072
40073 .vitem &%-timeout%&
40074 This must be followed by a number, which is a number of seconds; it sets a
40075 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
40076 default), a non-blocking call is used.
40077
40078 .vitem &%-v%&
40079 Generate verbose output.
40080 .endlist
40081
40082 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
40083 default is to create a lock file and also to use &[fcntl()]& locking on the
40084 mailbox, which is the same as Exim's default. The use of &%-flock%& or
40085 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
40086 requires that the directory containing the file be writeable. Locking by lock
40087 file does not last forever; Exim assumes that a lock file is expired if it is
40088 more than 30 minutes old.
40089
40090 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
40091 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
40092 to be taken out on the open mailbox, and an exclusive lock on the file
40093 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
40094 number of the mailbox file. When the locking is released, if an exclusive lock
40095 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
40096
40097 The default output contains verification of the locking that takes place. The
40098 &%-v%& option causes some additional information to be given. The &%-q%& option
40099 suppresses all output except error messages.
40100
40101 A command such as
40102 .code
40103 exim_lock /var/spool/mail/spqr
40104 .endd
40105 runs an interactive shell while the file is locked, whereas
40106 .display
40107 &`exim_lock -q /var/spool/mail/spqr <<End`&
40108 <&'some commands'&>
40109 &`End`&
40110 .endd
40111 runs a specific non-interactive sequence of commands while the file is locked,
40112 suppressing all verification output. A single command can be run by a command
40113 such as
40114 .code
40115 exim_lock -q /var/spool/mail/spqr \
40116   "cp /var/spool/mail/spqr /some/where"
40117 .endd
40118 Note that if a command is supplied, it must be entirely contained within the
40119 second argument &-- hence the quotes.
40120 .ecindex IIDutils
40121
40122
40123 . ////////////////////////////////////////////////////////////////////////////
40124 . ////////////////////////////////////////////////////////////////////////////
40125
40126 .chapter "The Exim monitor" "CHAPeximon"
40127 .scindex IIDeximon "Exim monitor" "description"
40128 .cindex "X-windows"
40129 .cindex "&'eximon'&"
40130 .cindex "Local/eximon.conf"
40131 .cindex "&_exim_monitor/EDITME_&"
40132 The Exim monitor is an application which displays in an X window information
40133 about the state of Exim's queue and what Exim is doing. An admin user can
40134 perform certain operations on messages from this GUI interface; however all
40135 such facilities are also available from the command line, and indeed, the
40136 monitor itself makes use of the command line to perform any actions requested.
40137
40138
40139
40140 .section "Running the monitor" "SECID264"
40141 The monitor is started by running the script called &'eximon'&. This is a shell
40142 script that sets up a number of environment variables, and then runs the
40143 binary called &_eximon.bin_&. The default appearance of the monitor window can
40144 be changed by editing the &_Local/eximon.conf_& file created by editing
40145 &_exim_monitor/EDITME_&. Comments in that file describe what the various
40146 parameters are for.
40147
40148 The parameters that get built into the &'eximon'& script can be overridden for
40149 a particular invocation by setting up environment variables of the same names,
40150 preceded by &`EXIMON_`&. For example, a shell command such as
40151 .code
40152 EXIMON_LOG_DEPTH=400 eximon
40153 .endd
40154 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
40155 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
40156 overrides the Exim log file configuration. This makes it possible to have
40157 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
40158 syslog messages are routed to a file on the local host.
40159
40160 X resources can be used to change the appearance of the window in the normal
40161 way. For example, a resource setting of the form
40162 .code
40163 Eximon*background: gray94
40164 .endd
40165 changes the colour of the background to light grey rather than white. The
40166 stripcharts are drawn with both the data lines and the reference lines in
40167 black. This means that the reference lines are not visible when on top of the
40168 data. However, their colour can be changed by setting a resource called
40169 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
40170 For example, if your X server is running Unix, you could set up lighter
40171 reference lines in the stripcharts by obeying
40172 .code
40173 xrdb -merge <<End
40174 Eximon*highlight: gray
40175 End
40176 .endd
40177 .cindex "admin user"
40178 In order to see the contents of messages in the queue, and to operate on them,
40179 &'eximon'& must either be run as root or by an admin user.
40180
40181 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
40182 contain X11 resource parameters interpreted by the X11 library.  In addition,
40183 if the first parameter starts with the string "gdb" then it is removed and the
40184 binary is invoked under gdb (the parameter is used as the gdb command-name, so
40185 versioned variants of gdb can be invoked).
40186
40187 The monitor's window is divided into three parts. The first contains one or
40188 more stripcharts and two action buttons, the second contains a &"tail"& of the
40189 main log file, and the third is a display of the queue of messages awaiting
40190 delivery, with two more action buttons. The following sections describe these
40191 different parts of the display.
40192
40193
40194
40195
40196 .section "The stripcharts" "SECID265"
40197 .cindex "stripchart"
40198 The first stripchart is always a count of messages in the queue. Its name can
40199 be configured by setting QUEUE_STRIPCHART_NAME in the
40200 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
40201 configuration script by regular expression matches on log file entries, making
40202 it possible to display, for example, counts of messages delivered to certain
40203 hosts or using certain transports. The supplied defaults display counts of
40204 received and delivered messages, and of local and SMTP deliveries. The default
40205 period between stripchart updates is one minute; this can be adjusted by a
40206 parameter in the &_Local/eximon.conf_& file.
40207
40208 The stripchart displays rescale themselves automatically as the value they are
40209 displaying changes. There are always 10 horizontal lines in each chart; the
40210 title string indicates the value of each division when it is greater than one.
40211 For example, &"x2"& means that each division represents a value of 2.
40212
40213 It is also possible to have a stripchart which shows the percentage fullness of
40214 a particular disk partition, which is useful when local deliveries are confined
40215 to a single partition.
40216
40217 .cindex "&%statvfs%& function"
40218 This relies on the availability of the &[statvfs()]& function or equivalent in
40219 the operating system. Most, but not all versions of Unix that support Exim have
40220 this. For this particular stripchart, the top of the chart always represents
40221 100%, and the scale is given as &"x10%"&. This chart is configured by setting
40222 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
40223 &_Local/eximon.conf_& file.
40224
40225
40226
40227
40228 .section "Main action buttons" "SECID266"
40229 .cindex "size" "of monitor window"
40230 .cindex "Exim monitor" "window size"
40231 .cindex "window size"
40232 Below the stripcharts there is an action button for quitting the monitor. Next
40233 to this is another button marked &"Size"&. They are placed here so that
40234 shrinking the window to its default minimum size leaves just the queue count
40235 stripchart and these two buttons visible. Pressing the &"Size"& button causes
40236 the window to expand to its maximum size, unless it is already at the maximum,
40237 in which case it is reduced to its minimum.
40238
40239 When expanding to the maximum, if the window cannot be fully seen where it
40240 currently is, it is moved back to where it was the last time it was at full
40241 size. When it is expanding from its minimum size, the old position is
40242 remembered, and next time it is reduced to the minimum it is moved back there.
40243
40244 The idea is that you can keep a reduced window just showing one or two
40245 stripcharts at a convenient place on your screen, easily expand it to show
40246 the full window when required, and just as easily put it back to what it was.
40247 The idea is copied from what the &'twm'& window manager does for its
40248 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
40249 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
40250
40251 Normally, the monitor starts up with the window at its full size, but it can be
40252 built so that it starts up with the window at its smallest size, by setting
40253 START_SMALL=yes in &_Local/eximon.conf_&.
40254
40255
40256
40257 .section "The log display" "SECID267"
40258 .cindex "log" "tail of; in monitor"
40259 The second section of the window is an area in which a display of the tail of
40260 the main log is maintained.
40261 To save space on the screen, the timestamp on each log line is shortened by
40262 removing the date and, if &%log_timezone%& is set, the timezone.
40263 The log tail is not available when the only destination for logging data is
40264 syslog, unless the syslog lines are routed to a local file whose name is passed
40265 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
40266
40267 The log sub-window has a scroll bar at its lefthand side which can be used to
40268 move back to look at earlier text, and the up and down arrow keys also have a
40269 scrolling effect. The amount of log that is kept depends on the setting of
40270 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
40271 to use. When this is full, the earlier 50% of data is discarded &-- this is
40272 much more efficient than throwing it away line by line. The sub-window also has
40273 a horizontal scroll bar for accessing the ends of long log lines. This is the
40274 only means of horizontal scrolling; the right and left arrow keys are not
40275 available. Text can be cut from this part of the window using the mouse in the
40276 normal way. The size of this subwindow is controlled by parameters in the
40277 configuration file &_Local/eximon.conf_&.
40278
40279 Searches of the text in the log window can be carried out by means of the ^R
40280 and ^S keystrokes, which default to a reverse and a forward search,
40281 respectively. The search covers only the text that is displayed in the window.
40282 It cannot go further back up the log.
40283
40284 The point from which the search starts is indicated by a caret marker. This is
40285 normally at the end of the text in the window, but can be positioned explicitly
40286 by pointing and clicking with the left mouse button, and is moved automatically
40287 by a successful search. If new text arrives in the window when it is scrolled
40288 back, the caret remains where it is, but if the window is not scrolled back,
40289 the caret is moved to the end of the new text.
40290
40291 Pressing ^R or ^S pops up a window into which the search text can be typed.
40292 There are buttons for selecting forward or reverse searching, for carrying out
40293 the search, and for cancelling. If the &"Search"& button is pressed, the search
40294 happens and the window remains so that further searches can be done. If the
40295 &"Return"& key is pressed, a single search is done and the window is closed. If
40296 ^C is typed the search is cancelled.
40297
40298 The searching facility is implemented using the facilities of the Athena text
40299 widget. By default this pops up a window containing both &"search"& and
40300 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
40301 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
40302 However, the linkers in BSDI and HP-UX seem unable to handle an externally
40303 provided version of &%TextPop%& when the remaining parts of the text widget
40304 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
40305 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
40306 on these systems, at the expense of having unwanted items in the search popup
40307 window.
40308
40309
40310
40311 .section "The queue display" "SECID268"
40312 .cindex "queue" "display in monitor"
40313 The bottom section of the monitor window contains a list of all messages that
40314 are in the queue, which includes those currently being received or delivered,
40315 as well as those awaiting delivery. The size of this subwindow is controlled by
40316 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
40317 at which it is updated is controlled by another parameter in the same file &--
40318 the default is 5 minutes, since queue scans can be quite expensive. However,
40319 there is an &"Update"& action button just above the display which can be used
40320 to force an update of the queue display at any time.
40321
40322 When a host is down for some time, a lot of pending mail can build up for it,
40323 and this can make it hard to deal with other messages in the queue. To help
40324 with this situation there is a button next to &"Update"& called &"Hide"&. If
40325 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
40326 type anything in here and press &"Return"&, the text is added to a chain of
40327 such texts, and if every undelivered address in a message matches at least one
40328 of the texts, the message is not displayed.
40329
40330 If there is an address that does not match any of the texts, all the addresses
40331 are displayed as normal. The matching happens on the ends of addresses so, for
40332 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
40333 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
40334 has been set up, a button called &"Unhide"& is displayed. If pressed, it
40335 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
40336 a hide request is automatically cancelled after one hour.
40337
40338 While the dialogue box is displayed, you can't press any buttons or do anything
40339 else to the monitor window. For this reason, if you want to cut text from the
40340 queue display to use in the dialogue box, you have to do the cutting before
40341 pressing the &"Hide"& button.
40342
40343 The queue display contains, for each unhidden queued message, the length of
40344 time it has been in the queue, the size of the message, the message id, the
40345 message sender, and the first undelivered recipient, all on one line. If it is
40346 a bounce message, the sender is shown as &"<>"&. If there is more than one
40347 recipient to which the message has not yet been delivered, subsequent ones are
40348 listed on additional lines, up to a maximum configured number, following which
40349 an ellipsis is displayed. Recipients that have already received the message are
40350 not shown.
40351
40352 .cindex "frozen messages" "display"
40353 If a message is frozen, an asterisk is displayed at the left-hand side.
40354
40355 The queue display has a vertical scroll bar, and can also be scrolled by means
40356 of the arrow keys. Text can be cut from it using the mouse in the normal way.
40357 The text searching facilities, as described above for the log window, are also
40358 available, but the caret is always moved to the end of the text when the queue
40359 display is updated.
40360
40361
40362
40363 .section "The queue menu" "SECID269"
40364 .cindex "queue" "menu in monitor"
40365 If the &%shift%& key is held down and the left button is clicked when the mouse
40366 pointer is over the text for any message, an action menu pops up, and the first
40367 line of the queue display for the message is highlighted. This does not affect
40368 any selected text.
40369
40370 If you want to use some other event for popping up the menu, you can set the
40371 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40372 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40373 value set in this parameter is a standard X event description. For example, to
40374 run eximon using &%ctrl%& rather than &%shift%& you could use
40375 .code
40376 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40377 .endd
40378 The title of the menu is the message id, and it contains entries which act as
40379 follows:
40380
40381 .ilist
40382 &'message log'&: The contents of the message log for the message are displayed
40383 in a new text window.
40384 .next
40385 &'headers'&: Information from the spool file that contains the envelope
40386 information and headers is displayed in a new text window. See chapter
40387 &<<CHAPspool>>& for a description of the format of spool files.
40388 .next
40389 &'body'&: The contents of the spool file containing the body of the message are
40390 displayed in a new text window. There is a default limit of 20,000 bytes to the
40391 amount of data displayed. This can be changed by setting the BODY_MAX
40392 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40393 .next
40394 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40395 delivery of the message. This causes an automatic thaw if the message is
40396 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40397 a new text window. The delivery is run in a separate process, to avoid holding
40398 up the monitor while the delivery proceeds.
40399 .next
40400 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40401 that the message be frozen.
40402 .next
40403 .cindex "thawing messages"
40404 .cindex "unfreezing messages"
40405 .cindex "frozen messages" "thawing"
40406 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40407 that the message be thawed.
40408 .next
40409 .cindex "delivery" "forcing failure"
40410 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40411 that Exim gives up trying to deliver the message. A bounce message is generated
40412 for any remaining undelivered addresses.
40413 .next
40414 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40415 that the message be deleted from the system without generating a bounce
40416 message.
40417 .next
40418 &'add recipient'&: A dialog box is displayed into which a recipient address can
40419 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40420 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40421 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40422 causes a call to Exim to be made using the &%-Mar%& option to request that an
40423 additional recipient be added to the message, unless the entry box is empty, in
40424 which case no action is taken.
40425 .next
40426 &'mark delivered'&: A dialog box is displayed into which a recipient address
40427 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40428 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40429 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40430 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40431 recipient address as already delivered, unless the entry box is empty, in which
40432 case no action is taken.
40433 .next
40434 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40435 mark all recipient addresses as already delivered.
40436 .next
40437 &'edit sender'&: A dialog box is displayed initialized with the current
40438 sender's address. Pressing RETURN causes a call to Exim to be made using the
40439 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40440 in which case no action is taken. If you want to set an empty sender (as in
40441 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40442 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40443 the address is qualified with that domain.
40444 .endlist
40445
40446 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40447 other cases when a call to Exim is made, if there is any output from Exim (in
40448 particular, if the command fails) a window containing the command and the
40449 output is displayed. Otherwise, the results of the action are normally apparent
40450 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40451 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40452 if no output is generated.
40453
40454 The queue display is automatically updated for actions such as freezing and
40455 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40456 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40457 force an update of the display after one of these actions.
40458
40459 In any text window that is displayed as result of a menu action, the normal
40460 cut-and-paste facility is available, and searching can be carried out using ^R
40461 and ^S, as described above for the log tail window.
40462 .ecindex IIDeximon
40463
40464
40465
40466
40467
40468 . ////////////////////////////////////////////////////////////////////////////
40469 . ////////////////////////////////////////////////////////////////////////////
40470
40471 .chapter "Security considerations" "CHAPsecurity"
40472 .scindex IIDsecurcon "security" "discussion of"
40473 This chapter discusses a number of issues concerned with security, some of
40474 which are also covered in other parts of this manual.
40475
40476 For reasons that this author does not understand, some people have promoted
40477 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40478 existence of this chapter in the documentation. However, the intent of the
40479 chapter is simply to describe the way Exim works in relation to certain
40480 security concerns, not to make any specific claims about the effectiveness of
40481 its security as compared with other MTAs.
40482
40483 What follows is a description of the way Exim is supposed to be. Best efforts
40484 have been made to try to ensure that the code agrees with the theory, but an
40485 absence of bugs can never be guaranteed. Any that are reported will get fixed
40486 as soon as possible.
40487
40488
40489 .section "Building a more &""hardened""& Exim" "SECID286"
40490 .cindex "security" "build-time features"
40491 There are a number of build-time options that can be set in &_Local/Makefile_&
40492 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40493 Exim administrator who does not have the root password, or by someone who has
40494 penetrated the Exim (but not the root) account. These options are as follows:
40495
40496 .ilist
40497 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40498 start of any filenames used with the &%-C%& option. When it is set, these
40499 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40500 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40501 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40502 default setting for &%ALT_CONFIG_PREFIX%&.
40503
40504 If the permitted configuration files are confined to a directory to
40505 which only root has access, this guards against someone who has broken
40506 into the Exim account from running a privileged Exim with an arbitrary
40507 configuration file, and using it to break into other accounts.
40508 .next
40509
40510 If a non-trusted configuration file (i.e. not the default configuration file
40511 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40512 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40513 the next item), then root privilege is retained only if the caller of Exim is
40514 root. This locks out the possibility of testing a configuration using &%-C%&
40515 right through message reception and delivery, even if the caller is root. The
40516 reception works, but by that time, Exim is running as the Exim user, so when
40517 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40518 privilege to be lost. However, root can test reception and delivery using two
40519 separate commands.
40520
40521 .next
40522 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40523 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40524 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40525 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40526 the restrictive side.  Requiring build-time selection of safe macros is onerous
40527 but this option is intended solely as a transition mechanism to permit
40528 previously-working configurations to continue to work after release 4.73.
40529 .next
40530 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40531 is disabled.
40532 .next
40533 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40534 never to be used for any deliveries. This is like the &%never_users%& runtime
40535 option, but it cannot be overridden; the runtime option adds additional users
40536 to the list. The default setting is &"root"&; this prevents a non-root user who
40537 is permitted to modify the runtime file from using Exim as a way to get root.
40538 .endlist
40539
40540
40541
40542 .section "Root privilege" "SECID270"
40543 .cindex "setuid"
40544 .cindex "root privilege"
40545 The Exim binary is normally setuid to root, which means that it gains root
40546 privilege (runs as root) when it starts execution. In some special cases (for
40547 example, when the daemon is not in use and there are no local deliveries), it
40548 may be possible to run Exim setuid to some user other than root. This is
40549 discussed in the next section. However, in most installations, root privilege
40550 is required for two things:
40551
40552 .ilist
40553 To set up a socket connected to the standard SMTP port (25) when initialising
40554 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40555 not required.
40556 .next
40557 To be able to change uid and gid in order to read users' &_.forward_& files and
40558 perform local deliveries as the receiving user or as specified in the
40559 configuration.
40560 .endlist
40561
40562 It is not necessary to be root to do any of the other things Exim does, such as
40563 receiving messages and delivering them externally over SMTP, and it is
40564 obviously more secure if Exim does not run as root except when necessary.
40565 For this reason, a user and group for Exim to use must be defined in
40566 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
40567 group"&. Their values can be changed by the runtime configuration, though this
40568 is not recommended. Often a user called &'exim'& is used, but some sites use
40569 &'mail'& or another user name altogether.
40570
40571 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
40572 abdication; the process cannot regain root afterwards. Prior to release 4.00,
40573 &[seteuid()]& was used in some circumstances, but this is no longer the case.
40574
40575 After a new Exim process has interpreted its command line options, it changes
40576 uid and gid in the following cases:
40577
40578 .ilist
40579 .oindex "&%-C%&"
40580 .oindex "&%-D%&"
40581 If the &%-C%& option is used to specify an alternate configuration file, or if
40582 the &%-D%& option is used to define macro values for the configuration, and the
40583 calling process is not running as root, the uid and gid are changed to those of
40584 the calling process.
40585 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
40586 option may not be used at all.
40587 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
40588 can be supplied if the calling process is running as root, the Exim run-time
40589 user or CONFIGURE_OWNER, if defined.
40590 .next
40591 .oindex "&%-be%&"
40592 .oindex "&%-bf%&"
40593 .oindex "&%-bF%&"
40594 If the expansion test option (&%-be%&) or one of the filter testing options
40595 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
40596 calling process.
40597 .next
40598 If the process is not a daemon process or a queue runner process or a delivery
40599 process or a process for testing address routing (started with &%-bt%&), the
40600 uid and gid are changed to the Exim user and group. This means that Exim always
40601 runs under its own uid and gid when receiving messages. This also applies when
40602 testing address verification
40603 .oindex "&%-bv%&"
40604 .oindex "&%-bh%&"
40605 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
40606 option).
40607 .next
40608 For a daemon, queue runner, delivery, or address testing process, the uid
40609 remains as root at this stage, but the gid is changed to the Exim group.
40610 .endlist
40611
40612 The processes that initially retain root privilege behave as follows:
40613
40614 .ilist
40615 A daemon process changes the gid to the Exim group and the uid to the Exim
40616 user after setting up one or more listening sockets. The &[initgroups()]&
40617 function is called, so that if the Exim user is in any additional groups, they
40618 will be used during message reception.
40619 .next
40620 A queue runner process retains root privilege throughout its execution. Its
40621 job is to fork a controlled sequence of delivery processes.
40622 .next
40623 A delivery process retains root privilege throughout most of its execution,
40624 but any actual deliveries (that is, the transports themselves) are run in
40625 subprocesses which always change to a non-root uid and gid. For local
40626 deliveries this is typically the uid and gid of the owner of the mailbox; for
40627 remote deliveries, the Exim uid and gid are used. Once all the delivery
40628 subprocesses have been run, a delivery process changes to the Exim uid and gid
40629 while doing post-delivery tidying up such as updating the retry database and
40630 generating bounce and warning messages.
40631
40632 While the recipient addresses in a message are being routed, the delivery
40633 process runs as root. However, if a user's filter file has to be processed,
40634 this is done in a subprocess that runs under the individual user's uid and
40635 gid. A system filter is run as root unless &%system_filter_user%& is set.
40636 .next
40637 A process that is testing addresses (the &%-bt%& option) runs as root so that
40638 the routing is done in the same environment as a message delivery.
40639 .endlist
40640
40641
40642
40643
40644 .section "Running Exim without privilege" "SECTrunexiwitpri"
40645 .cindex "privilege, running without"
40646 .cindex "unprivileged running"
40647 .cindex "root privilege" "running without"
40648 Some installations like to run Exim in an unprivileged state for more of its
40649 operation, for added security. Support for this mode of operation is provided
40650 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40651 gid are changed to the Exim user and group at the start of a delivery process
40652 (and also queue runner and address testing processes). This means that address
40653 routing is no longer run as root, and the deliveries themselves cannot change
40654 to any other uid.
40655
40656 .cindex SIGHUP
40657 .cindex "daemon" "restarting"
40658 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40659 that the daemon can still be started in the usual way, and it can respond
40660 correctly to SIGHUP because the re-invocation regains root privilege.
40661
40662 An alternative approach is to make Exim setuid to the Exim user and also setgid
40663 to the Exim group. If you do this, the daemon must be started from a root
40664 process. (Calling Exim from a root process makes it behave in the way it does
40665 when it is setuid root.) However, the daemon cannot restart itself after a
40666 SIGHUP signal because it cannot regain privilege.
40667
40668 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40669 stops Exim from trying to re-invoke itself to do a delivery after a message has
40670 been received. Such a re-invocation is a waste of resources because it has no
40671 effect.
40672
40673 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40674 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40675 to the Exim user seems a clean approach, but there is one complication:
40676
40677 In this style of operation, Exim is running with the real uid and gid set to
40678 those of the calling process, and the effective uid/gid set to Exim's values.
40679 Ideally, any association with the calling process' uid/gid should be dropped,
40680 that is, the real uid/gid should be reset to the effective values so as to
40681 discard any privileges that the caller may have. While some operating systems
40682 have a function that permits this action for a non-root effective uid, quite a
40683 number of them do not. Because of this lack of standardization, Exim does not
40684 address this problem at this time.
40685
40686 For this reason, the recommended approach for &"mostly unprivileged"& running
40687 is to keep the Exim binary setuid to root, and to set
40688 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40689 be used in the most straightforward way.
40690
40691 If you configure Exim not to run delivery processes as root, there are a
40692 number of restrictions on what you can do:
40693
40694 .ilist
40695 You can deliver only as the Exim user/group. You should  explicitly use the
40696 &%user%& and &%group%& options to override routers or local transports that
40697 normally deliver as the recipient. This makes sure that configurations that
40698 work in this mode function the same way in normal mode. Any implicit or
40699 explicit specification of another user causes an error.
40700 .next
40701 Use of &_.forward_& files is severely restricted, such that it is usually
40702 not worthwhile to include them in the configuration.
40703 .next
40704 Users who wish to use &_.forward_& would have to make their home directory and
40705 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40706 and their equivalents in Exim filters, cannot be used. While they could be
40707 enabled in the Exim user's name, that would be insecure and not very useful.
40708 .next
40709 Unless the local user mailboxes are all owned by the Exim user (possible in
40710 some POP3 or IMAP-only environments):
40711
40712 .olist
40713 They must be owned by the Exim group and be writeable by that group. This
40714 implies you must set &%mode%& in the appendfile configuration, as well as the
40715 mode of the mailbox files themselves.
40716 .next
40717 You must set &%no_check_owner%&, since most or all of the files will not be
40718 owned by the Exim user.
40719 .next
40720 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40721 on a newly created mailbox when unprivileged. This also implies that new
40722 mailboxes need to be created manually.
40723 .endlist olist
40724 .endlist ilist
40725
40726
40727 These restrictions severely restrict what can be done in local deliveries.
40728 However, there are no restrictions on remote deliveries. If you are running a
40729 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40730 gives more security at essentially no cost.
40731
40732 If you are using the &%mua_wrapper%& facility (see chapter
40733 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40734
40735
40736
40737
40738 .section "Delivering to local files" "SECID271"
40739 Full details of the checks applied by &(appendfile)& before it writes to a file
40740 are given in chapter &<<CHAPappendfile>>&.
40741
40742
40743
40744 .section "Running local commands" "SECTsecconslocalcmds"
40745 .cindex "security" "local commands"
40746 .cindex "security" "command injection attacks"
40747 There are a number of ways in which an administrator can configure Exim to run
40748 commands based upon received, untrustworthy, data. Further, in some
40749 configurations a user who can control a &_.forward_& file can also arrange to
40750 run commands. Configuration to check includes, but is not limited to:
40751
40752 .ilist
40753 Use of &%use_shell%& in the pipe transport: various forms of shell command
40754 injection may be possible with this option present. It is dangerous and should
40755 be used only with considerable caution. Consider constraints which whitelist
40756 allowed characters in a variable which is to be used in a pipe transport that
40757 has &%use_shell%& enabled.
40758 .next
40759 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40760 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40761 &_.forward_& files in a redirect router. If Exim is running on a central mail
40762 hub to which ordinary users do not have shell access, but home directories are
40763 NFS mounted (for instance) then administrators should review the list of these
40764 forbid options available, and should bear in mind that the options that may
40765 need forbidding can change as new features are added between releases.
40766 .next
40767 The &%${run...}%& expansion item does not use a shell by default, but
40768 administrators can configure use of &_/bin/sh_& as part of the command.
40769 Such invocations should be viewed with prejudicial suspicion.
40770 .next
40771 Administrators who use embedded Perl are advised to explore how Perl's
40772 taint checking might apply to their usage.
40773 .next
40774 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40775 administrators are well advised to view its use with suspicion, in case (for
40776 instance) it allows a local-part to contain embedded Exim directives.
40777 .next
40778 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40779 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40780 each can reference arbitrary lists and files, rather than just being a list
40781 of opaque strings.
40782 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40783 real-world security vulnerabilities caused by its use with untrustworthy data
40784 injected in, for SQL injection attacks.
40785 Consider the use of the &%inlisti%& expansion condition instead.
40786 .endlist
40787
40788
40789
40790
40791 .section "Trust in configuration data" "SECTsecconfdata"
40792 .cindex "security" "data sources"
40793 .cindex "security" "regular expressions"
40794 .cindex "regular expressions" "security"
40795 .cindex "PCRE2" "security"
40796 If configuration data for Exim can come from untrustworthy sources, there
40797 are some issues to be aware of:
40798
40799 .ilist
40800 Use of &%${expand...}%& may provide a path for shell injection attacks.
40801 .next
40802 Letting untrusted data provide a regular expression is unwise.
40803 .next
40804 Using &%${match...}%& to apply a fixed regular expression against untrusted
40805 data may result in pathological behaviour within PCRE2.  Be aware of what
40806 "backtracking" means and consider options for being more strict with a regular
40807 expression. Avenues to explore include limiting what can match (avoiding &`.`&
40808 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
40809 possessive quantifiers or just not using regular expressions against untrusted
40810 data.
40811 .next
40812 It can be important to correctly use &%${quote:...}%&,
40813 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
40814 items to ensure that data is correctly constructed.
40815 .next
40816 Some lookups might return multiple results, even though normal usage is only
40817 expected to yield one result.
40818 .endlist
40819
40820
40821
40822
40823 .section "IPv4 source routing" "SECID272"
40824 .cindex "source routing" "in IP packets"
40825 .cindex "IP source routing"
40826 Many operating systems suppress IP source-routed packets in the kernel, but
40827 some cannot be made to do this, so Exim does its own check. It logs incoming
40828 IPv4 source-routed TCP calls, and then drops them. Things are all different in
40829 IPv6. No special checking is currently done.
40830
40831
40832
40833 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
40834 Support for these SMTP commands is disabled by default. If required, they can
40835 be enabled by defining suitable ACLs.
40836
40837
40838
40839
40840 .section "Privileged users" "SECID274"
40841 .cindex "trusted users"
40842 .cindex "admin user"
40843 .cindex "privileged user"
40844 .cindex "user" "trusted"
40845 .cindex "user" "admin"
40846 Exim recognizes two sets of users with special privileges. Trusted users are
40847 able to submit new messages to Exim locally, but supply their own sender
40848 addresses and information about a sending host. For other users submitting
40849 local messages, Exim sets up the sender address from the uid, and doesn't
40850 permit a remote host to be specified.
40851
40852 .oindex "&%-f%&"
40853 However, an untrusted user is permitted to use the &%-f%& command line option
40854 in the special form &%-f <>%& to indicate that a delivery failure for the
40855 message should not cause an error report. This affects the message's envelope,
40856 but it does not affect the &'Sender:'& header. Untrusted users may also be
40857 permitted to use specific forms of address with the &%-f%& option by setting
40858 the &%untrusted_set_sender%& option.
40859
40860 Trusted users are used to run processes that receive mail messages from some
40861 other mail domain and pass them on to Exim for delivery either locally, or over
40862 the Internet. Exim trusts a caller that is running as root, as the Exim user,
40863 as any user listed in the &%trusted_users%& configuration option, or under any
40864 group listed in the &%trusted_groups%& option.
40865
40866 Admin users are permitted to do things to the messages on Exim's queue. They
40867 can freeze or thaw messages, cause them to be returned to their senders, remove
40868 them entirely, or modify them in various ways. In addition, admin users can run
40869 the Exim monitor and see all the information it is capable of providing, which
40870 includes the contents of files on the spool.
40871
40872 .oindex "&%-M%&"
40873 .oindex "&%-q%&"
40874 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
40875 delivery of messages on its queue is restricted to admin users. This
40876 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
40877 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
40878 queue is also restricted to admin users. This restriction can be relaxed by
40879 setting &%no_queue_list_requires_admin%&.
40880
40881 Exim recognizes an admin user if the calling process is running as root or as
40882 the Exim user or if any of the groups associated with the calling process is
40883 the Exim group. It is not necessary actually to be running under the Exim
40884 group. However, if admin users who are not root or the Exim user are to access
40885 the contents of files on the spool via the Exim monitor (which runs
40886 unprivileged), Exim must be built to allow group read access to its spool
40887 files.
40888
40889 By default, regular users are trusted to perform basic testing and
40890 introspection commands, as themselves.  This setting can be tightened by
40891 setting the &%commandline_checks_require_admin%& option.
40892 This affects most of the checking options,
40893 such as &%-be%& and anything else &%-b*%&.
40894
40895
40896 .section "Spool files" "SECID275"
40897 .cindex "spool directory" "files"
40898 Exim's spool directory and everything it contains is owned by the Exim user and
40899 set to the Exim group. The mode for spool files is defined in the
40900 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
40901 any user who is a member of the Exim group can access these files.
40902
40903
40904
40905 .section "Use of argv[0]" "SECID276"
40906 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
40907 of specific strings, Exim assumes certain options. For example, calling Exim
40908 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
40909 to calling it with the option &%-bS%&. There are no security implications in
40910 this.
40911
40912
40913
40914 .section "Use of %f formatting" "SECID277"
40915 The only use made of &"%f"& by Exim is in formatting load average values. These
40916 are actually stored in integer variables as 1000 times the load average.
40917 Consequently, their range is limited and so therefore is the length of the
40918 converted output.
40919
40920
40921
40922 .section "Embedded Exim path" "SECID278"
40923 Exim uses its own path name, which is embedded in the code, only when it needs
40924 to re-exec in order to regain root privilege. Therefore, it is not root when it
40925 does so. If some bug allowed the path to get overwritten, it would lead to an
40926 arbitrary program's being run as exim, not as root.
40927
40928
40929
40930 .section "Dynamic module directory" "SECTdynmoddir"
40931 Any dynamically loadable modules must be installed into the directory
40932 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
40933 loading it.
40934
40935
40936 .section "Use of sprintf()" "SECID279"
40937 .cindex "&[sprintf()]&"
40938 A large number of occurrences of &"sprintf"& in the code are actually calls to
40939 &'string_sprintf()'&, a function that returns the result in malloc'd store.
40940 The intermediate formatting is done into a large fixed buffer by a function
40941 that runs through the format string itself, and checks the length of each
40942 conversion before performing it, thus preventing buffer overruns.
40943
40944 The remaining uses of &[sprintf()]& happen in controlled circumstances where
40945 the output buffer is known to be sufficiently long to contain the converted
40946 string.
40947
40948
40949
40950 .section "Use of debug_printf() and log_write()" "SECID280"
40951 Arbitrary strings are passed to both these functions, but they do their
40952 formatting by calling the function &'string_vformat()'&, which runs through
40953 the format string itself, and checks the length of each conversion.
40954
40955
40956
40957 .section "Use of strcat() and strcpy()" "SECID281"
40958 These are used only in cases where the output buffer is known to be large
40959 enough to hold the result.
40960 .ecindex IIDsecurcon
40961
40962
40963
40964
40965 . ////////////////////////////////////////////////////////////////////////////
40966 . ////////////////////////////////////////////////////////////////////////////
40967
40968 .chapter "Format of spool files" "CHAPspool"
40969 .scindex IIDforspo1 "format" "spool files"
40970 .scindex IIDforspo2 "spool directory" "format of files"
40971 .scindex IIDforspo3 "spool files" "format of"
40972 .cindex "spool files" "editing"
40973 A message on Exim's queue consists of two files, whose names are the message id
40974 followed by -D and -H, respectively. The data portion of the message is kept in
40975 the -D file on its own. The message's envelope, status, and headers are all
40976 kept in the -H file, whose format is described in this chapter. Each of these
40977 two files contains the final component of its own name as its first line. This
40978 is insurance against disk crashes where the directory is lost but the files
40979 themselves are recoverable.
40980
40981 The file formats may be changed, or new formats added, at any release.
40982 Spool files are not intended as an interface to other programs
40983 and should not be used as such.
40984
40985 Some people are tempted into editing -D files in order to modify messages. You
40986 need to be extremely careful if you do this; it is not recommended and you are
40987 on your own if you do it. Here are some of the pitfalls:
40988
40989 .ilist
40990 You must ensure that Exim does not try to deliver the message while you are
40991 fiddling with it. The safest way is to take out a write lock on the -D file,
40992 which is what Exim itself does, using &[fcntl()]&. If you update the file in
40993 place, the lock will be retained. If you write a new file and rename it, the
40994 lock will be lost at the instant of rename.
40995 .next
40996 .vindex "&$body_linecount$&"
40997 If you change the number of lines in the file, the value of
40998 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
40999 cause incomplete transmission of messages or undeliverable messages.
41000 .next
41001 If the message is in MIME format, you must take care not to break it.
41002 .next
41003 If the message is cryptographically signed, any change will invalidate the
41004 signature.
41005 .endlist
41006 All in all, modifying -D files is fraught with danger.
41007
41008 Files whose names end with -J may also be seen in the &_input_& directory (or
41009 its subdirectories when &%split_spool_directory%& is set). These are journal
41010 files, used to record addresses to which the message has been delivered during
41011 the course of a delivery attempt. If there are still undelivered recipients at
41012 the end, the -H file is updated, and the -J file is deleted. If, however, there
41013 is some kind of crash (for example, a power outage) before this happens, the -J
41014 file remains in existence. When Exim next processes the message, it notices the
41015 -J file and uses it to update the -H file before starting the next delivery
41016 attempt.
41017
41018 Files whose names end with -K or .eml may also be seen in the spool.
41019 These are temporaries used for DKIM or malware processing, when that is used.
41020 They should be tidied up by normal operations; any old ones are probably
41021 relics of crashes and can be removed.
41022
41023 .section "Format of the -H file" "SECID282"
41024 .cindex "uid (user id)" "in spool file"
41025 .cindex "gid (group id)" "in spool file"
41026 The second line of the -H file contains the login name for the uid of the
41027 process that called Exim to read the message, followed by the numerical uid and
41028 gid. For a locally generated message, this is normally the user who sent the
41029 message. For a message received over TCP/IP via the daemon, it is
41030 normally the Exim user.
41031
41032 The third line of the file contains the address of the message's sender as
41033 transmitted in the envelope, contained in angle brackets. The sender address is
41034 empty for bounce messages. For incoming SMTP mail, the sender address is given
41035 in the MAIL command. For locally generated mail, the sender address is
41036 created by Exim from the login name of the current user and the configured
41037 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
41038 leading &"From&~"& line if the caller is trusted, or if the supplied address is
41039 &"<>"& or an address that matches &%untrusted_set_senders%&.
41040
41041 The fourth line contains two numbers. The first is the time that the message
41042 was received, in the conventional Unix form &-- the number of seconds since the
41043 start of the epoch. The second number is a count of the number of messages
41044 warning of delayed delivery that have been sent to the sender.
41045
41046 There follow a number of lines starting with a hyphen.
41047 These contain variables, can appear in any
41048 order, and are omitted when not relevant.
41049
41050 If there is a second hyphen after the first,
41051 the corresponding data is tainted.
41052 If there is a value in parentheses, the data is quoted for a lookup.
41053
41054 The following word specifies a variable,
41055 and the remainder of the item depends on the variable.
41056
41057 .vlist
41058 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
41059 This item is obsolete, and is not generated from Exim release 4.61 onwards;
41060 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
41061 recognized, to provide backward compatibility. In the old format, a line of
41062 this form is present for every ACL variable that is not empty. The number
41063 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
41064 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
41065 the data string for the variable. The string itself starts at the beginning of
41066 the next line, and is followed by a newline character. It may contain internal
41067 newlines.
41068
41069 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
41070 A line of this form is present for every ACL connection variable that is
41071 defined. Note that there is a space between &%-aclc%& and the rest of the name.
41072 The length is the length of the data string for the variable. The string itself
41073 starts at the beginning of the next line, and is followed by a newline
41074 character. It may contain internal newlines.
41075
41076 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
41077 A line of this form is present for every ACL message variable that is defined.
41078 Note that there is a space between &%-aclm%& and the rest of the name. The
41079 length is the length of the data string for the variable. The string itself
41080 starts at the beginning of the next line, and is followed by a newline
41081 character. It may contain internal newlines.
41082
41083 .vitem "&%-active_hostname%&&~<&'hostname'&>"
41084 This is present if, when the message was received over SMTP, the value of
41085 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
41086
41087 .vitem &%-allow_unqualified_recipient%&
41088 This is present if unqualified recipient addresses are permitted in header
41089 lines (to stop such addresses from being qualified if rewriting occurs at
41090 transport time). Local messages that were input using &%-bnq%& and remote
41091 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
41092
41093 .vitem &%-allow_unqualified_sender%&
41094 This is present if unqualified sender addresses are permitted in header lines
41095 (to stop such addresses from being qualified if rewriting occurs at transport
41096 time). Local messages that were input using &%-bnq%& and remote messages from
41097 hosts that match &%sender_unqualified_hosts%& set this flag.
41098
41099 .vitem "&%-auth_id%&&~<&'text'&>"
41100 The id information for a message received on an authenticated SMTP connection
41101 &-- the value of the &$authenticated_id$& variable.
41102
41103 .vitem "&%-auth_sender%&&~<&'address'&>"
41104 The address of an authenticated sender &-- the value of the
41105 &$authenticated_sender$& variable.
41106
41107 .vitem "&%-body_linecount%&&~<&'number'&>"
41108 This records the number of lines in the body of the message, and is
41109 present unless &%-spool_file_wireformat%& is.
41110
41111 .vitem "&%-body_zerocount%&&~<&'number'&>"
41112 This records the number of binary zero bytes in the body of the message, and is
41113 present if the number is greater than zero.
41114
41115 .vitem &%-deliver_firsttime%&
41116 This is written when a new message is first added to the spool. When the spool
41117 file is updated after a deferral, it is omitted.
41118
41119 .vitem "&%-frozen%&&~<&'time'&>"
41120 .cindex "frozen messages" "spool data"
41121 The message is frozen, and the freezing happened at <&'time'&>.
41122
41123 .vitem "&%-helo_name%&&~<&'text'&>"
41124 This records the host name as specified by a remote host in a HELO or EHLO
41125 command.
41126
41127 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
41128 This records the IP address of the host from which the message was received and
41129 the remote port number that was used. It is omitted for locally generated
41130 messages.
41131
41132 .vitem "&%-host_auth%&&~<&'text'&>"
41133 If the message was received on an authenticated SMTP connection, this records
41134 the name of the authenticator &-- the value of the
41135 &$sender_host_authenticated$& variable.
41136
41137 .vitem &%-host_lookup_failed%&
41138 This is present if an attempt to look up the sending host's name from its IP
41139 address failed. It corresponds to the &$host_lookup_failed$& variable.
41140
41141 .vitem "&%-host_name%&&~<&'text'&>"
41142 .cindex "reverse DNS lookup"
41143 .cindex "DNS" "reverse lookup"
41144 This records the name of the remote host from which the message was received,
41145 if the host name was looked up from the IP address when the message was being
41146 received. It is not present if no reverse lookup was done.
41147
41148 .vitem "&%-ident%&&~<&'text'&>"
41149 For locally submitted messages, this records the login of the originating user,
41150 unless it was a trusted user and the &%-oMt%& option was used to specify an
41151 ident value. For messages received over TCP/IP, this records the ident string
41152 supplied by the remote host, if any.
41153
41154 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
41155 This records the IP address of the local interface and the port number through
41156 which a message was received from a remote host. It is omitted for locally
41157 generated messages.
41158
41159 .vitem &%-local%&
41160 The message is from a local sender.
41161
41162 .vitem &%-localerror%&
41163 The message is a locally-generated bounce message.
41164
41165 .vitem "&%-local_scan%&&~<&'string'&>"
41166 This records the data string that was returned by the &[local_scan()]& function
41167 when the message was received &-- the value of the &$local_scan_data$&
41168 variable. It is omitted if no data was returned.
41169
41170 .vitem &%-manual_thaw%&
41171 The message was frozen but has been thawed manually, that is, by an explicit
41172 Exim command rather than via the auto-thaw process.
41173
41174 .vitem &%-N%&
41175 A testing delivery process was started using the &%-N%& option to suppress any
41176 actual deliveries, but delivery was deferred. At any further delivery attempts,
41177 &%-N%& is assumed.
41178
41179 .vitem &%-received_protocol%&
41180 This records the value of the &$received_protocol$& variable, which contains
41181 the name of the protocol by which the message was received.
41182
41183 .vitem &%-sender_set_untrusted%&
41184 The envelope sender of this message was set by an untrusted local caller (used
41185 to ensure that the caller is displayed in queue listings).
41186
41187 .vitem "&%-spam_score_int%&&~<&'number'&>"
41188 If a message was scanned by SpamAssassin, this is present. It records the value
41189 of &$spam_score_int$&.
41190
41191 .vitem &%-spool_file_wireformat%&
41192 The -D file for this message is in wire-format (for ESMTP CHUNKING)
41193 rather than Unix-format.
41194 The line-ending is CRLF rather than newline.
41195 There is still, however, no leading-dot-stuffing.
41196
41197 .vitem &%-tls_certificate_verified%&
41198 A TLS certificate was received from the client that sent this message, and the
41199 certificate was verified by the server.
41200
41201 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
41202 When the message was received over an encrypted connection, this records the
41203 name of the cipher suite that was used.
41204
41205 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
41206 When the message was received over an encrypted connection, and a certificate
41207 was received from the client, this records the Distinguished Name from that
41208 certificate.
41209 .endlist
41210
41211 Following the options there is a list of those addresses to which the message
41212 is not to be delivered. This set of addresses is initialized from the command
41213 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
41214 is set; otherwise it starts out empty. Whenever a successful delivery is made,
41215 the address is added to this set. The addresses are kept internally as a
41216 balanced binary tree, and it is a representation of that tree which is written
41217 to the spool file. If an address is expanded via an alias or forward file, the
41218 original address is added to the tree when deliveries to all its child
41219 addresses are complete.
41220
41221 If the tree is empty, there is a single line in the spool file containing just
41222 the text &"XX"&. Otherwise, each line consists of two letters, which are either
41223 Y or N, followed by an address. The address is the value for the node of the
41224 tree, and the letters indicate whether the node has a left branch and/or a
41225 right branch attached to it, respectively. If branches exist, they immediately
41226 follow. Here is an example of a three-node tree:
41227 .code
41228 YY darcy@austen.fict.example
41229 NN alice@wonderland.fict.example
41230 NN editor@thesaurus.ref.example
41231 .endd
41232 After the non-recipients tree, there is a list of the message's recipients.
41233 This is a simple list, preceded by a count. It includes all the original
41234 recipients of the message, including those to whom the message has already been
41235 delivered. In the simplest case, the list contains one address per line. For
41236 example:
41237 .code
41238 4
41239 editor@thesaurus.ref.example
41240 darcy@austen.fict.example
41241 rdo@foundation
41242 alice@wonderland.fict.example
41243 .endd
41244 However, when a child address has been added to the top-level addresses as a
41245 result of the use of the &%one_time%& option on a &(redirect)& router, each
41246 line is of the following form:
41247 .display
41248 <&'top-level address'&> <&'errors_to address'&> &&&
41249   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
41250 .endd
41251 The 01 flag bit indicates the presence of the three other fields that follow
41252 the top-level address. Other bits may be used in future to support additional
41253 fields. The <&'parent number'&> is the offset in the recipients list of the
41254 original parent of the &"one time"& address. The first two fields are the
41255 envelope sender that is associated with this address and its length. If the
41256 length is zero, there is no special envelope sender (there are then two space
41257 characters in the line). A non-empty field can arise from a &(redirect)& router
41258 that has an &%errors_to%& setting.
41259
41260
41261 A blank line separates the envelope and status information from the headers
41262 which follow. A header may occupy several lines of the file, and to save effort
41263 when reading it in, each header is preceded by a number and an identifying
41264 character. The number is the number of characters in the header, including any
41265 embedded newlines and the terminating newline. The character is one of the
41266 following:
41267
41268 .table2 50pt
41269 .row <&'blank'&>         "header in which Exim has no special interest"
41270 .row &`B`&               "&'Bcc:'& header"
41271 .row &`C`&               "&'Cc:'& header"
41272 .row &`F`&               "&'From:'& header"
41273 .row &`I`&               "&'Message-id:'& header"
41274 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
41275 .row &`R`&               "&'Reply-To:'& header"
41276 .row &`S`&               "&'Sender:'& header"
41277 .row &`T`&               "&'To:'& header"
41278 .row &`*`&               "replaced or deleted header"
41279 .endtable
41280
41281 Deleted or replaced (rewritten) headers remain in the spool file for debugging
41282 purposes. They are not transmitted when the message is delivered. Here is a
41283 typical set of headers:
41284 .code
41285 111P Received: by hobbit.fict.example with local (Exim 4.00)
41286 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
41287 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
41288 038* X-rewrote-sender: bb@hobbit.fict.example
41289 042* From: Bilbo Baggins <bb@hobbit.fict.example>
41290 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
41291 099* To: alice@wonderland.fict.example, rdo@foundation,
41292 darcy@austen.fict.example, editor@thesaurus.ref.example
41293 104T To: alice@wonderland.fict.example, rdo@foundation.example,
41294 darcy@austen.fict.example, editor@thesaurus.ref.example
41295 038  Date: Fri, 11 May 2001 10:28:59 +0100
41296 .endd
41297 The asterisked headers indicate that the envelope sender, &'From:'& header, and
41298 &'To:'& header have been rewritten, the last one because routing expanded the
41299 unqualified domain &'foundation'&.
41300 .ecindex IIDforspo1
41301 .ecindex IIDforspo2
41302 .ecindex IIDforspo3
41303
41304 .section "Format of the -D file" "SECID282a"
41305 The data file is traditionally in Unix-standard format: lines are ended with
41306 an ASCII newline character.
41307 However, when the &%spool_wireformat%& main option is used some -D files
41308 can have an alternate format.
41309 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
41310 The -D file lines (not including the first name-component line) are
41311 suitable for direct copying to the wire when transmitting using the
41312 ESMTP CHUNKING option, meaning lower processing overhead.
41313 Lines are terminated with an ASCII CRLF pair.
41314 There is no dot-stuffing (and no dot-termination).
41315
41316 . ////////////////////////////////////////////////////////////////////////////
41317 . ////////////////////////////////////////////////////////////////////////////
41318
41319 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
41320          "DKIM, SPF, SRS and DMARC Support"
41321
41322 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
41323 .cindex "DKIM"
41324
41325 DKIM is a mechanism by which messages sent by some entity can be provably
41326 linked to a domain which that entity controls.  It permits reputation to
41327 be tracked on a per-domain basis, rather than merely upon source IP address.
41328 DKIM is documented in RFC 6376.
41329
41330 As DKIM relies on the message being unchanged in transit, messages handled
41331 by a mailing-list (which traditionally adds to the message) will not match
41332 any original DKIM signature.
41333
41334 DKIM support is compiled into Exim by default if TLS support is present.
41335 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
41336
41337 Exim's DKIM implementation allows for
41338 .olist
41339 Signing outgoing messages: This function is implemented in the SMTP transport.
41340 It can co-exist with all other Exim features
41341 (including transport filters)
41342 except cutthrough delivery.
41343 .next
41344 Verifying signatures in incoming messages: This is implemented by an additional
41345 ACL (acl_smtp_dkim), which can be called several times per message, with
41346 different signature contexts.
41347 .endlist
41348
41349 In typical Exim style, the verification implementation does not include any
41350 default "policy". Instead it enables you to build your own policy using
41351 Exim's standard controls.
41352
41353 Please note that verification of DKIM signatures in incoming mail is turned
41354 on by default for logging (in the <= line) purposes.
41355
41356 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
41357 When set, for each signature in incoming email,
41358 exim will log a line displaying the most important signature details, and the
41359 signature status. Here is an example (with line-breaks added for clarity):
41360 .code
41361 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
41362     d=facebookmail.com s=q1-2009b
41363     c=relaxed/relaxed a=rsa-sha1
41364     i=@facebookmail.com t=1252484542 [verification succeeded]
41365 .endd
41366
41367 You might want to turn off DKIM verification processing entirely for internal
41368 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41369 control modifier. This should typically be done in the RCPT ACL, at points
41370 where you accept mail from relay sources (internal hosts or authenticated
41371 senders).
41372
41373
41374 .subsection "Signing outgoing messages" SECDKIMSIGN
41375 .cindex DKIM signing
41376
41377 For signing to be usable you must have published a DKIM record in DNS.
41378 Note that RFC 8301 (which does not cover EC keys) says:
41379 .code
41380 rsa-sha1 MUST NOT be used for signing or verifying.
41381
41382 Signers MUST use RSA keys of at least 1024 bits for all keys.
41383 Signers SHOULD use RSA keys of at least 2048 bits.
41384 .endd
41385
41386 Note also that the key content (the 'p=' field)
41387 in the DNS record is different between RSA and EC keys;
41388 for the former it is the base64 of the ASN.1 for the RSA public key
41389 (equivalent to the private-key .pem with the header/trailer stripped)
41390 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41391
41392 Signing is enabled by setting private options on the SMTP transport.
41393 These options take (expandable) strings as arguments.
41394
41395 .option dkim_domain smtp "string list&!!" unset
41396 The domain(s) you want to sign with.
41397 After expansion, this can be a list.
41398 Each element in turn,
41399 lowercased,
41400 .vindex "&$dkim_domain$&"
41401 is put into the &%$dkim_domain%& expansion variable
41402 while expanding the remaining signing options.
41403 If it is empty after expansion, DKIM signing is not done,
41404 and no error will result even if &%dkim_strict%& is set.
41405
41406 .option dkim_selector smtp "string list&!!" unset
41407 This sets the key selector string.
41408 After expansion, which can use &$dkim_domain$&, this can be a list.
41409 Each element in turn is put in the expansion
41410 .vindex "&$dkim_selector$&"
41411 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41412 option along with &%$dkim_domain%&.
41413 If the option is empty after expansion, DKIM signing is not done for this domain,
41414 and no error will result even if &%dkim_strict%& is set.
41415
41416 To do, for example, dual-signing with RSA and EC keys
41417 this could be be used:
41418 .code
41419 dkim_selector = ec_sel : rsa_sel
41420 dkim_private_key = KEYS_DIR/$dkim_selector
41421 .endd
41422
41423 .option dkim_private_key smtp string&!! unset
41424 This sets the private key to use.
41425 You can use the &%$dkim_domain%& and
41426 &%$dkim_selector%& expansion variables to determine the private key to use.
41427 The result can either
41428 .ilist
41429 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41430 .next
41431 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41432 be a valid Ed25519 private key (same format as above)
41433 .next
41434 start with a slash, in which case it is treated as a file that contains
41435 the private key
41436 .next
41437 be "0", "false" or the empty string, in which case the message will not
41438 be signed. This case will not result in an error, even if &%dkim_strict%&
41439 is set.
41440 .endlist
41441
41442 To generate keys under OpenSSL:
41443 .code
41444 openssl genrsa -out dkim_rsa.private 2048
41445 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41446 .endd
41447 The result file from the first command should be retained, and
41448 this option set to use it.
41449 Take the base-64 lines from the output of the second command, concatenated,
41450 for the DNS TXT record.
41451 See section 3.6 of RFC6376 for the record specification.
41452
41453 Under GnuTLS:
41454 .code
41455 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41456 certtool --load-privkey=dkim_rsa.private --pubkey-info
41457 .endd
41458
41459 Note that RFC 8301 says:
41460 .code
41461 Signers MUST use RSA keys of at least 1024 bits for all keys.
41462 Signers SHOULD use RSA keys of at least 2048 bits.
41463 .endd
41464
41465 EC keys for DKIM are defined by RFC 8463.
41466 They are considerably smaller than RSA keys for equivalent protection.
41467 As they are a recent development, users should consider dual-signing
41468 (by setting a list of selectors, and an expansion for this option)
41469 for some transition period.
41470 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41471 for EC keys.
41472
41473 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41474 .code
41475 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41476 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41477 .endd
41478
41479 To produce the required public key value for a DNS record:
41480 .code
41481 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41482 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41483 .endd
41484
41485 Exim also supports an alternate format
41486 of Ed25519 keys in DNS which was a candidate during development
41487 of the standard, but not adopted.
41488 A future release will probably drop that support.
41489
41490 .option dkim_hash smtp string&!! sha256
41491 Can be set to any one of the supported hash methods, which are:
41492 .ilist
41493 &`sha1`& &-- should not be used, is old and insecure
41494 .next
41495 &`sha256`& &-- the default
41496 .next
41497 &`sha512`& &-- possibly more secure but less well supported
41498 .endlist
41499
41500 Note that RFC 8301 says:
41501 .code
41502 rsa-sha1 MUST NOT be used for signing or verifying.
41503 .endd
41504
41505 .option dkim_identity smtp string&!! unset
41506 If set after expansion, the value is used to set an "i=" tag in
41507 the signing header.  The DKIM standards restrict the permissible
41508 syntax of this optional tag to a mail address, with possibly-empty
41509 local part, an @, and a domain identical to or subdomain of the "d="
41510 tag value.  Note that Exim does not check the value.
41511
41512 .option dkim_canon smtp string&!! unset
41513 This option sets the canonicalization method used when signing a message.
41514 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41515 The option defaults to "relaxed" when unset. Note: the current implementation
41516 only supports signing with the same canonicalization method for both headers and body.
41517
41518 .option dkim_strict smtp string&!! unset
41519 This  option  defines  how  Exim  behaves  when  signing a message that
41520 should be signed fails for some reason.  When the expansion evaluates to
41521 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41522 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41523 variables here.
41524
41525 .option dkim_sign_headers smtp string&!! "see below"
41526 If set, this option must expand to a colon-separated
41527 list of header names.
41528 Headers with these names, or the absence or such a header, will be included
41529 in the message signature.
41530 When unspecified, the header names listed in RFC4871 will be used,
41531 whether or not each header is present in the message.
41532 The default list is available for the expansion in the macro
41533 &"_DKIM_SIGN_HEADERS"&
41534 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41535
41536 If a name is repeated, multiple headers by that name (or the absence thereof)
41537 will be signed.  The textually later headers in the headers part of the
41538 message are signed first, if there are multiples.
41539
41540 A name can be prefixed with either an &"="& or a &"+"& character.
41541 If an &"="& prefix is used, all headers that are present with this name
41542 will be signed.
41543 If a &"+"& prefix if used, all headers that are present with this name
41544 will be signed, and one signature added for a missing header with the
41545 name will be appended.
41546
41547 .option dkim_timestamps smtp integer&!! unset
41548 This option controls the inclusion of timestamp information in the signature.
41549 If not set, no such information will be included.
41550 Otherwise, must be an unsigned number giving an offset in seconds from the current time
41551 for the expiry tag
41552 (eg. 1209600 for two weeks);
41553 both creation (t=) and expiry (x=) tags will be included.
41554
41555 RFC 6376 lists these tags as RECOMMENDED.
41556
41557
41558 .subsection "Verifying DKIM signatures in incoming mail" SECDKIMVFY
41559 .cindex DKIM verification
41560
41561 Verification of DKIM signatures in SMTP incoming email is done for all
41562 messages for which an ACL control &%dkim_disable_verify%& has not been set.
41563 .cindex DKIM "selecting signature algorithms"
41564 Individual classes of signature algorithm can be ignored by changing
41565 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
41566 The &%dkim_verify_minimal%& option can be set to cease verification
41567 processing for a message once the first passing signature is found.
41568
41569 .cindex authentication "expansion item"
41570 Performing verification sets up information used by the
41571 &%authresults%& expansion item.
41572
41573 For most purposes the default option settings suffice and the remainder
41574 of this section can be ignored.
41575
41576 The results of verification are made available to the
41577 &%acl_smtp_dkim%& ACL, which can examine and modify them.
41578 A missing ACL definition defaults to accept.
41579 By default, the ACL is called once for each
41580 syntactically(!) correct signature in the incoming message.
41581 If any ACL call does not accept, the message is not accepted.
41582 If a cutthrough delivery was in progress for the message, that is
41583 summarily dropped (having wasted the transmission effort).
41584
41585 To evaluate the verification result in the ACL
41586 a large number of expansion variables
41587 containing the signature status and its details are set up during the
41588 runtime of the ACL.
41589
41590 Calling the ACL only for existing signatures is not sufficient to build
41591 more advanced policies. For that reason, the main option
41592 &%dkim_verify_signers%&, and an expansion variable
41593 &%$dkim_signers%& exist.
41594
41595 The main option &%dkim_verify_signers%& can be set to a colon-separated
41596 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
41597 called. It is expanded when the message has been received. At this point,
41598 the expansion variable &%$dkim_signers%& already contains a colon-separated
41599 list of signer domains and identities for the message. When
41600 &%dkim_verify_signers%& is not specified in the main configuration,
41601 it defaults as:
41602 .code
41603 dkim_verify_signers = $dkim_signers
41604 .endd
41605 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
41606 DKIM signature in the message. Current DKIM verifiers may want to explicitly
41607 call the ACL for known domains or identities. This would be achieved as follows:
41608 .code
41609 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
41610 .endd
41611 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
41612 and "ebay.com", plus all domains and identities that have signatures in the message.
41613 You can also be more creative in constructing your policy. For example:
41614 .code
41615 dkim_verify_signers = $sender_address_domain:$dkim_signers
41616 .endd
41617
41618 If a domain or identity is listed several times in the (expanded) value of
41619 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
41620
41621 Note that if the option is set using untrustworthy data
41622 (such as the From: header)
41623 care should be taken to force lowercase for domains
41624 and for the domain part if identities.
41625 The default setting can be regarded as trustworthy in this respect.
41626
41627 If multiple signatures match a domain (or identity), the ACL is called once
41628 for each matching signature.
41629
41630
41631 Inside the DKIM ACL, the following expansion variables are
41632 available (from most to least important):
41633
41634
41635 .vlist
41636 .vitem &%$dkim_cur_signer%&
41637 The signer that is being evaluated in this ACL run. This can be a domain or
41638 an identity. This is one of the list items from the expanded main option
41639 &%dkim_verify_signers%& (see above).
41640
41641 .vitem &%$dkim_verify_status%&
41642 Within the DKIM ACL,
41643 a string describing the general status of the signature. One of
41644 .ilist
41645 &%none%&: There is no signature in the message for the current domain or
41646 identity (as reflected by &%$dkim_cur_signer%&).
41647 .next
41648 &%invalid%&: The signature could not be verified due to a processing error.
41649 More detail is available in &%$dkim_verify_reason%&.
41650 .next
41651 &%fail%&: Verification of the signature failed.  More detail is
41652 available in &%$dkim_verify_reason%&.
41653 .next
41654 &%pass%&: The signature passed verification. It is valid.
41655 .endlist
41656
41657 This variable can be overwritten using an ACL 'set' modifier.
41658 This might, for instance, be done to enforce a policy restriction on
41659 hash-method or key-size:
41660 .code
41661   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41662        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41663        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41664                                   {< {$dkim_key_length}{1024}}}}
41665        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41666        set dkim_verify_status = fail
41667        set dkim_verify_reason = hash too weak or key too short
41668 .endd
41669
41670 So long as a DKIM ACL is defined (it need do no more than accept),
41671 after all the DKIM ACL runs have completed, the value becomes a
41672 colon-separated list of the values after each run.
41673 This is maintained for the mime, prdr and data ACLs.
41674
41675 .vitem &%$dkim_verify_reason%&
41676 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41677 "fail" or "invalid". One of
41678 .ilist
41679 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41680 key for the domain could not be retrieved. This may be a temporary problem.
41681 .next
41682 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41683 record for the domain is syntactically invalid.
41684 .next
41685 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41686 body hash does not match the one specified in the signature header. This
41687 means that the message body was modified in transit.
41688 .next
41689 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41690 could not be verified. This may mean that headers were modified,
41691 re-written or otherwise changed in a way which is incompatible with
41692 DKIM verification. It may of course also mean that the signature is forged.
41693 .endlist
41694
41695 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41696
41697 .vitem &%$dkim_domain%&
41698 The signing domain. IMPORTANT: This variable is only populated if there is
41699 an actual signature in the message for the current domain or identity (as
41700 reflected by &%$dkim_cur_signer%&).
41701
41702 .vitem &%$dkim_identity%&
41703 The signing identity, if present. IMPORTANT: This variable is only populated
41704 if there is an actual signature in the message for the current domain or
41705 identity (as reflected by &%$dkim_cur_signer%&).
41706
41707 .vitem &%$dkim_selector%&
41708 The key record selector string.
41709
41710 .vitem &%$dkim_algo%&
41711 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41712 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41713 may also be 'ed25519-sha256'.
41714 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41715 for EC keys.
41716
41717 Note that RFC 8301 says:
41718 .code
41719 rsa-sha1 MUST NOT be used for signing or verifying.
41720
41721 DKIM signatures identified as having been signed with historic
41722 algorithms (currently, rsa-sha1) have permanently failed evaluation
41723 .endd
41724
41725 To enforce this you must either have a DKIM ACL which checks this variable
41726 and overwrites the &$dkim_verify_status$& variable as discussed above,
41727 or have set the main option &%dkim_verify_hashes%& to exclude
41728 processing of such signatures.
41729
41730 .vitem &%$dkim_canon_body%&
41731 The body canonicalization method. One of 'relaxed' or 'simple'.
41732
41733 .vitem &%$dkim_canon_headers%&
41734 The header canonicalization method. One of 'relaxed' or 'simple'.
41735
41736 .vitem &%$dkim_copiedheaders%&
41737 A transcript of headers and their values which are included in the signature
41738 (copied from the 'z=' tag of the signature).
41739 Note that RFC6376 requires that verification fail if the From: header is
41740 not included in the signature.  Exim does not enforce this; sites wishing
41741 strict enforcement should code the check explicitly.
41742
41743 .vitem &%$dkim_bodylength%&
41744 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41745 limit was set by the signer, "9999999999999" is returned. This makes sure
41746 that this variable always expands to an integer value.
41747 &*Note:*& The presence of the signature tag specifying a signing body length
41748 is one possible route to spoofing of valid DKIM signatures.
41749 A paranoid implementation might wish to regard signature where this variable
41750 shows less than the "no limit" return as being invalid.
41751
41752 .vitem &%$dkim_created%&
41753 UNIX timestamp reflecting the date and time when the signature was created.
41754 When this was not specified by the signer, "0" is returned.
41755
41756 .vitem &%$dkim_expires%&
41757 UNIX timestamp reflecting the date and time when the signer wants the
41758 signature to be treated as "expired". When this was not specified by the
41759 signer, "9999999999999" is returned. This makes it possible to do useful
41760 integer size comparisons against this value.
41761 Note that Exim does not check this value.
41762
41763 .vitem &%$dkim_headernames%&
41764 A colon-separated list of names of headers included in the signature.
41765
41766 .vitem &%$dkim_key_testing%&
41767 "1" if the key record has the "testing" flag set, "0" if not.
41768
41769 .vitem &%$dkim_key_nosubdomains%&
41770 "1" if the key record forbids subdomaining, "0" otherwise.
41771
41772 .vitem &%$dkim_key_srvtype%&
41773 Service type (tag s=) from the key record. Defaults to "*" if not specified
41774 in the key record.
41775
41776 .vitem &%$dkim_key_granularity%&
41777 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41778 in the key record.
41779
41780 .vitem &%$dkim_key_notes%&
41781 Notes from the key record (tag n=).
41782
41783 .vitem &%$dkim_key_length%&
41784 Number of bits in the key.
41785 Valid only once the key is loaded, which is at the time the header signature
41786 is verified, which is after the body hash is.
41787
41788 Note that RFC 8301 says:
41789 .code
41790 Verifiers MUST NOT consider signatures using RSA keys of
41791 less than 1024 bits as valid signatures.
41792 .endd
41793
41794 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
41795 option.
41796
41797 .endlist
41798
41799 In addition, two ACL conditions are provided:
41800
41801 .vlist
41802 .vitem &%dkim_signers%&
41803 ACL condition that checks a colon-separated list of domains or identities
41804 for a match against the domain or identity that the ACL is currently verifying
41805 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
41806 verb to a group of domains or identities. For example:
41807
41808 .code
41809 # Warn when Mail purportedly from GMail has no gmail signature
41810 warn sender_domains = gmail.com
41811      dkim_signers = gmail.com
41812      dkim_status = none
41813      log_message = GMail sender without gmail.com DKIM signature
41814 .endd
41815
41816 Note that the above does not check for a total lack of DKIM signing;
41817 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
41818
41819 .vitem &%dkim_status%&
41820 ACL condition that checks a colon-separated list of possible DKIM verification
41821 results against the actual result of verification. This is typically used
41822 to restrict an ACL verb to a list of verification outcomes, for example:
41823
41824 .code
41825 deny sender_domains = paypal.com:paypal.de
41826      dkim_signers = paypal.com:paypal.de
41827      dkim_status = none:invalid:fail
41828      message = Mail from Paypal with invalid/missing signature
41829 .endd
41830
41831 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
41832 see the documentation of the &%$dkim_verify_status%& expansion variable above
41833 for more information of what they mean.
41834 .endlist
41835
41836
41837
41838
41839 .section "SPF (Sender Policy Framework)" SECSPF
41840 .cindex SPF verification
41841
41842 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
41843 messages with its domain in the envelope from, documented by RFC 7208.
41844 For more information on SPF see &url(http://www.open-spf.org), a static copy of
41845 the &url(http://openspf.org).
41846 . --- 2019-10-28: still not https, open-spf.org is told to be a
41847 . --- web-archive copy of the now dead openspf.org site
41848 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
41849 . --- discussion.
41850
41851 Messages sent by a system not authorised will fail checking of such assertions.
41852 This includes retransmissions done by traditional forwarders.
41853
41854 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
41855 &_Local/Makefile_&.  The support uses the &_libspf2_& library
41856 &url(https://www.libspf2.org/).
41857 There is no Exim involvement in the transmission of messages;
41858 publishing certain DNS records is all that is required.
41859
41860 For verification, an ACL condition and an expansion lookup are provided.
41861 .cindex authentication "expansion item"
41862 Performing verification sets up information used by the
41863 &%authresults%& expansion item.
41864
41865
41866 .cindex SPF "ACL condition"
41867 .cindex ACL "spf condition"
41868 The ACL condition "spf" can be used at or after the MAIL ACL.
41869 It takes as an argument a list of strings giving the outcome of the SPF check,
41870 and will succeed for any matching outcome.
41871 Valid strings are:
41872 .vlist
41873 .vitem &%pass%&
41874 The SPF check passed, the sending host is positively verified by SPF.
41875
41876 .vitem &%fail%&
41877 The SPF check failed, the sending host is NOT allowed to send mail for the
41878 domain in the envelope-from address.
41879
41880 .vitem &%softfail%&
41881 The SPF check failed, but the queried domain can't absolutely confirm that this
41882 is a forgery.
41883
41884 .vitem &%none%&
41885 The queried domain does not publish SPF records.
41886
41887 .vitem &%neutral%&
41888 The SPF check returned a "neutral" state.  This means the queried domain has
41889 published a SPF record, but wants to allow outside servers to send mail under
41890 its domain as well.  This should be treated like "none".
41891
41892 .vitem &%permerror%&
41893 This indicates a syntax error in the SPF record of the queried domain.
41894 You may deny messages when this occurs.
41895
41896 .vitem &%temperror%&
41897 This indicates a temporary error during all processing, including Exim's
41898 SPF processing.  You may defer messages when this occurs.
41899
41900 .vitem &%invalid%&
41901 There was an error during processing of the SPF lookup
41902 .endlist
41903
41904 You can prefix each string with an exclamation mark to  invert
41905 its meaning,  for example  "!fail" will  match all  results but
41906 "fail".  The  string  list is  evaluated  left-to-right,  in a
41907 short-circuit fashion.
41908
41909 Example:
41910 .code
41911 deny spf = fail
41912      message = $sender_host_address is not allowed to send mail from \
41913                ${if def:sender_address_domain \
41914                     {$sender_address_domain}{$sender_helo_name}}.  \
41915                Please see http://www.open-spf.org/Why;\
41916                identity=${if def:sender_address_domain \
41917                              {$sender_address}{$sender_helo_name}};\
41918                ip=$sender_host_address
41919 .endd
41920
41921 Note: The above mentioned URL may not be as helpful as expected. You are
41922 encouraged to replace the link with a link to a site with more
41923 explanations.
41924
41925 When the spf condition has run, it sets up several expansion
41926 variables:
41927
41928 .cindex SPF "verification variables"
41929 .vlist
41930 .vitem &$spf_header_comment$&
41931 .vindex &$spf_header_comment$&
41932   This contains a human-readable string describing the outcome
41933   of the SPF check. You can add it to a custom header or use
41934   it for logging purposes.
41935
41936 .vitem &$spf_received$&
41937 .vindex &$spf_received$&
41938   This contains a complete Received-SPF: header (name and
41939   content) that can be added to the message. Please note that
41940   according to the SPF draft, this header must be added at the
41941   top of the header list, i.e. with
41942 .code
41943 add_header = :at_start:$spf_received
41944 .endd
41945   See section &<<SECTaddheadacl>>& for further details.
41946
41947   Note: in case of "Best-guess" (see below), the convention is
41948   to put this string in a header called X-SPF-Guess: instead.
41949
41950 .vitem &$spf_result$&
41951 .vindex &$spf_result$&
41952   This contains the outcome of the SPF check in string form,
41953   currently one of pass, fail, softfail, none, neutral, permerror,
41954   temperror, or &"(invalid)"&.
41955
41956 .vitem &$spf_result_guessed$&
41957 .vindex &$spf_result_guessed$&
41958   This boolean is true only if a best-guess operation was used
41959   and required in order to obtain a result.
41960
41961 .vitem &$spf_smtp_comment$&
41962 .vindex &$spf_smtp_comment$&
41963 .vindex &%spf_smtp_comment_template%&
41964   This contains a string that can be used in a SMTP response
41965   to the calling party. Useful for "fail".
41966   The string is generated by the SPF library from the template configured in the main config
41967   option &%spf_smtp_comment_template%&.
41968 .endlist
41969
41970
41971 .cindex SPF "ACL condition"
41972 .cindex ACL "spf_guess condition"
41973 .cindex SPF "best guess"
41974 In addition to SPF, you can also perform checks for so-called
41975 "Best-guess".  Strictly speaking, "Best-guess" is not standard
41976 SPF, but it is supported by the same framework that enables SPF
41977 capability.
41978 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
41979 for a description of what it means.
41980 . --- 2019-10-28: still not https:
41981
41982 To access this feature, simply use the spf_guess condition in place
41983 of the spf one.  For example:
41984
41985 .code
41986 deny spf_guess = fail
41987      message = $sender_host_address doesn't look trustworthy to me
41988 .endd
41989
41990 In case you decide to reject messages based on this check, you
41991 should note that although it uses the same framework, "Best-guess"
41992 is not SPF, and therefore you should not mention SPF at all in your
41993 reject message.
41994
41995 When the spf_guess condition has run, it sets up the same expansion
41996 variables as when spf condition is run, described above.
41997
41998 Additionally, since Best-guess is not standardized, you may redefine
41999 what "Best-guess" means to you by redefining the main configuration
42000 &%spf_guess%& option.
42001 For example, the following:
42002
42003 .code
42004 spf_guess = v=spf1 a/16 mx/16 ptr ?all
42005 .endd
42006
42007 would relax host matching rules to a broader network range.
42008
42009
42010 .cindex SPF "lookup expansion"
42011 .cindex lookup spf
42012 A lookup expansion is also available. It takes an email
42013 address as the key and an IP address
42014 (v4 or v6)
42015 as the database:
42016
42017 .code
42018   ${lookup {username@domain} spf {ip.ip.ip.ip}}
42019 .endd
42020
42021 The lookup will return the same result strings as can appear in
42022 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
42023
42024
42025
42026
42027
42028 .subsection "SRS (Sender Rewriting Scheme)" SECTSRS
42029 .cindex SRS "sender rewriting scheme"
42030
42031 SRS can be used to modify sender addresses when forwarding so that
42032 SPF verification does not object to them.
42033 It operates by encoding the original envelope sender in a new
42034 sender local part and using a domain run by the forwarding site
42035 as the new domain for the sender.  Any DSN message should be returned
42036 to this new sender at the forwarding site, which can extract the
42037 original sender from the coded local part and forward the DSN to
42038 the originator.
42039
42040 This is a way of avoiding the breakage that SPF does to forwarding.
42041 The constructed local-part will be longer than the original,
42042 leading to possible problems with very long addresses.
42043 The changing of the sender address also hinders the tracing of mail
42044 problems.
42045
42046 Exim can be built to include native SRS support.  To do this
42047 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
42048 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
42049 will be defined.
42050 The support is limited to SRS0-encoding; SRS1 is not supported.
42051
42052 .cindex SRS excoding
42053 To encode an address use this expansion item:
42054 .vlist
42055 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
42056 .cindex "&%srs_encode%& expansion item"
42057 .cindex SRS "expansion item"
42058 The first argument should be a secret known and used by all systems
42059 handling the recipient domain for the original message.
42060 There is no need to periodically change this key; a timestamp is also
42061 encoded.
42062 The second argument should be given as the envelope sender address before this
42063 encoding operation.
42064 If this value is empty the the expansion result will be empty.
42065 The third argument should be the recipient domain of the message when
42066 it arrived at this system.
42067 .endlist
42068
42069 .cindex SRS decoding
42070 To decode an address use this expansion condition:
42071 .vlist
42072 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
42073 The first argument should be the recipient local prt as is was received.
42074 The second argument is the site secret.
42075
42076 If the messages is not for an SRS-encoded recipient the condition will
42077 return false.  If it is, the condition will return true and the variable
42078 &$srs_recipient$& will be set to the decoded (original) value.
42079 .endlist
42080
42081 Example usage:
42082 .code
42083   #macro
42084   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
42085
42086   #routers
42087
42088   outbound:
42089     driver =    dnslookup
42090     # if outbound, and forwarding has been done, use an alternate transport
42091     domains =   ! +my_domains
42092     transport = ${if eq {$local_part@$domain} \
42093                         {$original_local_part@$original_domain} \
42094                      {remote_smtp} {remote_forwarded_smtp}}
42095
42096   inbound_srs:
42097     driver =    redirect
42098     senders =   :
42099     domains =   +my_domains
42100     # detect inbound bounces which are SRS'd, and decode them
42101     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
42102     data =      $srs_recipient
42103
42104   inbound_srs_failure:
42105     driver =    redirect
42106     senders =   :
42107     domains =   +my_domains
42108     # detect inbound bounces which look SRS'd but are invalid
42109     condition = ${if inbound_srs {$local_part} {}}
42110     allow_fail
42111     data =      :fail: Invalid SRS recipient address
42112
42113   #... further routers here
42114
42115
42116   # transport; should look like the non-forward outbound
42117   # one, plus the max_rcpt and return_path options
42118   remote_forwarded_smtp:
42119     driver =              smtp
42120     # modify the envelope from, for mails that we forward
42121     max_rcpt =            1
42122     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
42123 .endd
42124
42125
42126
42127
42128
42129 .section DMARC SECDMARC
42130 .cindex DMARC verification
42131
42132 DMARC combines feedback from SPF, DKIM, and header From: in order
42133 to attempt to provide better indicators of the authenticity of an
42134 email.  This document does not explain the fundamentals; you
42135 should read and understand how it works by visiting the website at
42136 &url(http://www.dmarc.org/).
42137
42138 If Exim is built with DMARC support,
42139 the libopendmarc library is used.
42140
42141 For building Exim yourself, obtain the library from
42142 &url(http://sourceforge.net/projects/opendmarc/)
42143 to obtain a copy, or find it in your favorite package
42144 repository.  You will need to attend to the local/Makefile feature
42145 SUPPORT_DMARC and the associated LDFLAGS addition.
42146 This description assumes
42147 that headers will be in /usr/local/include, and that the libraries
42148 are in /usr/local/lib.
42149
42150 .subsection Configuration SSECDMARCCONFIG
42151 .cindex DMARC configuration
42152
42153 There are three main-configuration options:
42154 .cindex DMARC "configuration options"
42155
42156 The &%dmarc_tld_file%& option
42157 .oindex &%dmarc_tld_file%&
42158 defines the location of a text file of valid
42159 top level domains the opendmarc library uses
42160 during domain parsing. Maintained by Mozilla,
42161 the most current version can be downloaded
42162 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
42163 See also the util/renew-opendmarc-tlds.sh script.
42164 The default for the option is unset.
42165 If not set, DMARC processing is disabled.
42166
42167
42168 The &%dmarc_history_file%& option, if set
42169 .oindex &%dmarc_history_file%&
42170 defines the location of a file to log results
42171 of dmarc verification on inbound emails. The
42172 contents are importable by the opendmarc tools
42173 which will manage the data, send out DMARC
42174 reports, and expire the data. Make sure the
42175 directory of this file is writable by the user
42176 exim runs as.
42177 The default is unset.
42178
42179 The &%dmarc_forensic_sender%& option
42180 .oindex &%dmarc_forensic_sender%&
42181 defines an alternate email address to use when sending a
42182 forensic report detailing alignment failures
42183 if a sender domain's dmarc record specifies it
42184 and you have configured Exim to send them.
42185 If set, this is expanded and used for the
42186 From: header line; the address is extracted
42187 from it and used for the envelope from.
42188 If not set (the default), the From: header is expanded from
42189 the dsn_from option, and <> is used for the
42190 envelope from.
42191
42192 .subsection Controls SSECDMARCCONTROLS
42193 .cindex DMARC controls
42194
42195 By default, the DMARC processing will run for any remote,
42196 non-authenticated user.  It makes sense to only verify DMARC
42197 status of messages coming from remote, untrusted sources.  You can
42198 use standard conditions such as hosts, senders, etc, to decide that
42199 DMARC verification should *not* be performed for them and disable
42200 DMARC with an ACL control modifier:
42201 .code
42202   control = dmarc_disable_verify
42203 .endd
42204 A DMARC record can also specify a "forensic address", which gives
42205 exim an email address to submit reports about failed alignment.
42206 Exim does not do this by default because in certain conditions it
42207 results in unintended information leakage (what lists a user might
42208 be subscribed to, etc).  You must configure exim to submit forensic
42209 reports to the owner of the domain.  If the DMARC record contains a
42210 forensic address and you specify the control statement below, then
42211 exim will send these forensic emails.  It is also advised that you
42212 configure a &%dmarc_forensic_sender%& because the default sender address
42213 construction might be inadequate.
42214 .code
42215   control = dmarc_enable_forensic
42216 .endd
42217 (AGAIN: You can choose not to send these forensic reports by simply
42218 not putting the dmarc_enable_forensic control line at any point in
42219 your exim config.  If you don't tell exim to send them, it will not
42220 send them.)
42221
42222 There are no options to either control.  Both must appear before
42223 the DATA acl.
42224
42225 .subsection ACL SSECDMARCACL
42226 .cindex DMARC "ACL condition"
42227
42228 DMARC checks can be run on incoming SMTP  messages by using the
42229 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
42230 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
42231 condition.  Putting this condition in the ACLs is required in order
42232 for a DMARC check to actually occur.  All of the variables are set
42233 up before the DATA ACL, but there is no actual DMARC check that
42234 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
42235
42236 The &"dmarc_status"& condition takes a list of strings on its
42237 right-hand side.  These strings describe recommended action based
42238 on the DMARC check.  To understand what the policy recommendations
42239 mean, refer to the DMARC website above.  Valid strings are:
42240 .itable none 0 0 2 20* left 80* left
42241 .irow &'accept'&        "The DMARC check passed and the library recommends accepting the email"
42242 .irow &'reject'&        "The DMARC check failed and the library recommends rejecting the email"
42243 .irow &'quarantine'&    "The DMARC check failed and the library recommends keeping it for further inspection"
42244 .irow &'none'&          "The DMARC check passed and the library recommends no specific action, neutral"
42245 .irow &'norecord'&      "No policy section in the DMARC record for this RFC5322.From field"
42246 .irow &'nofrom'&        "Unable to determine the domain of the sender"
42247 .irow &'temperror'&     "Library error or dns error"
42248 .irow &'off'&           "The DMARC check was disabled for this email"
42249 .endtable
42250 You can prefix each string with an exclamation mark to invert its
42251 meaning, for example "!accept" will match all results but
42252 "accept".  The string list is evaluated left-to-right in a
42253 short-circuit fashion.  When a string matches the outcome of the
42254 DMARC check, the condition succeeds.  If none of the listed
42255 strings matches the outcome of the DMARC check, the condition
42256 fails.
42257
42258 Of course, you can also use any other lookup method that Exim
42259 supports, including LDAP, Postgres, MySQL, etc, as long as the
42260 result is a list of colon-separated strings.
42261
42262 Performing the check sets up information used by the
42263 &%authresults%& expansion item.
42264
42265 Several expansion variables are set before the DATA ACL is
42266 processed, and you can use them in this ACL.  The following
42267 expansion variables are available:
42268
42269 .vlist
42270 .vitem &$dmarc_status$&
42271 .vindex &$dmarc_status$&
42272 .cindex DMARC result
42273 A one word status indicating what the DMARC library
42274 thinks of the email.  It is a combination of the results of
42275 DMARC record lookup and the SPF/DKIM/DMARC processing results
42276 (if a DMARC record was found).  The actual policy declared
42277 in the DMARC record is in a separate expansion variable.
42278
42279 .vitem &$dmarc_status_text$&
42280 .vindex &$dmarc_status_text$&
42281 Slightly longer, human readable status.
42282
42283 .vitem &$dmarc_used_domain$&
42284 .vindex &$dmarc_used_domain$&
42285 The domain which DMARC used to look up the DMARC policy record.
42286
42287 .vitem &$dmarc_domain_policy$&
42288 .vindex &$dmarc_domain_policy$&
42289 The policy declared in the DMARC record.  Valid values
42290 are "none", "reject" and "quarantine".  It is blank when there
42291 is any error, including no DMARC record.
42292 .endlist
42293
42294 .subsection Logging SSECDMARCLOGGING
42295 .cindex DMARC logging
42296
42297 By default, Exim's DMARC configuration is intended to be
42298 non-intrusive and conservative.  To facilitate this, Exim will not
42299 create any type of logging files without explicit configuration by
42300 you, the admin.  Nor will Exim send out any emails/reports about
42301 DMARC issues without explicit configuration by you, the admin (other
42302 than typical bounce messages that may come about due to ACL
42303 processing or failure delivery issues).
42304
42305 In order to log statistics suitable to be imported by the opendmarc
42306 tools, you need to:
42307 .ilist
42308 Configure the global option &%dmarc_history_file%&
42309 .next
42310 Configure cron jobs to call the appropriate opendmarc history
42311 import scripts and truncating the dmarc_history_file
42312 .endlist
42313
42314 In order to send forensic reports, you need to:
42315 .ilist
42316 Configure the global option &%dmarc_forensic_sender%&
42317 .next
42318 Configure, somewhere before the DATA ACL, the control option to
42319 enable sending DMARC forensic reports
42320 .endlist
42321
42322 .subsection Example SSECDMARCEXAMPLE
42323 .cindex DMARC example
42324
42325 Example usage:
42326 .code
42327 (RCPT ACL)
42328   warn    domains        = +local_domains
42329           hosts          = +local_hosts
42330           control        = dmarc_disable_verify
42331
42332   warn    !domains       = +screwed_up_dmarc_records
42333           control        = dmarc_enable_forensic
42334
42335   warn    condition      = (lookup if destined to mailing list)
42336           set acl_m_mailing_list = 1
42337
42338 (DATA ACL)
42339   warn    dmarc_status   = accept : none : off
42340           !authenticated = *
42341           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
42342
42343   warn    dmarc_status   = !accept
42344           !authenticated = *
42345           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
42346
42347   warn    dmarc_status   = quarantine
42348           !authenticated = *
42349           set $acl_m_quarantine = 1
42350           # Do something in a transport with this flag variable
42351
42352   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
42353           condition      = ${if eq{$acl_m_mailing_list}{1}}
42354           message        = Messages from $dmarc_used_domain break mailing lists
42355
42356   deny    dmarc_status   = reject
42357           !authenticated = *
42358           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
42359
42360   warn    add_header     = :at_start:${authresults {$primary_hostname}}
42361 .endd
42362
42363
42364
42365
42366
42367 . ////////////////////////////////////////////////////////////////////////////
42368 . ////////////////////////////////////////////////////////////////////////////
42369
42370 .chapter "Proxies" "CHAPproxies" &&&
42371          "Proxy support"
42372 .cindex "proxy support"
42373 .cindex "proxy" "access via"
42374
42375 A proxy is an intermediate system through which communication is passed.
42376 Proxies may provide a security, availability or load-distribution function.
42377
42378
42379 .section "Inbound proxies" SECTproxyInbound
42380 .cindex proxy inbound
42381 .cindex proxy "server side"
42382 .cindex proxy "Proxy protocol"
42383 .cindex "Proxy protocol" proxy
42384
42385 Exim has support for receiving inbound SMTP connections via a proxy
42386 that uses &"Proxy Protocol"& to speak to it.
42387 To include this support, include &"SUPPORT_PROXY=yes"&
42388 in Local/Makefile.
42389
42390 It was built on the HAProxy specification, found at
42391 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42392
42393 The purpose of this facility is so that an application load balancer,
42394 such as HAProxy, can sit in front of several Exim servers
42395 to distribute load.
42396 Exim uses the local protocol communication with the proxy to obtain
42397 the remote SMTP system IP address and port information.
42398 There is no logging if a host passes or
42399 fails Proxy Protocol negotiation, but it can easily be determined and
42400 recorded in an ACL (example is below).
42401
42402 Use of a proxy is enabled by setting the &%hosts_proxy%&
42403 main configuration option to a hostlist; connections from these
42404 hosts will use Proxy Protocol.
42405 Exim supports both version 1 and version 2 of the Proxy Protocol and
42406 automatically determines which version is in use.
42407
42408 The Proxy Protocol header is the first data received on a TCP connection
42409 and is inserted before any TLS-on-connect handshake from the client; Exim
42410 negotiates TLS between Exim-as-server and the remote client, not between
42411 Exim and the proxy server. The Proxy Protocol header must be received
42412 within &%proxy_protocol_timeout%&, which defaults to 3s.
42413
42414 The following expansion variables are usable
42415 (&"internal"& and &"external"& here refer to the interfaces
42416 of the proxy):
42417 .itable none 0 0 2 30* left 70* left
42418 .irow $proxy_external_address   "IP of host being proxied or IP of remote interface of proxy"
42419 .irow $proxy_external_port      "Port of host being proxied or Port on remote interface of proxy"
42420 .irow $proxy_local_address      "IP of proxy server inbound or IP of local interface of proxy"
42421 .irow $proxy_local_port         "Port of proxy server inbound or Port on local interface of proxy"
42422 .irow $proxy_session            "boolean: SMTP connection via proxy"
42423 .endtable
42424 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42425 there was a protocol error.
42426 The variables &$sender_host_address$& and &$sender_host_port$&
42427 will have values for the actual client system, not the proxy.
42428
42429 Since the real connections are all coming from the proxy, and the
42430 per host connection tracking is done before Proxy Protocol is
42431 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42432 handle all of the parallel volume you expect per inbound proxy.
42433 With the option set so high, you lose the ability
42434 to protect your server from many connections from one IP.
42435 In order to prevent your server from overload, you
42436 need to add a per connection ratelimit to your connect ACL.
42437 A possible solution is:
42438 .display
42439   # Set max number of connections per host
42440   LIMIT   = 5
42441   # Or do some kind of IP lookup in a flat file or database
42442   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42443
42444   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42445           message        = Too many connections from this IP right now
42446 .endd
42447
42448
42449
42450 .section "Outbound proxies" SECTproxySOCKS
42451 .cindex proxy outbound
42452 .cindex proxy "client side"
42453 .cindex proxy SOCKS
42454 .cindex SOCKS proxy
42455 Exim has support for sending outbound SMTP via a proxy
42456 using a protocol called SOCKS5 (defined by RFC1928).
42457 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42458 Local/Makefile.
42459
42460 Use of a proxy is enabled by setting the &%socks_proxy%& option
42461 on an smtp transport.
42462 The option value is expanded and should then be a list
42463 (colon-separated by default) of proxy specifiers.
42464 Each proxy specifier is a list
42465 (space-separated by default) where the initial element
42466 is an IP address and any subsequent elements are options.
42467
42468 Options are a string <name>=<value>.
42469 The list of options is in the following table:
42470 .itable none 0 0 2 10* left 90* left
42471 .irow &'auth'&  "authentication method"
42472 .irow &'name'&  "authentication username"
42473 .irow &'pass'&  "authentication password"
42474 .irow &'port'&  "tcp port"
42475 .irow &'tmo'&   "connection timeout"
42476 .irow &'pri'&   "priority"
42477 .irow &'weight'& "selection bias"
42478 .endtable
42479
42480 More details on each of these options follows:
42481
42482 .ilist
42483 .cindex authentication "to proxy"
42484 .cindex proxy authentication
42485 &%auth%&: Either &"none"& (default) or &"name"&.
42486 Using &"name"& selects username/password authentication per RFC 1929
42487 for access to the proxy.
42488 Default is &"none"&.
42489 .next
42490 &%name%&: sets the username for the &"name"& authentication method.
42491 Default is empty.
42492 .next
42493 &%pass%&: sets the password for the &"name"& authentication method.
42494 Default is empty.
42495 .next
42496 &%port%&: the TCP port number to use for the connection to the proxy.
42497 Default is 1080.
42498 .next
42499 &%tmo%&: sets a connection timeout in seconds for this proxy.
42500 Default is 5.
42501 .next
42502 &%pri%&: specifies a priority for the proxy within the list,
42503 higher values being tried first.
42504 The default priority is 1.
42505 .next
42506 &%weight%&: specifies a selection bias.
42507 Within a priority set servers are queried in a random fashion,
42508 weighted by this value.
42509 The default value for selection bias is 1.
42510 .endlist
42511
42512 Proxies from the list are tried according to their priority
42513 and weight settings until one responds.  The timeout for the
42514 overall connection applies to the set of proxied attempts.
42515
42516 .section Logging SECTproxyLog
42517 To log the (local) IP of a proxy in the incoming or delivery logline,
42518 add &"+proxy"& to the &%log_selector%& option.
42519 This will add a component tagged with &"PRX="& to the line.
42520
42521 . ////////////////////////////////////////////////////////////////////////////
42522 . ////////////////////////////////////////////////////////////////////////////
42523
42524 .chapter "Internationalisation" "CHAPi18n" &&&
42525          "Internationalisation""
42526 .cindex internationalisation "email address"
42527 .cindex EAI
42528 .cindex i18n
42529 .cindex utf8 "mail name handling"
42530
42531 Exim has support for Internationalised mail names.
42532 To include this it must be built with SUPPORT_I18N and the libidn library.
42533 Standards supported are RFCs 2060, 5890, 6530 and 6533.
42534
42535 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
42536 instead of it) then IDNA2008 is supported; this adds an extra library
42537 requirement, upon libidn2.
42538
42539 .section "MTA operations" SECTi18nMTA
42540 .cindex SMTPUTF8 "ESMTP option"
42541 .cindex "ESMTP extensions" SMTPUTF8
42542 The main configuration option &%smtputf8_advertise_hosts%& specifies
42543 a host list.  If this matches the sending host and
42544 accept_8bitmime is true (the default) then the ESMTP option
42545 SMTPUTF8 will be advertised.
42546
42547 If the sender specifies the SMTPUTF8 option on a MAIL command
42548 international handling for the message is enabled and
42549 the expansion variable &$message_smtputf8$& will have value TRUE.
42550
42551 The option &%allow_utf8_domains%& is set to true for this
42552 message. All DNS lookups are converted to a-label form
42553 whatever the setting of &%allow_utf8_domains%&
42554 when Exim is built with SUPPORT_I18N.
42555
42556 Both localparts and domain are maintained as the original
42557 UTF-8 form internally; any comparison or regular-expression use will
42558 require appropriate care.  Filenames created, eg. by
42559 the appendfile transport, will have UTF-8 names.
42560
42561 HELO names sent by the smtp transport will have any UTF-8
42562 components expanded to a-label form,
42563 and any certificate name checks will be done using the a-label
42564 form of the name.
42565
42566 .cindex log protocol
42567 .cindex SMTPUTF8 logging
42568 .cindex i18n logging
42569 Log lines and Received-by: header lines will acquire a "utf8"
42570 prefix on the protocol element, eg. utf8esmtp.
42571
42572 The following expansion operators can be used:
42573 .code
42574 ${utf8_domain_to_alabel:str}
42575 ${utf8_domain_from_alabel:str}
42576 ${utf8_localpart_to_alabel:str}
42577 ${utf8_localpart_from_alabel:str}
42578 .endd
42579
42580 .cindex utf8 "address downconversion"
42581 .cindex i18n "utf8 address downconversion"
42582 The RCPT ACL
42583 may use the following modifier:
42584 .display
42585 control = utf8_downconvert
42586 control = utf8_downconvert/<value>
42587 .endd
42588 This sets a flag requiring that envelope addresses are converted to
42589 a-label form before smtp delivery.
42590 This is usually for use in a Message Submission Agent context,
42591 but could be used for any message.
42592
42593 If a value is appended it may be:
42594 .itable none 0 0 2 5* right 95* left
42595 .irow &`1`&     "mandatory downconversion"
42596 .irow &`0`&     "no downconversion"
42597 .irow &`-1`&    "if SMTPUTF8 not supported by destination host"
42598 .endtable
42599 If no value is given, 1 is used.
42600
42601 If mua_wrapper is set, the utf8_downconvert control
42602 is initially set to -1.
42603
42604 The smtp transport has an option &%utf8_downconvert%&.
42605 If set it must expand to one of the three values described above,
42606 or an empty string.
42607 If non-empty it overrides value previously set
42608 (due to mua_wrapper or by an ACL control).
42609
42610
42611 There is no explicit support for VRFY and EXPN.
42612 Configurations supporting these should inspect
42613 &$smtp_command_argument$& for an SMTPUTF8 argument.
42614
42615 There is no support for LMTP on Unix sockets.
42616 Using the "lmtp" protocol option on an smtp transport,
42617 for LMTP over TCP, should work as expected.
42618
42619 There is no support for DSN unitext handling,
42620 and no provision for converting logging from or to UTF-8.
42621
42622
42623
42624 .section "MDA operations" SECTi18nMDA
42625 To aid in constructing names suitable for IMAP folders
42626 the following expansion operator can be used:
42627 .code
42628 ${imapfolder {<string>} {<sep>} {<specials>}}
42629 .endd
42630
42631 The string is converted from the charset specified by
42632 the "headers charset" command (in a filter file)
42633 or &%headers_charset%& main configuration option (otherwise),
42634 to the
42635 modified UTF-7 encoding specified by RFC 2060,
42636 with the following exception: All occurrences of <sep>
42637 (which has to be a single character)
42638 are replaced with periods ("."), and all periods and slashes that are not
42639 <sep> and are not in the <specials> string are BASE64 encoded.
42640
42641 The third argument can be omitted, defaulting to an empty string.
42642 The second argument can be omitted, defaulting to "/".
42643
42644 This is the encoding used by Courier for Maildir names on disk, and followed
42645 by many other IMAP servers.
42646
42647 Examples:
42648 .display
42649 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
42650 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
42651 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
42652 .endd
42653
42654 Note that the source charset setting is vital, and also that characters
42655 must be representable in UTF-16.
42656
42657
42658 . ////////////////////////////////////////////////////////////////////////////
42659 . ////////////////////////////////////////////////////////////////////////////
42660
42661 .chapter "Events" "CHAPevents" &&&
42662          "Events"
42663 .cindex events
42664
42665 The events mechanism in Exim can be used to intercept processing at a number
42666 of points.  It was originally invented to give a way to do customised logging
42667 actions (for example, to a database) but can also be used to modify some
42668 processing actions.
42669
42670 Most installations will never need to use Events.
42671 The support can be left out of a build by defining DISABLE_EVENT=yes
42672 in &_Local/Makefile_&.
42673
42674 There are two major classes of events: main and transport.
42675 The main configuration option &%event_action%& controls reception events;
42676 a transport option &%event_action%& controls delivery events.
42677
42678 Both options are a string which is expanded when the event fires.
42679 An example might look like:
42680 .cindex logging custom
42681 .code
42682 event_action = ${if eq {msg:delivery}{$event_name} \
42683 {${lookup pgsql {SELECT * FROM record_Delivery( \
42684     '${quote_pgsql:$sender_address_domain}',\
42685     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42686     '${quote_pgsql:$domain}', \
42687     '${quote_pgsql:${lc:$local_part}}', \
42688     '${quote_pgsql:$host_address}', \
42689     '${quote_pgsql:${lc:$host}}', \
42690     '${quote_pgsql:$message_exim_id}')}} \
42691 } {}}
42692 .endd
42693
42694 Events have names which correspond to the point in process at which they fire.
42695 The name is placed in the variable &$event_name$& and the event action
42696 expansion must check this, as it will be called for every possible event type.
42697
42698 The current list of events is:
42699 .itable all 0 0 4 25* left 10* center 15* center 50* left
42700 .row auth:fail              after    both       "per driver per authentication attempt"
42701 .row dane:fail              after    transport  "per connection"
42702 .row msg:complete           after    main       "per message"
42703 .row msg:defer              after    transport  "per message per delivery try"
42704 .row msg:delivery           after    transport  "per recipient"
42705 .row msg:rcpt:host:defer    after    transport  "per recipient per host"
42706 .row msg:rcpt:defer         after    transport  "per recipient"
42707 .row msg:host:defer         after    transport  "per host per delivery try; host errors"
42708 .row msg:fail:delivery      after    transport  "per recipient"
42709 .row msg:fail:internal      after    main       "per recipient"
42710 .row tcp:connect            before   transport  "per connection"
42711 .row tcp:close              after    transport  "per connection"
42712 .row tls:cert               before   both       "per certificate in verification chain"
42713 .row tls:fail:connect       after    main       "per connection"
42714 .row smtp:connect           after    transport  "per connection"
42715 .row smtp:ehlo              after    transport  "per connection"
42716 .endtable
42717 New event types may be added in future.
42718
42719 The event name is a colon-separated list, defining the type of
42720 event in a tree of possibilities.  It may be used as a list
42721 or just matched on as a whole.  There will be no spaces in the name.
42722
42723 The second column in the table above describes whether the event fires
42724 before or after the action is associates with.  Those which fire before
42725 can be used to affect that action (more on this below).
42726
42727 The third column in the table above says what section of the configuration
42728 should define the event action.
42729
42730 An additional variable, &$event_data$&, is filled with information varying
42731 with the event type:
42732 .itable all 0 0 2 20* left 80* left
42733 .row auth:fail            "smtp response"
42734 .row dane:fail            "failure reason"
42735 .row msg:defer            "error string"
42736 .row msg:delivery         "smtp confirmation message"
42737 .row msg:fail:internal    "failure reason"
42738 .row msg:fail:delivery    "smtp error message"
42739 .row msg:host:defer       "error string"
42740 .row msg:rcpt:host:defer  "error string"
42741 .row msg:rcpt:defer       "error string"
42742 .row tls:cert             "verification chain depth"
42743 .row tls:fail:connect     "error string"
42744 .row smtp:connect         "smtp banner"
42745 .row smtp:ehlo            "smtp ehlo response"
42746 .endtable
42747
42748 The :defer events populate one extra variable: &$event_defer_errno$&.
42749
42750 For complex operations an ACL expansion can be used in &%event_action%&,
42751 however due to the multiple contexts that Exim operates in during
42752 the course of its processing:
42753 .ilist
42754 variables set in transport events will not be visible outside that
42755 transport call
42756 .next
42757 acl_m variables in a server context are lost on a new connection,
42758 and after smtp helo/ehlo/mail/starttls/rset commands
42759 .endlist
42760 Using an ACL expansion with the logwrite modifier can be
42761 a useful way of writing to the main log.
42762
42763 The expansion of the event_action option should normally
42764 return an empty string.  Should it return anything else the
42765 following will be forced:
42766 .itable all 0 0 2 20* left 80* left
42767 .row auth:fail        "log information to write"
42768 .row tcp:connect      "do not connect"
42769 .row tls:cert         "refuse verification"
42770 .row smtp:connect     "close connection"
42771 .endtable
42772 All other message types ignore the result string, and
42773 no other use is made of it.
42774
42775 For a tcp:connect event, if the connection is being made to a proxy
42776 then the address and port variables will be that of the proxy and not
42777 the target system.
42778
42779 For tls:cert events, if GnuTLS is in use this will trigger only per
42780 chain element received on the connection.
42781 For OpenSSL it will trigger for every chain element including those
42782 loaded locally.
42783
42784 . ////////////////////////////////////////////////////////////////////////////
42785 . ////////////////////////////////////////////////////////////////////////////
42786
42787 .chapter "Adding new drivers or lookup types" "CHID13" &&&
42788          "Adding drivers or lookups"
42789 .cindex "adding drivers"
42790 .cindex "new drivers, adding"
42791 .cindex "drivers" "adding new"
42792 The following actions have to be taken in order to add a new router, transport,
42793 authenticator, or lookup type to Exim:
42794
42795 .olist
42796 Choose a name for the driver or lookup type that does not conflict with any
42797 existing name; I will use &"newdriver"& in what follows.
42798 .next
42799 Add to &_src/EDITME_& the line:
42800 .display
42801 <&'type'&>&`_NEWDRIVER=yes`&
42802 .endd
42803 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
42804 code is not to be included in the binary by default, comment this line out. You
42805 should also add any relevant comments about the driver or lookup type.
42806 .next
42807 Add to &_src/config.h.defaults_& the line:
42808 .code
42809 #define <type>_NEWDRIVER
42810 .endd
42811 .next
42812 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
42813 and create a table entry as is done for all the other drivers and lookup types.
42814 .next
42815 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
42816 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
42817 Add your &`NEWDRIVER`& to that list.
42818 As long as the dynamic module would be named &_newdriver.so_&, you can use the
42819 simple form that most lookups have.
42820 .next
42821 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
42822 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
42823 driver or lookup type and add it to the definition of OBJ.
42824 .next
42825 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
42826 definition of OBJ_MACRO.  Add a set of line to do the compile also.
42827 .next
42828 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
42829 &_src_&.
42830 .next
42831 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
42832 as for other drivers and lookups.
42833 .endlist
42834
42835 Then all you need to do is write the code! A good way to start is to make a
42836 proforma by copying an existing module of the same type, globally changing all
42837 occurrences of the name, and cutting out most of the code. Note that any
42838 options you create must be listed in alphabetical order, because the tables are
42839 searched using a binary chop procedure.
42840
42841 There is a &_README_& file in each of the sub-directories of &_src_& describing
42842 the interface that is expected.
42843
42844
42845
42846
42847 . ////////////////////////////////////////////////////////////////////////////
42848 . ////////////////////////////////////////////////////////////////////////////
42849
42850 . /////////////////////////////////////////////////////////////////////////////
42851 . These lines are processing instructions for the Simple DocBook Processor that
42852 . Philip Hazel has developed as a less cumbersome way of making PostScript and
42853 . PDFs than using xmlto and fop. They will be ignored by all other XML
42854 . processors.
42855 . /////////////////////////////////////////////////////////////////////////////
42856
42857 .literal xml
42858 <?sdop
42859   format="newpage"
42860   foot_right_recto="&chaptertitle;"
42861   foot_right_verso="&chaptertitle;"
42862 ?>
42863 .literal off
42864
42865 .makeindex "Options index"   "option"
42866 .makeindex "Variables index" "variable"
42867 .makeindex "Concept index"   "concept"
42868
42869
42870 . /////////////////////////////////////////////////////////////////////////////
42871 . /////////////////////////////////////////////////////////////////////////////